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 the applications you run in AWS 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.
AttachAssessmentAndRulesPackageResult	attachAssessmentAndRulesPackage(AttachAssessmentAndRulesPackageRequest attachAssessmentAndRulesPackageRequest) Attaches the rules package specified by the rules package ARN to the assessment specified by the assessment ARN.
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Creates a new application using the resource group ARN generated by CreateResourceGroup.
CreateAssessmentResult	createAssessment(CreateAssessmentRequest createAssessmentRequest) Creates an assessment for the application specified by the application 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 application.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes the application specified by the application ARN.
DeleteAssessmentResult	deleteAssessment(DeleteAssessmentRequest deleteAssessmentRequest) Deletes the assessment specified by the assessment ARN.
DeleteRunResult	deleteRun(DeleteRunRequest deleteRunRequest) Deletes the assessment run specified by the run ARN.
DescribeApplicationResult	describeApplication(DescribeApplicationRequest describeApplicationRequest) Describes the application specified by the application ARN.
DescribeAssessmentResult	describeAssessment(DescribeAssessmentRequest describeAssessmentRequest) Describes the assessment specified by the assessment ARN.
DescribeCrossAccountAccessRoleResult	describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest) Describes the IAM role that enables Inspector to access your AWS account.
DescribeFindingResult	describeFinding(DescribeFindingRequest describeFindingRequest) Describes the finding specified by the finding ARN.
DescribeResourceGroupResult	describeResourceGroup(DescribeResourceGroupRequest describeResourceGroupRequest) Describes the resource group specified by the resource group ARN.
DescribeRulesPackageResult	describeRulesPackage(DescribeRulesPackageRequest describeRulesPackageRequest) Describes the rules package specified by the rules package ARN.
DescribeRunResult	describeRun(DescribeRunRequest describeRunRequest) Describes the assessment run specified by the run ARN.
DetachAssessmentAndRulesPackageResult	detachAssessmentAndRulesPackage(DetachAssessmentAndRulesPackageRequest detachAssessmentAndRulesPackageRequest) Detaches the rules package specified by the rules package ARN from the assessment specified by the assessment ARN.
GetAssessmentTelemetryResult	getAssessmentTelemetry(GetAssessmentTelemetryRequest getAssessmentTelemetryRequest) Returns the metadata about the telemetry (application behavioral data) for the assessment specified by the assessment ARN.
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.
ListApplicationsResult	listApplications(ListApplicationsRequest listApplicationsRequest) Lists the ARNs of the applications within this AWS account.
ListAssessmentAgentsResult	listAssessmentAgents(ListAssessmentAgentsRequest listAssessmentAgentsRequest) Lists the agents of the assessment specified by the assessment ARN.
ListAssessmentsResult	listAssessments(ListAssessmentsRequest listAssessmentsRequest) Lists the assessments corresponding to applications specified by the applications' ARNs.
ListAttachedAssessmentsResult	listAttachedAssessments(ListAttachedAssessmentsRequest listAttachedAssessmentsRequest) Lists the assessments attached to the rules package specified by the rules package ARN.
ListAttachedRulesPackagesResult	listAttachedRulesPackages(ListAttachedRulesPackagesRequest listAttachedRulesPackagesRequest) Lists the rules packages attached to the assessment specified by the assessment ARN.
ListFindingsResult	listFindings(ListFindingsRequest listFindingsRequest) Lists findings generated by the assessment run specified by the run ARNs.
ListRulesPackagesResult	listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest) Lists all available Inspector rules packages.
ListRunsResult	listRuns(ListRunsRequest listRunsRequest) Lists the assessment runs associated with the assessments specified by the assessment ARNs.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags associated with a resource.
LocalizeTextResult	localizeText(LocalizeTextRequest localizeTextRequest) Translates a textual identifier into a user-readable text in a specified locale.
PreviewAgentsForResourceGroupResult	previewAgentsForResourceGroup(PreviewAgentsForResourceGroupRequest previewAgentsForResourceGroupRequest) Previews the agents installed on the EC2 instances that are included in the application created with the specified resource group.
RegisterCrossAccountAccessRoleResult	registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest) Register the role that Inspector uses to list your EC2 instances during the assessment.
RemoveAttributesFromFindingsResult	removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest) Removes the entire attribute (key and value pair) from the findings specified by the finding ARNs where an attribute with the specified key exists.
RunAssessmentResult	runAssessment(RunAssessmentRequest runAssessmentRequest) Starts the analysis of the application’s behavior against selected rule packages for the assessment specified by the assessment ARN.
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.
SetTagsForResourceResult	setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest) Sets tags (key and value pairs) to the assessment specified by the assessment ARN.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDataCollectionResult	startDataCollection(StartDataCollectionRequest startDataCollectionRequest) Starts data collection for the assessment specified by the assessment ARN.
StopDataCollectionResult	stopDataCollection(StopDataCollectionRequest stopDataCollectionRequest) Stop data collection for the assessment specified by the assessment ARN.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates application specified by the application ARN.
UpdateAssessmentResult	updateAssessment(UpdateAssessmentRequest updateAssessmentRequest) Updates the assessment specified by the assessment 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

