Package software.amazon.awssdk.services.inspector

Interface InspectorAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface InspectorAsyncClient
extends AutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method. Amazon Inspector

Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AddAttributesToFindingsResponse>	addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)	Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
static InspectorAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a InspectorAsyncClient.
static InspectorAsyncClient	create()	Create a InspectorAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateAssessmentTargetResponse>	createAssessmentTarget(CreateAssessmentTargetRequest createAssessmentTargetRequest)	Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup.
default CompletableFuture<CreateAssessmentTemplateResponse>	createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest)	Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
default CompletableFuture<CreateResourceGroupResponse>	createResourceGroup(CreateResourceGroupRequest createResourceGroupRequest)	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.
default CompletableFuture<DeleteAssessmentRunResponse>	deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest)	Deletes the assessment run that is specified by the ARN of the assessment run.
default CompletableFuture<DeleteAssessmentTargetResponse>	deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest)	Deletes the assessment target that is specified by the ARN of the assessment target.
default CompletableFuture<DeleteAssessmentTemplateResponse>	deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest)	Deletes the assessment template that is specified by the ARN of the assessment template.
default CompletableFuture<DescribeAssessmentRunsResponse>	describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest)	Describes the assessment runs that are specified by the ARNs of the assessment runs.
default CompletableFuture<DescribeAssessmentTargetsResponse>	describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest)	Describes the assessment targets that are specified by the ARNs of the assessment targets.
default CompletableFuture<DescribeAssessmentTemplatesResponse>	describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest)	Describes the assessment templates that are specified by the ARNs of the assessment templates.
default CompletableFuture<DescribeCrossAccountAccessRoleResponse>	describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)	Describes the IAM role that enables Amazon Inspector to access your AWS account.
default CompletableFuture<DescribeFindingsResponse>	describeFindings(DescribeFindingsRequest describeFindingsRequest)	Describes the findings that are specified by the ARNs of the findings.
default CompletableFuture<DescribeResourceGroupsResponse>	describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest)	Describes the resource groups that are specified by the ARNs of the resource groups.
default CompletableFuture<DescribeRulesPackagesResponse>	describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest)	Describes the rules packages that are specified by the ARNs of the rules packages.
default CompletableFuture<GetAssessmentReportResponse>	getAssessmentReport(GetAssessmentReportRequest getAssessmentReportRequest)	Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
default CompletableFuture<GetTelemetryMetadataResponse>	getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest)	Information about the data that is collected for the specified assessment run.
default CompletableFuture<ListAssessmentRunAgentsResponse>	listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest)	Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
default CompletableFuture<ListAssessmentRunsResponse>	listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest)	Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
default CompletableFuture<ListAssessmentTargetsResponse>	listAssessmentTargets(ListAssessmentTargetsRequest listAssessmentTargetsRequest)	Lists the ARNs of the assessment targets within this AWS account.
default CompletableFuture<ListAssessmentTemplatesResponse>	listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest)	Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
default CompletableFuture<ListEventSubscriptionsResponse>	listEventSubscriptions(ListEventSubscriptionsRequest listEventSubscriptionsRequest)	Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template.
default CompletableFuture<ListFindingsResponse>	listFindings(ListFindingsRequest listFindingsRequest)	Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
default CompletableFuture<ListRulesPackagesResponse>	listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)	Lists all available Amazon Inspector rules packages.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags associated with an assessment template.
default CompletableFuture<PreviewAgentsResponse>	previewAgents(PreviewAgentsRequest previewAgentsRequest)	Previews the agents installed on the EC2 instances that are part of the specified assessment target.
default CompletableFuture<RegisterCrossAccountAccessRoleResponse>	registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest)	Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.
default CompletableFuture<RemoveAttributesFromFindingsResponse>	removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest)	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 exists.
default CompletableFuture<SetTagsForResourceResponse>	setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)	Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
default CompletableFuture<StartAssessmentRunResponse>	startAssessmentRun(StartAssessmentRunRequest startAssessmentRunRequest)	Starts the assessment run specified by the ARN of the assessment template.
default CompletableFuture<StopAssessmentRunResponse>	stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest)	Stops the assessment run that is specified by the ARN of the assessment run.
default CompletableFuture<SubscribeToEventResponse>	subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest)	Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
default CompletableFuture<UnsubscribeFromEventResponse>	unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest)	Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
default CompletableFuture<UpdateAssessmentTargetResponse>	updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest)	Updates the assessment target that is specified by the ARN of the assessment target.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static InspectorAsyncClient create()

Create a InspectorAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static InspectorAsyncClientBuilder builder()

Create a builder that can be used to configure and create a InspectorAsyncClient.

