com.amazonaws.services.inspector

Class AmazonInspectorClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.inspector.AmazonInspectorClient

All Implemented Interfaces:

AmazonInspector

Direct Known Subclasses:

AmazonInspectorAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonInspectorClient
extends AmazonWebServiceClient
implements AmazonInspector

Client for accessing Amazon Inspector. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.inspector.AmazonInspector

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonInspectorClient() Deprecated. use AmazonInspectorClientBuilder.defaultClient()
AmazonInspectorClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonInspectorClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonInspectorClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonInspectorClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AddAttributesToFindingsResult	addAttributesToFindings(AddAttributesToFindingsRequest request) Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
static AmazonInspectorClientBuilder	builder()
CreateAssessmentTargetResult	createAssessmentTarget(CreateAssessmentTargetRequest request) Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup.
CreateAssessmentTemplateResult	createAssessmentTemplate(CreateAssessmentTemplateRequest request) Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
CreateExclusionsPreviewResult	createExclusionsPreview(CreateExclusionsPreviewRequest request) Starts the generation of an exclusions preview for the specified assessment template.
CreateResourceGroupResult	createResourceGroup(CreateResourceGroupRequest request) 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.
DeleteAssessmentRunResult	deleteAssessmentRun(DeleteAssessmentRunRequest request) Deletes the assessment run that is specified by the ARN of the assessment run.
DeleteAssessmentTargetResult	deleteAssessmentTarget(DeleteAssessmentTargetRequest request) Deletes the assessment target that is specified by the ARN of the assessment target.
DeleteAssessmentTemplateResult	deleteAssessmentTemplate(DeleteAssessmentTemplateRequest request) Deletes the assessment template that is specified by the ARN of the assessment template.
DescribeAssessmentRunsResult	describeAssessmentRuns(DescribeAssessmentRunsRequest request) Describes the assessment runs that are specified by the ARNs of the assessment runs.
DescribeAssessmentTargetsResult	describeAssessmentTargets(DescribeAssessmentTargetsRequest request) Describes the assessment targets that are specified by the ARNs of the assessment targets.
DescribeAssessmentTemplatesResult	describeAssessmentTemplates(DescribeAssessmentTemplatesRequest request) Describes the assessment templates that are specified by the ARNs of the assessment templates.
DescribeCrossAccountAccessRoleResult	describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest request) Describes the IAM role that enables Amazon Inspector to access your AWS account.
DescribeExclusionsResult	describeExclusions(DescribeExclusionsRequest request) Describes the exclusions that are specified by the exclusions' ARNs.
DescribeFindingsResult	describeFindings(DescribeFindingsRequest request) Describes the findings that are specified by the ARNs of the findings.
DescribeResourceGroupsResult	describeResourceGroups(DescribeResourceGroupsRequest request) Describes the resource groups that are specified by the ARNs of the resource groups.
DescribeRulesPackagesResult	describeRulesPackages(DescribeRulesPackagesRequest request) Describes the rules packages that are specified by the ARNs of the rules packages.
GetAssessmentReportResult	getAssessmentReport(GetAssessmentReportRequest request) Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetExclusionsPreviewResult	getExclusionsPreview(GetExclusionsPreviewRequest request) Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token.
GetTelemetryMetadataResult	getTelemetryMetadata(GetTelemetryMetadataRequest request) Information about the data that is collected for the specified assessment run.
ListAssessmentRunAgentsResult	listAssessmentRunAgents(ListAssessmentRunAgentsRequest request) Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
ListAssessmentRunsResult	listAssessmentRuns(ListAssessmentRunsRequest request) Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
ListAssessmentTargetsResult	listAssessmentTargets(ListAssessmentTargetsRequest request) Lists the ARNs of the assessment targets within this AWS account.
ListAssessmentTemplatesResult	listAssessmentTemplates(ListAssessmentTemplatesRequest request) Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
ListEventSubscriptionsResult	listEventSubscriptions(ListEventSubscriptionsRequest request) Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template.
ListExclusionsResult	listExclusions(ListExclusionsRequest request) List exclusions that are generated by the assessment run.
ListFindingsResult	listFindings(ListFindingsRequest request) Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
ListRulesPackagesResult	listRulesPackages(ListRulesPackagesRequest request) Lists all available Amazon Inspector rules packages.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags associated with an assessment template.
PreviewAgentsResult	previewAgents(PreviewAgentsRequest request) Previews the agents installed on the EC2 instances that are part of the specified assessment target.
RegisterCrossAccountAccessRoleResult	registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest request) Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
RemoveAttributesFromFindingsResult	removeAttributesFromFindings(RemoveAttributesFromFindingsRequest request) 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.
SetTagsForResourceResult	setTagsForResource(SetTagsForResourceRequest request) Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartAssessmentRunResult	startAssessmentRun(StartAssessmentRunRequest request) Starts the assessment run specified by the ARN of the assessment template.
StopAssessmentRunResult	stopAssessmentRun(StopAssessmentRunRequest request) Stops the assessment run that is specified by the ARN of the assessment run.
SubscribeToEventResult	subscribeToEvent(SubscribeToEventRequest request) Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
UnsubscribeFromEventResult	unsubscribeFromEvent(UnsubscribeFromEventRequest request) Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
UpdateAssessmentTargetResult	updateAssessmentTarget(UpdateAssessmentTargetRequest request) Updates the assessment target that is specified by the ARN of the assessment target.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.inspector.AmazonInspector