InvalidInputException

AccessDeniedException

NoSuchEntityException

attachAssessmentAndRulesPackage

AttachAssessmentAndRulesPackageResult attachAssessmentAndRulesPackage(AttachAssessmentAndRulesPackageRequest attachAssessmentAndRulesPackageRequest)

Attaches the rules package specified by the rules package ARN to the assessment specified by the assessment ARN.

Parameters:

attachAssessmentAndRulesPackageRequest -

Returns:

Result of the AttachAssessmentAndRulesPackage operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

createApplication

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

Creates a new application using the resource group ARN generated by CreateResourceGroup. You can create up to 50 applications per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Inspector Applications.

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

createAssessment

CreateAssessmentResult createAssessment(CreateAssessmentRequest createAssessmentRequest)

Creates an assessment for the application specified by the application ARN. You can create up to 500 assessments per AWS account.

Parameters:

createAssessmentRequest -

Returns:

Result of the CreateAssessment operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

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

Parameters:

createResourceGroupRequest -

Returns:

Result of the CreateResourceGroup operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

deleteApplication

DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

Deletes the application specified by the application ARN.

Parameters:

deleteApplicationRequest -

Returns:

Result of the DeleteApplication operation returned by the service.

Throws:

InternalException

InvalidInputException

OperationInProgressException

AccessDeniedException

NoSuchEntityException

deleteAssessment

DeleteAssessmentResult deleteAssessment(DeleteAssessmentRequest deleteAssessmentRequest)

Deletes the assessment specified by the assessment ARN.

Parameters:

deleteAssessmentRequest -

Returns:

Result of the DeleteAssessment operation returned by the service.

Throws:

InternalException

InvalidInputException

OperationInProgressException

AccessDeniedException

NoSuchEntityException

deleteRun

DeleteRunResult deleteRun(DeleteRunRequest deleteRunRequest)

Deletes the assessment run specified by the run ARN.

Parameters:

deleteRunRequest -

Returns:

Result of the DeleteRun operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

describeApplication

DescribeApplicationResult describeApplication(DescribeApplicationRequest describeApplicationRequest)

Describes the application specified by the application ARN.

Parameters:

describeApplicationRequest -

Returns:

Result of the DescribeApplication operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

describeAssessment

DescribeAssessmentResult describeAssessment(DescribeAssessmentRequest describeAssessmentRequest)

Describes the assessment specified by the assessment ARN.

Parameters:

describeAssessmentRequest -

Returns:

Result of the DescribeAssessment operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

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

AccessDeniedException

describeFinding

DescribeFindingResult describeFinding(DescribeFindingRequest describeFindingRequest)

Describes the finding specified by the finding ARN.

Parameters:

describeFindingRequest -

Returns:

Result of the DescribeFinding operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

describeResourceGroup

DescribeResourceGroupResult describeResourceGroup(DescribeResourceGroupRequest describeResourceGroupRequest)

Describes the resource group specified by the resource group ARN.

Parameters:

describeResourceGroupRequest -

Returns:

Result of the DescribeResourceGroup operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

describeRulesPackage

DescribeRulesPackageResult describeRulesPackage(DescribeRulesPackageRequest describeRulesPackageRequest)

Describes the rules package specified by the rules package ARN.

Parameters:

describeRulesPackageRequest -

Returns:

Result of the DescribeRulesPackage operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

describeRun

DescribeRunResult describeRun(DescribeRunRequest describeRunRequest)

Describes the assessment run specified by the run ARN.

Parameters:

describeRunRequest -

Returns:

Result of the DescribeRun operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

detachAssessmentAndRulesPackage

DetachAssessmentAndRulesPackageResult detachAssessmentAndRulesPackage(DetachAssessmentAndRulesPackageRequest detachAssessmentAndRulesPackageRequest)

Detaches the rules package specified by the rules package ARN from the assessment specified by the assessment ARN.

Parameters:

detachAssessmentAndRulesPackageRequest -

Returns:

Result of the DetachAssessmentAndRulesPackage operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

getAssessmentTelemetry

GetAssessmentTelemetryResult getAssessmentTelemetry(GetAssessmentTelemetryRequest getAssessmentTelemetryRequest)

Returns the metadata about the telemetry (application behavioral data) for the assessment specified by the assessment ARN.

Parameters:

getAssessmentTelemetryRequest -

Returns:

Result of the GetAssessmentTelemetry operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

listApplications

ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)

Lists the ARNs of the applications within this AWS account. For more information about applications, see Inspector Applications.

Parameters:

listApplicationsRequest -

Returns:

Result of the ListApplications operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

listAssessmentAgents

ListAssessmentAgentsResult listAssessmentAgents(ListAssessmentAgentsRequest listAssessmentAgentsRequest)

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

Parameters:

listAssessmentAgentsRequest -

Returns:

Result of the ListAssessmentAgents operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

listAssessments

ListAssessmentsResult listAssessments(ListAssessmentsRequest listAssessmentsRequest)

Lists the assessments corresponding to applications specified by the applications' ARNs.

Parameters:

listAssessmentsRequest -

Returns:

Result of the ListAssessments operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

listAttachedAssessments

ListAttachedAssessmentsResult listAttachedAssessments(ListAttachedAssessmentsRequest listAttachedAssessmentsRequest)

Lists the assessments attached to the rules package specified by the rules package ARN.

Parameters:

listAttachedAssessmentsRequest -

Returns:

Result of the ListAttachedAssessments operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

listAttachedRulesPackages

ListAttachedRulesPackagesResult listAttachedRulesPackages(ListAttachedRulesPackagesRequest listAttachedRulesPackagesRequest)

Lists the rules packages attached to the assessment specified by the assessment ARN.

Parameters:

listAttachedRulesPackagesRequest -

Returns:

Result of the ListAttachedRulesPackages operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

listFindings

ListFindingsResult listFindings(ListFindingsRequest listFindingsRequest)

Lists findings generated by the assessment run specified by the run ARNs.

Parameters:

listFindingsRequest -

Returns:

Result of the ListFindings operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

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

InvalidInputException

AccessDeniedException

listRuns

ListRunsResult listRuns(ListRunsRequest listRunsRequest)

Lists the assessment runs associated with the assessments specified by the assessment ARNs.

Parameters:

listRunsRequest -

Returns:

Result of the ListRuns operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags associated with a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

localizeText

LocalizeTextResult localizeText(LocalizeTextRequest localizeTextRequest)

Translates a textual identifier into a user-readable text in a specified locale.

Parameters:

localizeTextRequest -

Returns:

Result of the LocalizeText operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

previewAgentsForResourceGroup

PreviewAgentsForResourceGroupResult previewAgentsForResourceGroup(PreviewAgentsForResourceGroupRequest previewAgentsForResourceGroupRequest)

Previews the agents installed on the EC2 instances that are included in the application created with the specified resource group.

Parameters:

previewAgentsForResourceGroupRequest -

Returns:

Result of the PreviewAgentsForResourceGroup operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

InvalidCrossAccountRoleException

registerCrossAccountAccessRole

RegisterCrossAccountAccessRoleResult registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest)

Register the role that Inspector uses to list your EC2 instances during the assessment.

Parameters:

registerCrossAccountAccessRoleRequest -

Returns:

Result of the RegisterCrossAccountAccessRole operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

InvalidCrossAccountRoleException

removeAttributesFromFindings

RemoveAttributesFromFindingsResult removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest)

Removes the entire attribute (key and value pair) 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

InvalidInputException

AccessDeniedException

NoSuchEntityException

runAssessment

RunAssessmentResult runAssessment(RunAssessmentRequest runAssessmentRequest)

Starts the analysis of the application’s behavior against selected rule packages for the assessment specified by the assessment ARN.

Parameters:

runAssessmentRequest -

Returns:

Result of the RunAssessment operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

setTagsForResource

SetTagsForResourceResult setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)

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

Parameters:

setTagsForResourceRequest -

Returns:

Result of the SetTagsForResource operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

startDataCollection

StartDataCollectionResult startDataCollection(StartDataCollectionRequest startDataCollectionRequest)

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

Parameters:

startDataCollectionRequest -

Returns:

Result of the StartDataCollection operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

InvalidCrossAccountRoleException

stopDataCollection

StopDataCollectionResult stopDataCollection(StopDataCollectionRequest stopDataCollectionRequest)

Stop data collection for the assessment specified by the assessment ARN.

Parameters:

stopDataCollectionRequest -

Returns:

Result of the StopDataCollection operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

updateApplication

UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)

Updates application specified by the application ARN.

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

updateAssessment

UpdateAssessmentResult updateAssessment(UpdateAssessmentRequest updateAssessmentRequest)

Updates the assessment specified by the assessment ARN.

Parameters:

updateAssessmentRequest -

Returns:

Result of the UpdateAssessment operation returned by the service.

Throws:

InternalException

InvalidInputException

AccessDeniedException

NoSuchEntityException

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.