addAttributesToFindings

default CompletableFuture<AddAttributesToFindingsResponse> addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)

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

Parameters:

addAttributesToFindingsRequest -

Returns:

A Java Future containing the result of the AddAttributesToFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createAssessmentTarget

default CompletableFuture<CreateAssessmentTargetResponse> createAssessmentTarget(CreateAssessmentTargetRequest createAssessmentTargetRequest)

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. 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 Amazon Inspector Assessment Targets.

Parameters:

createAssessmentTargetRequest -

Returns:

A Java Future containing the result of the CreateAssessmentTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• LimitExceededException The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createAssessmentTemplate

default CompletableFuture<CreateAssessmentTemplateResponse> createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest)

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.

Parameters:

createAssessmentTemplateRequest -

Returns:

A Java Future containing the result of the CreateAssessmentTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• LimitExceededException The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createResourceGroup

default CompletableFuture<CreateResourceGroupResponse> createResourceGroup(CreateResourceGroupRequest createResourceGroupRequest)

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 CreateAssessmentTarget.

Parameters:

createResourceGroupRequest -

Returns:

A Java Future containing the result of the CreateResourceGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• LimitExceededException The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
• AccessDeniedException You do not have required permissions to access the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteAssessmentRun

default CompletableFuture<DeleteAssessmentRunResponse> deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest)

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

Parameters:

deleteAssessmentRunRequest -

Returns:

A Java Future containing the result of the DeleteAssessmentRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AssessmentRunInProgressException You cannot perform a specified action if an assessment run is currently in progress.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteAssessmentTarget

default CompletableFuture<DeleteAssessmentTargetResponse> deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest)

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

Parameters:

deleteAssessmentTargetRequest -

Returns:

A Java Future containing the result of the DeleteAssessmentTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AssessmentRunInProgressException You cannot perform a specified action if an assessment run is currently in progress.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteAssessmentTemplate

default CompletableFuture<DeleteAssessmentTemplateResponse> deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest)

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

Parameters:

deleteAssessmentTemplateRequest -

Returns:

A Java Future containing the result of the DeleteAssessmentTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AssessmentRunInProgressException You cannot perform a specified action if an assessment run is currently in progress.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeAssessmentRuns

default CompletableFuture<DescribeAssessmentRunsResponse> describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest)

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

Parameters:

describeAssessmentRunsRequest -

Returns:

A Java Future containing the result of the DescribeAssessmentRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeAssessmentTargets

default CompletableFuture<DescribeAssessmentTargetsResponse> describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest)

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

Parameters:

describeAssessmentTargetsRequest -

Returns:

A Java Future containing the result of the DescribeAssessmentTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeAssessmentTemplates

default CompletableFuture<DescribeAssessmentTemplatesResponse> describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest)

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

Parameters:

describeAssessmentTemplatesRequest -

Returns:

A Java Future containing the result of the DescribeAssessmentTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeCrossAccountAccessRole

default CompletableFuture<DescribeCrossAccountAccessRoleResponse> describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)

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

Parameters:

describeCrossAccountAccessRoleRequest -

Returns:

A Java Future containing the result of the DescribeCrossAccountAccessRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeFindings

default CompletableFuture<DescribeFindingsResponse> describeFindings(DescribeFindingsRequest describeFindingsRequest)

Describes the findings that are specified by the ARNs of the findings.

Parameters:

describeFindingsRequest -

Returns:

A Java Future containing the result of the DescribeFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeResourceGroups

default CompletableFuture<DescribeResourceGroupsResponse> describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest)

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

Parameters:

describeResourceGroupsRequest -

Returns:

A Java Future containing the result of the DescribeResourceGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeRulesPackages

default CompletableFuture<DescribeRulesPackagesResponse> describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest)

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

Parameters:

describeRulesPackagesRequest -

Returns:

A Java Future containing the result of the DescribeRulesPackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getAssessmentReport

default CompletableFuture<GetAssessmentReportResponse> getAssessmentReport(GetAssessmentReportRequest getAssessmentReportRequest)

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

Parameters:

getAssessmentReportRequest -

Returns:

A Java Future containing the result of the GetAssessmentReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• AssessmentRunInProgressException You cannot perform a specified action if an assessment run is currently in progress.
• UnsupportedFeatureException Used by the GetAssessmentReport API. The request was rejected because you tried to generate a report for an assessment run that existed before reporting was supported in Amazon Inspector. You can only generate reports for assessment runs that took place or will take place after generating reports in Amazon Inspector became available.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getTelemetryMetadata

default CompletableFuture<GetTelemetryMetadataResponse> getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest)