setEndpoint, setRegion

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

AmazonInspectorClient

@Deprecated
public AmazonInspectorClient()

Deprecated. use AmazonInspectorClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Amazon Inspector. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonInspectorClient

@Deprecated
public AmazonInspectorClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon Inspector. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonInspectorClient

@Deprecated
public AmazonInspectorClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonInspectorClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonInspectorClient

@Deprecated
public AmazonInspectorClient(AWSCredentials awsCredentials,
                                         ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy settings, retry counts, etc.).

AmazonInspectorClient

@Deprecated
public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonInspectorClient

@Deprecated
public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider,
                                         ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy settings, retry counts, etc.).

AmazonInspectorClient

@Deprecated
public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider,
                                         ClientConfiguration clientConfiguration,
                                         RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonInspectorClientBuilder builder()

addAttributesToFindings

public AddAttributesToFindingsResult addAttributesToFindings(AddAttributesToFindingsRequest request)

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

Specified by:

addAttributesToFindings in interface AmazonInspector

Parameters:

addAttributesToFindingsRequest -

Returns:

Result of the AddAttributesToFindings operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

createAssessmentTarget

public CreateAssessmentTargetResult createAssessmentTarget(CreateAssessmentTargetRequest request)

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action 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 Amazon Inspector Assessment Targets.

Specified by:

createAssessmentTarget in interface AmazonInspector

Parameters:

createAssessmentTargetRequest -

Returns:

Result of the CreateAssessmentTarget operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

createAssessmentTemplate

public CreateAssessmentTemplateResult createAssessmentTemplate(CreateAssessmentTemplateRequest request)

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.

Specified by:

createAssessmentTemplate in interface AmazonInspector

Parameters:

createAssessmentTemplateRequest -

Returns:

Result of the CreateAssessmentTemplate operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

createExclusionsPreview

public CreateExclusionsPreviewResult createExclusionsPreview(CreateExclusionsPreviewRequest request)

Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.

Specified by:

createExclusionsPreview in interface AmazonInspector

Parameters:

createExclusionsPreviewRequest -

Returns:

Result of the CreateExclusionsPreview operation returned by the service.

Throws:

InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

PreviewGenerationInProgressException - The request is rejected. The specified assessment template is currently generating an exclusions preview.

InternalException - Internal server error.

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

createResourceGroup

public CreateResourceGroupResult createResourceGroup(CreateResourceGroupRequest request)

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.

Specified by:

createResourceGroup in interface AmazonInspector

Parameters:

createResourceGroupRequest -

Returns:

Result of the CreateResourceGroup operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

deleteAssessmentRun

public DeleteAssessmentRunResult deleteAssessmentRun(DeleteAssessmentRunRequest request)

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

Specified by:

deleteAssessmentRun in interface AmazonInspector

Parameters:

deleteAssessmentRunRequest -

Returns:

Result of the DeleteAssessmentRun operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

deleteAssessmentTarget

public DeleteAssessmentTargetResult deleteAssessmentTarget(DeleteAssessmentTargetRequest request)

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

Specified by:

deleteAssessmentTarget in interface AmazonInspector

Parameters:

deleteAssessmentTargetRequest -

Returns:

Result of the DeleteAssessmentTarget operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

deleteAssessmentTemplate

public DeleteAssessmentTemplateResult deleteAssessmentTemplate(DeleteAssessmentTemplateRequest request)

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

Specified by:

deleteAssessmentTemplate in interface AmazonInspector

Parameters:

deleteAssessmentTemplateRequest -

Returns:

Result of the DeleteAssessmentTemplate operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

describeAssessmentRuns

public DescribeAssessmentRunsResult describeAssessmentRuns(DescribeAssessmentRunsRequest request)

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

Specified by:

describeAssessmentRuns in interface AmazonInspector

Parameters:

describeAssessmentRunsRequest -

Returns:

Result of the DescribeAssessmentRuns operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

describeAssessmentTargets

public DescribeAssessmentTargetsResult describeAssessmentTargets(DescribeAssessmentTargetsRequest request)

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

Specified by:

describeAssessmentTargets in interface AmazonInspector

Parameters:

describeAssessmentTargetsRequest -

Returns:

Result of the DescribeAssessmentTargets operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

describeAssessmentTemplates

public DescribeAssessmentTemplatesResult describeAssessmentTemplates(DescribeAssessmentTemplatesRequest request)

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

Specified by:

describeAssessmentTemplates in interface AmazonInspector

Parameters:

describeAssessmentTemplatesRequest -

Returns:

Result of the DescribeAssessmentTemplates operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

describeCrossAccountAccessRole

public DescribeCrossAccountAccessRoleResult describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest request)

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

Specified by:

describeCrossAccountAccessRole in interface AmazonInspector

Parameters:

describeCrossAccountAccessRoleRequest -

Returns:

Result of the DescribeCrossAccountAccessRole operation returned by the service.

Throws:

InternalException - Internal server error.

See Also:

AWS API Documentation

describeExclusions

public DescribeExclusionsResult describeExclusions(DescribeExclusionsRequest request)

Describes the exclusions that are specified by the exclusions' ARNs.

Specified by:

describeExclusions in interface AmazonInspector

Parameters:

describeExclusionsRequest -

Returns:

Result of the DescribeExclusions operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

describeFindings

public DescribeFindingsResult describeFindings(DescribeFindingsRequest request)

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

Specified by:

describeFindings in interface AmazonInspector

Parameters:

describeFindingsRequest -

Returns:

Result of the DescribeFindings operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

describeResourceGroups

public DescribeResourceGroupsResult describeResourceGroups(DescribeResourceGroupsRequest request)

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

Specified by:

describeResourceGroups in interface AmazonInspector

Parameters:

describeResourceGroupsRequest -

Returns:

Result of the DescribeResourceGroups operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

describeRulesPackages

public DescribeRulesPackagesResult describeRulesPackages(DescribeRulesPackagesRequest request)

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

Specified by:

describeRulesPackages in interface AmazonInspector

Parameters:

describeRulesPackagesRequest -

Returns:

Result of the DescribeRulesPackages operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

getAssessmentReport

public GetAssessmentReportResult getAssessmentReport(GetAssessmentReportRequest request)

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

Specified by:

getAssessmentReport in interface AmazonInspector

Parameters:

getAssessmentReportRequest -

Returns:

Result of the GetAssessmentReport operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

getExclusionsPreview

public GetExclusionsPreviewResult getExclusionsPreview(GetExclusionsPreviewRequest request)

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.

Specified by:

getExclusionsPreview in interface AmazonInspector

Parameters:

getExclusionsPreviewRequest -

Returns:

Result of the GetExclusionsPreview operation returned by the service.

Throws:

InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

InternalException - Internal server error.

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.

See Also:

AWS API Documentation

getTelemetryMetadata

public GetTelemetryMetadataResult getTelemetryMetadata(GetTelemetryMetadataRequest request)

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

Specified by:

getTelemetryMetadata in interface AmazonInspector

Parameters:

getTelemetryMetadataRequest -

Returns:

Result of the GetTelemetryMetadata operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAssessmentRunAgents

public ListAssessmentRunAgentsResult listAssessmentRunAgents(ListAssessmentRunAgentsRequest request)

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

Specified by:

listAssessmentRunAgents in interface AmazonInspector

Parameters:

listAssessmentRunAgentsRequest -

Returns:

Result of the ListAssessmentRunAgents operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAssessmentRuns

public ListAssessmentRunsResult listAssessmentRuns(ListAssessmentRunsRequest request)

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

Specified by:

listAssessmentRuns in interface AmazonInspector

Parameters:

listAssessmentRunsRequest -

Returns:

Result of the ListAssessmentRuns operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAssessmentTargets

public ListAssessmentTargetsResult listAssessmentTargets(ListAssessmentTargetsRequest request)

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

Specified by:

listAssessmentTargets in interface AmazonInspector

