com.amazonaws.services.inspector

Class AbstractAmazonInspector

java.lang.Object

com.amazonaws.services.inspector.AbstractAmazonInspector

All Implemented Interfaces:

AmazonInspector

Direct Known Subclasses:

AbstractAmazonInspectorAsync

public class AbstractAmazonInspector
extends Object
implements AmazonInspector

Abstract implementation of AmazonInspector. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Method Summary

Methods

Modifier and Type	Method and Description
AddAttributesToFindingsResult	addAttributesToFindings(AddAttributesToFindingsRequest request) Assigns attributes (key and value pair) to the findings specified by the findings' ARNs.
AttachAssessmentAndRulesPackageResult	attachAssessmentAndRulesPackage(AttachAssessmentAndRulesPackageRequest request) Attaches the rules package specified by the rules package ARN to the assessment specified by the assessment ARN.
CreateApplicationResult	createApplication(CreateApplicationRequest request) Creates a new application using the resource group ARN generated by CreateResourceGroup.
CreateAssessmentResult	createAssessment(CreateAssessmentRequest request) Creates an assessment for the application specified by the application ARN.
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 Inspector application.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest request) Deletes the application specified by the application ARN.
DeleteAssessmentResult	deleteAssessment(DeleteAssessmentRequest request) Deletes the assessment specified by the assessment ARN.
DeleteRunResult	deleteRun(DeleteRunRequest request) Deletes the assessment run specified by the run ARN.
DescribeApplicationResult	describeApplication(DescribeApplicationRequest request) Describes the application specified by the application ARN.
DescribeAssessmentResult	describeAssessment(DescribeAssessmentRequest request) Describes the assessment specified by the assessment ARN.
DescribeCrossAccountAccessRoleResult	describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest request) Describes the IAM role that enables Inspector to access your AWS account.
DescribeFindingResult	describeFinding(DescribeFindingRequest request) Describes the finding specified by the finding ARN.
DescribeResourceGroupResult	describeResourceGroup(DescribeResourceGroupRequest request) Describes the resource group specified by the resource group ARN.
DescribeRulesPackageResult	describeRulesPackage(DescribeRulesPackageRequest request) Describes the rules package specified by the rules package ARN.
DescribeRunResult	describeRun(DescribeRunRequest request) Describes the assessment run specified by the run ARN.
DetachAssessmentAndRulesPackageResult	detachAssessmentAndRulesPackage(DetachAssessmentAndRulesPackageRequest request) Detaches the rules package specified by the rules package ARN from the assessment specified by the assessment ARN.
GetAssessmentTelemetryResult	getAssessmentTelemetry(GetAssessmentTelemetryRequest request) 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 request) Lists the ARNs of the applications within this AWS account.
ListAssessmentAgentsResult	listAssessmentAgents(ListAssessmentAgentsRequest request) Lists the agents of the assessment specified by the assessment ARN.
ListAssessmentsResult	listAssessments(ListAssessmentsRequest request) Lists the assessments corresponding to applications specified by the applications' ARNs.
ListAttachedAssessmentsResult	listAttachedAssessments(ListAttachedAssessmentsRequest request) Lists the assessments attached to the rules package specified by the rules package ARN.
ListAttachedRulesPackagesResult	listAttachedRulesPackages(ListAttachedRulesPackagesRequest request) Lists the rules packages attached to the assessment specified by the assessment ARN.
ListFindingsResult	listFindings(ListFindingsRequest request) Lists findings generated by the assessment run specified by the run ARNs.
ListRulesPackagesResult	listRulesPackages(ListRulesPackagesRequest request) Lists all available Inspector rules packages.
ListRunsResult	listRuns(ListRunsRequest request) Lists the assessment runs associated with the assessments specified by the assessment ARNs.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags associated with a resource.
LocalizeTextResult	localizeText(LocalizeTextRequest request) Translates a textual identifier into a user-readable text in a specified locale.
PreviewAgentsForResourceGroupResult	previewAgentsForResourceGroup(PreviewAgentsForResourceGroupRequest request) Previews the agents installed on the EC2 instances that are included in the application created with the specified resource group.
RegisterCrossAccountAccessRoleResult	registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest request) Register the role that Inspector uses to list your EC2 instances during the assessment.
RemoveAttributesFromFindingsResult	removeAttributesFromFindings(RemoveAttributesFromFindingsRequest request) 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 request) 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 AmazonInspector.setEndpoint(String), sets the regional endpoint for this client's service calls.
SetTagsForResourceResult	setTagsForResource(SetTagsForResourceRequest request) 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 request) Starts data collection for the assessment specified by the assessment ARN.
StopDataCollectionResult	stopDataCollection(StopDataCollectionRequest request) Stop data collection for the assessment specified by the assessment ARN.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest request) Updates application specified by the application ARN.
UpdateAssessmentResult	updateAssessment(UpdateAssessmentRequest request) Updates the assessment specified by the assessment ARN.

Methods inherited from class java.lang.Object

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

Method Detail

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AmazonInspector

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.

Specified by:

setEndpoint in interface AmazonInspector

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

public void setRegion(Region region)

Description copied from interface: AmazonInspector

An alternative to AmazonInspector.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.

Specified by:

setRegion in interface AmazonInspector

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

public AddAttributesToFindingsResult addAttributesToFindings(AddAttributesToFindingsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

addAttributesToFindings in interface AmazonInspector

Returns:

Result of the AddAttributesToFindings operation returned by the service.

attachAssessmentAndRulesPackage

public AttachAssessmentAndRulesPackageResult attachAssessmentAndRulesPackage(AttachAssessmentAndRulesPackageRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

attachAssessmentAndRulesPackage in interface AmazonInspector

Returns:

Result of the AttachAssessmentAndRulesPackage operation returned by the service.

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

Description copied from interface: AmazonInspector

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.

Specified by:

createApplication in interface AmazonInspector

Returns:

Result of the CreateApplication operation returned by the service.

createAssessment

public CreateAssessmentResult createAssessment(CreateAssessmentRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

createAssessment in interface AmazonInspector

Returns:

Result of the CreateAssessment operation returned by the service.

createResourceGroup

public CreateResourceGroupResult createResourceGroup(CreateResourceGroupRequest request)

Description copied from interface: AmazonInspector

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.

Specified by:

createResourceGroup in interface AmazonInspector

Returns:

Result of the CreateResourceGroup operation returned by the service.

deleteApplication

public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)

Description copied from interface: AmazonInspector

Deletes the application specified by the application ARN.

Specified by:

deleteApplication in interface AmazonInspector

Returns:

Result of the DeleteApplication operation returned by the service.

deleteAssessment

public DeleteAssessmentResult deleteAssessment(DeleteAssessmentRequest request)

Description copied from interface: AmazonInspector

Deletes the assessment specified by the assessment ARN.

Specified by:

deleteAssessment in interface AmazonInspector

Returns:

Result of the DeleteAssessment operation returned by the service.

deleteRun

public DeleteRunResult deleteRun(DeleteRunRequest request)

Description copied from interface: AmazonInspector

Deletes the assessment run specified by the run ARN.

Specified by:

deleteRun in interface AmazonInspector

Returns:

Result of the DeleteRun operation returned by the service.

describeApplication

public DescribeApplicationResult describeApplication(DescribeApplicationRequest request)

Description copied from interface: AmazonInspector

Describes the application specified by the application ARN.

Specified by:

describeApplication in interface AmazonInspector

Returns:

Result of the DescribeApplication operation returned by the service.

describeAssessment

public DescribeAssessmentResult describeAssessment(DescribeAssessmentRequest request)

Description copied from interface: AmazonInspector

Describes the assessment specified by the assessment ARN.

Specified by:

describeAssessment in interface AmazonInspector

Returns:

Result of the DescribeAssessment operation returned by the service.

describeCrossAccountAccessRole

public DescribeCrossAccountAccessRoleResult describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

describeCrossAccountAccessRole in interface AmazonInspector

Returns:

Result of the DescribeCrossAccountAccessRole operation returned by the service.

describeFinding

public DescribeFindingResult describeFinding(DescribeFindingRequest request)

Description copied from interface: AmazonInspector

Describes the finding specified by the finding ARN.

Specified by:

describeFinding in interface AmazonInspector

Returns:

Result of the DescribeFinding operation returned by the service.

describeResourceGroup

public DescribeResourceGroupResult describeResourceGroup(DescribeResourceGroupRequest request)

Description copied from interface: AmazonInspector

Describes the resource group specified by the resource group ARN.

Specified by:

describeResourceGroup in interface AmazonInspector

Returns:

Result of the DescribeResourceGroup operation returned by the service.

describeRulesPackage

public DescribeRulesPackageResult describeRulesPackage(DescribeRulesPackageRequest request)

Description copied from interface: AmazonInspector

Describes the rules package specified by the rules package ARN.

Specified by:

describeRulesPackage in interface AmazonInspector

Returns:

Result of the DescribeRulesPackage operation returned by the service.

describeRun

public DescribeRunResult describeRun(DescribeRunRequest request)

Description copied from interface: AmazonInspector

Describes the assessment run specified by the run ARN.

Specified by:

describeRun in interface AmazonInspector

Returns:

Result of the DescribeRun operation returned by the service.

detachAssessmentAndRulesPackage

public DetachAssessmentAndRulesPackageResult detachAssessmentAndRulesPackage(DetachAssessmentAndRulesPackageRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

detachAssessmentAndRulesPackage in interface AmazonInspector

Returns:

Result of the DetachAssessmentAndRulesPackage operation returned by the service.

getAssessmentTelemetry

public GetAssessmentTelemetryResult getAssessmentTelemetry(GetAssessmentTelemetryRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

getAssessmentTelemetry in interface AmazonInspector

Returns:

Result of the GetAssessmentTelemetry operation returned by the service.

listApplications

public ListApplicationsResult listApplications(ListApplicationsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listApplications in interface AmazonInspector

Returns:

Result of the ListApplications operation returned by the service.

listAssessmentAgents

public ListAssessmentAgentsResult listAssessmentAgents(ListAssessmentAgentsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listAssessmentAgents in interface AmazonInspector

Returns:

Result of the ListAssessmentAgents operation returned by the service.

listAssessments

public ListAssessmentsResult listAssessments(ListAssessmentsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listAssessments in interface AmazonInspector

Returns:

Result of the ListAssessments operation returned by the service.

listAttachedAssessments

public ListAttachedAssessmentsResult listAttachedAssessments(ListAttachedAssessmentsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listAttachedAssessments in interface AmazonInspector

Returns:

Result of the ListAttachedAssessments operation returned by the service.

listAttachedRulesPackages

public ListAttachedRulesPackagesResult listAttachedRulesPackages(ListAttachedRulesPackagesRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listAttachedRulesPackages in interface AmazonInspector

Returns:

Result of the ListAttachedRulesPackages operation returned by the service.

listFindings

public ListFindingsResult listFindings(ListFindingsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listFindings in interface AmazonInspector

Returns:

Result of the ListFindings operation returned by the service.

listRulesPackages

public ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest request)

Description copied from interface: AmazonInspector

Lists all available Inspector rules packages.

Specified by:

listRulesPackages in interface AmazonInspector

Returns:

Result of the ListRulesPackages operation returned by the service.

listRuns

public ListRunsResult listRuns(ListRunsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listRuns in interface AmazonInspector

Returns:

Result of the ListRuns operation returned by the service.

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonInspector

Lists all tags associated with a resource.

Specified by:

listTagsForResource in interface AmazonInspector

Returns:

Result of the ListTagsForResource operation returned by the service.

localizeText

public LocalizeTextResult localizeText(LocalizeTextRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

localizeText in interface AmazonInspector

Returns:

Result of the LocalizeText operation returned by the service.

previewAgentsForResourceGroup

public PreviewAgentsForResourceGroupResult previewAgentsForResourceGroup(PreviewAgentsForResourceGroupRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

previewAgentsForResourceGroup in interface AmazonInspector

Returns:

Result of the PreviewAgentsForResourceGroup operation returned by the service.

registerCrossAccountAccessRole

public RegisterCrossAccountAccessRoleResult registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

registerCrossAccountAccessRole in interface AmazonInspector

Returns:

Result of the RegisterCrossAccountAccessRole operation returned by the service.

removeAttributesFromFindings

public RemoveAttributesFromFindingsResult removeAttributesFromFindings(RemoveAttributesFromFindingsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

removeAttributesFromFindings in interface AmazonInspector

Returns:

Result of the RemoveAttributesFromFindings operation returned by the service.

runAssessment

public RunAssessmentResult runAssessment(RunAssessmentRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

runAssessment in interface AmazonInspector

Returns:

Result of the RunAssessment operation returned by the service.

setTagsForResource

public SetTagsForResourceResult setTagsForResource(SetTagsForResourceRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

setTagsForResource in interface AmazonInspector

Returns:

Result of the SetTagsForResource operation returned by the service.

startDataCollection

public StartDataCollectionResult startDataCollection(StartDataCollectionRequest request)

Description copied from interface: AmazonInspector

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.

Specified by:

startDataCollection in interface AmazonInspector

Returns:

Result of the StartDataCollection operation returned by the service.

stopDataCollection

public StopDataCollectionResult stopDataCollection(StopDataCollectionRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

stopDataCollection in interface AmazonInspector

Returns:

Result of the StopDataCollection operation returned by the service.

updateApplication

public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)

Description copied from interface: AmazonInspector

Updates application specified by the application ARN.

Specified by:

updateApplication in interface AmazonInspector

Returns:

Result of the UpdateApplication operation returned by the service.

updateAssessment

public UpdateAssessmentResult updateAssessment(UpdateAssessmentRequest request)

Description copied from interface: AmazonInspector

Updates the assessment specified by the assessment ARN.

Specified by:

updateAssessment in interface AmazonInspector

Returns:

Result of the UpdateAssessment operation returned by the service.

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

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonInspector

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.

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.