Information about the data that is collected for the specified assessment run.

Parameters:

getTelemetryMetadataRequest -

Returns:

A Java Future containing the result of the GetTelemetryMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listAssessmentRunAgents

default CompletableFuture<ListAssessmentRunAgentsResponse> listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest)

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

Parameters:

listAssessmentRunAgentsRequest -

Returns:

A Java Future containing the result of the ListAssessmentRunAgents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listAssessmentRuns

default CompletableFuture<ListAssessmentRunsResponse> listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest)

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

Parameters:

listAssessmentRunsRequest -

Returns:

A Java Future containing the result of the ListAssessmentRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listAssessmentTargets

default CompletableFuture<ListAssessmentTargetsResponse> listAssessmentTargets(ListAssessmentTargetsRequest listAssessmentTargetsRequest)

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.

Parameters:

listAssessmentTargetsRequest -

Returns:

A Java Future containing the result of the ListAssessmentTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listAssessmentTemplates

default CompletableFuture<ListAssessmentTemplatesResponse> listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest)

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

Parameters:

listAssessmentTemplatesRequest -

Returns:

A Java Future containing the result of the ListAssessmentTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listEventSubscriptions

default CompletableFuture<ListEventSubscriptionsResponse> listEventSubscriptions(ListEventSubscriptionsRequest listEventSubscriptionsRequest)

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

Parameters:

listEventSubscriptionsRequest -

Returns:

A Java Future containing the result of the ListEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listFindings

default CompletableFuture<ListFindingsResponse> listFindings(ListFindingsRequest listFindingsRequest)

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

Parameters:

listFindingsRequest -

Returns:

A Java Future containing the result of the ListFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listRulesPackages

default CompletableFuture<ListRulesPackagesResponse> listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)

Lists all available Amazon Inspector rules packages.

Parameters:

listRulesPackagesRequest -

Returns:

A Java Future containing the result of the ListRulesPackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listTagsForResource

default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags associated with an assessment template.

Parameters:

listTagsForResourceRequest -

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

previewAgents

default CompletableFuture<PreviewAgentsResponse> previewAgents(PreviewAgentsRequest previewAgentsRequest)

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

Parameters:

previewAgentsRequest -

Returns:

A Java Future containing the result of the PreviewAgents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• InvalidCrossAccountRoleException Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

registerCrossAccountAccessRole

default CompletableFuture<RegisterCrossAccountAccessRoleResponse> registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest)

Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.

Parameters:

registerCrossAccountAccessRoleRequest -

Returns:

A Java Future containing the result of the RegisterCrossAccountAccessRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• InvalidCrossAccountRoleException Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

removeAttributesFromFindings

default CompletableFuture<RemoveAttributesFromFindingsResponse> removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest)

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 exists.

Parameters:

removeAttributesFromFindingsRequest -

Returns:

A Java Future containing the result of the RemoveAttributesFromFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

setTagsForResource

default CompletableFuture<SetTagsForResourceResponse> setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)

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

Parameters:

setTagsForResourceRequest -

Returns:

A Java Future containing the result of the SetTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

startAssessmentRun

default CompletableFuture<StartAssessmentRunResponse> startAssessmentRun(StartAssessmentRunRequest startAssessmentRunRequest)

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 account.

Parameters:

startAssessmentRunRequest -

Returns:

A Java Future containing the result of the StartAssessmentRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• LimitExceededException The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• InvalidCrossAccountRoleException Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.
• AgentsAlreadyRunningAssessmentException You started an assessment run, but one of the instances is already participating in another assessment run.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

stopAssessmentRun

default CompletableFuture<StopAssessmentRunResponse> stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest)

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

Parameters:

stopAssessmentRunRequest -

Returns:

A Java Future containing the result of the StopAssessmentRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

subscribeToEvent

default CompletableFuture<SubscribeToEventResponse> subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest)

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

Parameters:

subscribeToEventRequest -

Returns:

A Java Future containing the result of the SubscribeToEvent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• LimitExceededException The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

unsubscribeFromEvent

default CompletableFuture<UnsubscribeFromEventResponse> unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest)

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

Parameters:

unsubscribeFromEventRequest -

Returns:

A Java Future containing the result of the UnsubscribeFromEvent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateAssessmentTarget

default CompletableFuture<UpdateAssessmentTargetResponse> updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest)

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

Parameters:

updateAssessmentTargetRequest -

Returns:

A Java Future containing the result of the UpdateAssessmentTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalException Internal server error.
• InvalidInputException The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
• AccessDeniedException You do not have required permissions to access the requested resource.
• NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• InspectorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation