com.amazonaws.services.inspector

Interface AmazonInspector

All Known Subinterfaces:

AmazonInspectorAsync

All Known Implementing Classes:

AbstractAmazonInspector, AbstractAmazonInspectorAsync, AmazonInspectorAsyncClient, AmazonInspectorClient

public interface AmazonInspector

Interface for accessing Amazon Inspector.

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

Methods

Modifier and Type	Method and Description
AddAttributesToFindingsResult	addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest) Assigns attributes (key and value pair) to the findings specified by the findings' ARNs.
CreateAssessmentTargetResult	createAssessmentTarget(CreateAssessmentTargetRequest createAssessmentTargetRequest) Creates a new assessment target using the resource group ARN generated by CreateResourceGroup.
CreateAssessmentTemplateResult	createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest) Creates an assessment template for the assessment target specified by the assessment target ARN.
CreateResourceGroupResult	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 Inspector assessment target.
void	deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest) Deletes the assessment run specified by the assessment run ARN.
void	deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest) Deletes the assessment target specified by the assessment target ARN.
void	deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest) Deletes the assessment template specified by the assessment template ARN.
DescribeAssessmentRunsResult	describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest) Describes the assessment run(s) specified by the assessment run ARN(s).
DescribeAssessmentTargetsResult	describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest) Describes the assessment target(s) specified by the assessment target ARN(s).
DescribeAssessmentTemplatesResult	describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest) Describes the assessment template(s) specified by the assessment template(s) ARN(s).
DescribeCrossAccountAccessRoleResult	describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest) Describes the IAM role that enables Inspector to access your AWS account.
DescribeFindingsResult	describeFindings(DescribeFindingsRequest describeFindingsRequest) Describes the finding(s) specified by the finding ARN(s).
DescribeResourceGroupsResult	describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest) Describes resource group(s) specified by the resource group ARN(s).
DescribeRulesPackagesResult	describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest) Describes the rules package(s) specified by the rules package ARN(s).
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.
GetTelemetryMetadataResult	getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest) Information about the data collected for the specified assessment run.
ListAssessmentRunAgentsResult	listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest) Lists the agents of the assessment run specified by the assessment run ARN.
ListAssessmentRunsResult	listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest) Lists the assessments run corresponding to assessment template(s) specified by the assessment template(s)' ARN(s).
ListAssessmentTargetsResult	listAssessmentTargets(ListAssessmentTargetsRequest listAssessmentTargetsRequest) Lists the ARN(s) of the assessment target(s) within this AWS account.
ListAssessmentTemplatesResult	listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest) Lists the assessment template(s) corresponding to the assessment target(s) specified by the assessment targets' ARN(s).
ListEventSubscriptionsResult	listEventSubscriptions(ListEventSubscriptionsRequest listEventSubscriptionsRequest) Lists all the event subscriptions for the assessment template specified by the assessment template ARN.
ListFindingsResult	listFindings(ListFindingsRequest listFindingsRequest) Lists findings generated by the assessment run(s) specified by the assessment run ARN(s).
ListRulesPackagesResult	listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest) Lists all available Inspector rules packages.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags associated with an assessment template.
PreviewAgentsResult	previewAgents(PreviewAgentsRequest previewAgentsRequest) Previews the agents installed on the EC2 instances that are part of the specified assessment target.
void	registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest) Registers the IAM role that Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.
RemoveAttributesFromFindingsResult	removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest) Removes entire attributes (key and value pairs) from the findings specified by the finding ARNs where an attribute with the specified key exists.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://inspector.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest) Sets tags (key and value pairs) to the assessment template specified by the assessment template ARN.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartAssessmentRunResult	startAssessmentRun(StartAssessmentRunRequest startAssessmentRunRequest) Starts the assessment run specified by the assessment template ARN.
void	stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest) Stops the assessment run specified by the assessment run ARN.
void	subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest) Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified topic.
void	unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest) Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified topic.
void	updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest) Updates the assessment target specified by the assessment target ARN.

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Overrides the default endpoint for this client ("https://inspector.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "inspector.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://inspector.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "inspector.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://inspector.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

void setRegion(Region region)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

addAttributesToFindings

AddAttributesToFindingsResult addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)

Assigns attributes (key and value pair) to the findings specified by the findings' ARNs.

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.

createAssessmentTarget

CreateAssessmentTargetResult createAssessmentTarget(CreateAssessmentTargetRequest createAssessmentTargetRequest)

Creates a new assessment target using the resource group ARN 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:

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.

createAssessmentTemplate

CreateAssessmentTemplateResult createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest)

Creates an assessment template for the assessment target specified by the assessment target ARN.

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.

createResourceGroup

CreateResourceGroupResult 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 Inspector assessment target. The created resource group is then used to create an Inspector assessment target.

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.

deleteAssessmentRun

void deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest)

Deletes the assessment run specified by the assessment run ARN.

Parameters:

deleteAssessmentRunRequest -

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.

deleteAssessmentTarget

void deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest)

Deletes the assessment target specified by the assessment target ARN.

Parameters:

deleteAssessmentTargetRequest -

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.

deleteAssessmentTemplate

void deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest)

Deletes the assessment template specified by the assessment template ARN.

Parameters:

deleteAssessmentTemplateRequest -

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.

describeAssessmentRuns

DescribeAssessmentRunsResult describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest)

Describes the assessment run(s) specified by the assessment run ARN(s).

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.

describeAssessmentTargets

DescribeAssessmentTargetsResult describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest)

Describes the assessment target(s) specified by the assessment target ARN(s).

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.

describeAssessmentTemplates

DescribeAssessmentTemplatesResult describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest)

Describes the assessment template(s) specified by the assessment template(s) ARN(s).

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.

describeCrossAccountAccessRole

DescribeCrossAccountAccessRoleResult describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)

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

Parameters:

describeCrossAccountAccessRoleRequest -

Returns:

Result of the DescribeCrossAccountAccessRole operation returned by the service.

Throws:

InternalException - Internal server error.

describeFindings

DescribeFindingsResult describeFindings(DescribeFindingsRequest describeFindingsRequest)

Describes the finding(s) specified by the finding ARN(s).

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.

describeResourceGroups

DescribeResourceGroupsResult describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest)

Describes resource group(s) specified by the resource group ARN(s).

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.

describeRulesPackages

DescribeRulesPackagesResult describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest)

Describes the rules package(s) specified by the rules package ARN(s).

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.

getTelemetryMetadata

GetTelemetryMetadataResult getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest)

Information about the data collected for the specified assessment run.

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.

listAssessmentRunAgents

ListAssessmentRunAgentsResult listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest)

Lists the agents of the assessment run specified by the assessment run ARN.

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.

listAssessmentRuns

ListAssessmentRunsResult listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest)

Lists the assessments run corresponding to assessment template(s) specified by the assessment template(s)' ARN(s).

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.

listAssessmentTargets

ListAssessmentTargetsResult listAssessmentTargets(ListAssessmentTargetsRequest listAssessmentTargetsRequest)

Lists the ARN(s) of the assessment target(s) within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.

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.

listAssessmentTemplates

ListAssessmentTemplatesResult listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest)

Lists the assessment template(s) corresponding to the assessment target(s) specified by the assessment targets' ARN(s).

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.

listEventSubscriptions

ListEventSubscriptionsResult listEventSubscriptions(ListEventSubscriptionsRequest listEventSubscriptionsRequest)

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

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.

listFindings

ListFindingsResult listFindings(ListFindingsRequest listFindingsRequest)

Lists findings generated by the assessment run(s) specified by the assessment run ARN(s).

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.

listRulesPackages

ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)

Lists all available Inspector rules packages.

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.

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags associated with an assessment template.

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.

previewAgents

PreviewAgentsResult previewAgents(PreviewAgentsRequest previewAgentsRequest)

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

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 - Inspector cannot assume the cross account role it needs to list your EC2 instances during the assessment run.

registerCrossAccountAccessRole

void registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest)

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

Parameters:

registerCrossAccountAccessRoleRequest -

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 - Inspector cannot assume the cross account role it needs to list your EC2 instances during the assessment run.

removeAttributesFromFindings

RemoveAttributesFromFindingsResult removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest)

Removes entire attributes (key and value pairs) from the findings specified by the finding ARNs where an attribute with the specified key exists.

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.

setTagsForResource

void setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)

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

Parameters:

setTagsForResourceRequest -

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.

startAssessmentRun

StartAssessmentRunResult startAssessmentRun(StartAssessmentRunRequest startAssessmentRunRequest)

Starts the assessment run specified by the assessment template ARN. 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:

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 - Inspector cannot assume the cross account role it needs to list your EC2 instances during the assessment run.

AgentsAlreadyRunningAssessmentException - You start an assessment run and one of the instances is already participating in another assessment run.

stopAssessmentRun

void stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest)

Stops the assessment run specified by the assessment run ARN.

Parameters:

stopAssessmentRunRequest -

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.

subscribeToEvent

void subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest)

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

Parameters:

subscribeToEventRequest -

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.

unsubscribeFromEvent

void unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest)

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

Parameters:

unsubscribeFromEventRequest -

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.

updateAssessmentTarget

void updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest)

Updates the assessment target specified by the assessment target ARN.

Parameters:

updateAssessmentTargetRequest -

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.

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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