Parameters:

listAssessmentTargetsRequest -

Returns:

Result of the ListAssessmentTargets operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAssessmentTemplates

public ListAssessmentTemplatesResult listAssessmentTemplates(ListAssessmentTemplatesRequest request)

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

Specified by:

listAssessmentTemplates in interface AmazonInspector

Parameters:

listAssessmentTemplatesRequest -

Returns:

Result of the ListAssessmentTemplates operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listEventSubscriptions

public ListEventSubscriptionsResult listEventSubscriptions(ListEventSubscriptionsRequest request)

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.

Specified by:

listEventSubscriptions in interface AmazonInspector

Parameters:

listEventSubscriptionsRequest -

Returns:

Result of the ListEventSubscriptions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listExclusions

public ListExclusionsResult listExclusions(ListExclusionsRequest request)

List exclusions that are generated by the assessment run.

Specified by:

listExclusions in interface AmazonInspector

Parameters:

listExclusionsRequest -

Returns:

Result of the ListExclusions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listFindings

public ListFindingsResult listFindings(ListFindingsRequest request)

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

Specified by:

listFindings in interface AmazonInspector

Parameters:

listFindingsRequest -

Returns:

Result of the ListFindings operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listRulesPackages

public ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest request)

Lists all available Amazon Inspector rules packages.

Specified by:

listRulesPackages in interface AmazonInspector

Parameters:

listRulesPackagesRequest -

Returns:

Result of the ListRulesPackages operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists all tags associated with an assessment template.

Specified by:

listTagsForResource in interface AmazonInspector

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

previewAgents

public PreviewAgentsResult previewAgents(PreviewAgentsRequest request)

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

Specified by:

previewAgents in interface AmazonInspector

Parameters:

previewAgentsRequest -

Returns:

Result of the PreviewAgents operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

registerCrossAccountAccessRole

public RegisterCrossAccountAccessRoleResult registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest request)

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

Specified by:

registerCrossAccountAccessRole in interface AmazonInspector

Parameters:

registerCrossAccountAccessRoleRequest -

Returns:

Result of the RegisterCrossAccountAccessRole operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

removeAttributesFromFindings

public RemoveAttributesFromFindingsResult removeAttributesFromFindings(RemoveAttributesFromFindingsRequest request)

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.

Specified by:

removeAttributesFromFindings in interface AmazonInspector

Parameters:

removeAttributesFromFindingsRequest -

Returns:

Result of the RemoveAttributesFromFindings operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

setTagsForResource

public SetTagsForResourceResult setTagsForResource(SetTagsForResourceRequest request)

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

Specified by:

setTagsForResource in interface AmazonInspector

Parameters:

setTagsForResourceRequest -

Returns:

Result of the SetTagsForResource operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

startAssessmentRun

public StartAssessmentRunResult startAssessmentRun(StartAssessmentRunRequest request)

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.

Specified by:

startAssessmentRun in interface AmazonInspector

Parameters:

startAssessmentRunRequest -

Returns:

Result of the StartAssessmentRun operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

stopAssessmentRun

public StopAssessmentRunResult stopAssessmentRun(StopAssessmentRunRequest request)

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

Specified by:

stopAssessmentRun in interface AmazonInspector

Parameters:

stopAssessmentRunRequest -

Returns:

Result of the StopAssessmentRun operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

subscribeToEvent

public SubscribeToEventResult subscribeToEvent(SubscribeToEventRequest request)

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

Specified by:

subscribeToEvent in interface AmazonInspector

Parameters:

subscribeToEventRequest -

Returns:

Result of the SubscribeToEvent operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

unsubscribeFromEvent

public UnsubscribeFromEventResult unsubscribeFromEvent(UnsubscribeFromEventRequest request)

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

Specified by:

unsubscribeFromEvent in interface AmazonInspector

Parameters:

unsubscribeFromEventRequest -

Returns:

Result of the UnsubscribeFromEvent operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

updateAssessmentTarget

public UpdateAssessmentTargetResult updateAssessmentTarget(UpdateAssessmentTargetRequest request)

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

If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

Specified by:

updateAssessmentTarget in interface AmazonInspector

Parameters:

updateAssessmentTargetRequest -

Returns:

Result of the UpdateAssessmentTarget operation returned by the service.

Throws:

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.

ServiceTemporarilyUnavailableException - The serice is temporary unavailable.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonInspector

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AmazonInspector

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonInspector

Overrides:

shutdown in class AmazonWebServiceClient