InspectorClient Class

Member Function Documentation

InspectorClient::InspectorClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a InspectorClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

InspectorClient::InspectorClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads InspectorClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddAttributesToFindingsResponse *InspectorClient::addAttributesToFindings(const AddAttributesToFindingsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an AddAttributesToFindingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the

[slot] CreateAssessmentTargetResponse *InspectorClient::createAssessmentTarget(const CreateAssessmentTargetRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an CreateAssessmentTargetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new assessment target using the ARN of the resource group that is generated by <a>CreateResourceGroup</a>. If the <a href="https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html">service-linked role</a> isn’t already registered, also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see <a href="http://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html"> Amazon Inspector Assessment

[slot] CreateAssessmentTemplateResponse *InspectorClient::createAssessmentTemplate(const CreateAssessmentTemplateRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an CreateAssessmentTemplateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the <a href="https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html">service-linked role</a> isn’t already registered, also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security

[slot] CreateResourceGroupResponse *InspectorClient::createResourceGroup(const CreateResourceGroupRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an CreateResourceGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see

[slot] DeleteAssessmentRunResponse *InspectorClient::deleteAssessmentRun(const DeleteAssessmentRunRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an DeleteAssessmentRunResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the assessment run that is specified by the ARN of the assessment

[slot] DeleteAssessmentTargetResponse *InspectorClient::deleteAssessmentTarget(const DeleteAssessmentTargetRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an DeleteAssessmentTargetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the assessment target that is specified by the ARN of the assessment

[slot] DeleteAssessmentTemplateResponse *InspectorClient::deleteAssessmentTemplate(const DeleteAssessmentTemplateRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an DeleteAssessmentTemplateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the assessment template that is specified by the ARN of the assessment

[slot] DescribeAssessmentRunsResponse *InspectorClient::describeAssessmentRuns(const DescribeAssessmentRunsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an DescribeAssessmentRunsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the assessment runs that are specified by the ARNs of the assessment

[slot] DescribeAssessmentTargetsResponse *InspectorClient::describeAssessmentTargets(const DescribeAssessmentTargetsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an DescribeAssessmentTargetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the assessment targets that are specified by the ARNs of the assessment

[slot] DescribeAssessmentTemplatesResponse *InspectorClient::describeAssessmentTemplates(const DescribeAssessmentTemplatesRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an DescribeAssessmentTemplatesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the assessment templates that are specified by the ARNs of the assessment

[slot] DescribeCrossAccountAccessRoleResponse *InspectorClient::describeCrossAccountAccessRole()

Sends a DescribeCrossAccountAccessRole request to the InspectorClient service, and returns a pointer to an DescribeCrossAccountAccessRoleResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the IAM role that enables Amazon Inspector to access your AWS

[slot] DescribeFindingsResponse *InspectorClient::describeFindings(const DescribeFindingsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an DescribeFindingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the findings that are specified by the ARNs of the

[slot] DescribeResourceGroupsResponse *InspectorClient::describeResourceGroups(const DescribeResourceGroupsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an DescribeResourceGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the resource groups that are specified by the ARNs of the resource

[slot] DescribeRulesPackagesResponse *InspectorClient::describeRulesPackages(const DescribeRulesPackagesRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an DescribeRulesPackagesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the rules packages that are specified by the ARNs of the rules

[slot] GetAssessmentReportResponse *InspectorClient::getAssessmentReport(const GetAssessmentReportRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an GetAssessmentReportResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.

[slot] GetTelemetryMetadataResponse *InspectorClient::getTelemetryMetadata(const GetTelemetryMetadataRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an GetTelemetryMetadataResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Information about the data that is collected for the specified assessment

[slot] ListAssessmentRunAgentsResponse *InspectorClient::listAssessmentRunAgents(const ListAssessmentRunAgentsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an ListAssessmentRunAgentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the agents of the assessment runs that are specified by the ARNs of the assessment

[slot] ListAssessmentRunsResponse *InspectorClient::listAssessmentRuns(const ListAssessmentRunsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an ListAssessmentRunsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment

[slot] ListAssessmentTargetsResponse *InspectorClient::listAssessmentTargets(const ListAssessmentTargetsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an ListAssessmentTargetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see <a href="http://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html">Amazon Inspector Assessment

[slot] ListAssessmentTemplatesResponse *InspectorClient::listAssessmentTemplates(const ListAssessmentTemplatesRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an ListAssessmentTemplatesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment

[slot] ListEventSubscriptionsResponse *InspectorClient::listEventSubscriptions(const ListEventSubscriptionsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an ListEventSubscriptionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see <a>SubscribeToEvent</a> and

[slot] ListFindingsResponse *InspectorClient::listFindings(const ListFindingsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an ListFindingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment

[slot] ListRulesPackagesResponse *InspectorClient::listRulesPackages(const ListRulesPackagesRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an ListRulesPackagesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all available Amazon Inspector rules

[slot] ListTagsForResourceResponse *InspectorClient::listTagsForResource(const ListTagsForResourceRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an ListTagsForResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all tags associated with an assessment

[slot] PreviewAgentsResponse *InspectorClient::previewAgents(const PreviewAgentsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an PreviewAgentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Previews the agents installed on the EC2 instances that are part of the specified assessment

[slot] RegisterCrossAccountAccessRoleResponse *InspectorClient::registerCrossAccountAccessRole(const RegisterCrossAccountAccessRoleRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an RegisterCrossAccountAccessRoleResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security

[slot] RemoveAttributesFromFindingsResponse *InspectorClient::removeAttributesFromFindings(const RemoveAttributesFromFindingsRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an RemoveAttributesFromFindingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key

[slot] SetTagsForResourceResponse *InspectorClient::setTagsForResource(const SetTagsForResourceRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an SetTagsForResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment

[slot] StartAssessmentRunResponse *InspectorClient::startAssessmentRun(const StartAssessmentRunRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an StartAssessmentRunResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS

[slot] StopAssessmentRunResponse *InspectorClient::stopAssessmentRun(const StopAssessmentRunRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an StopAssessmentRunResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops the assessment run that is specified by the ARN of the assessment

[slot] SubscribeToEventResponse *InspectorClient::subscribeToEvent(const SubscribeToEventRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an SubscribeToEventResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS

[slot] UnsubscribeFromEventResponse *InspectorClient::unsubscribeFromEvent(const UnsubscribeFromEventRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an UnsubscribeFromEventResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS

[slot] UpdateAssessmentTargetResponse *InspectorClient::updateAssessmentTarget(const UpdateAssessmentTargetRequest &request)

Sends request to the InspectorClient service, and returns a pointer to an UpdateAssessmentTargetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the assessment target that is specified by the ARN of the assessment