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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAmazonInspector()

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.
CreateAssessmentTargetResult	createAssessmentTarget(CreateAssessmentTargetRequest request) Creates a new assessment target using the resource group ARN generated by CreateResourceGroup.
CreateAssessmentTemplateResult	createAssessmentTemplate(CreateAssessmentTemplateRequest request) Creates an assessment template for the assessment target specified by the assessment target 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 assessment target.
void	deleteAssessmentRun(DeleteAssessmentRunRequest request) Deletes the assessment run specified by the assessment run ARN.
void	deleteAssessmentTarget(DeleteAssessmentTargetRequest request) Deletes the assessment target specified by the assessment target ARN.
void	deleteAssessmentTemplate(DeleteAssessmentTemplateRequest request) Deletes the assessment template specified by the assessment template ARN.
DescribeAssessmentRunsResult	describeAssessmentRuns(DescribeAssessmentRunsRequest request) Describes the assessment run(s) specified by the assessment run ARN(s).
DescribeAssessmentTargetsResult	describeAssessmentTargets(DescribeAssessmentTargetsRequest request) Describes the assessment target(s) specified by the assessment target ARN(s).
DescribeAssessmentTemplatesResult	describeAssessmentTemplates(DescribeAssessmentTemplatesRequest request) Describes the assessment template(s) specified by the assessment template(s) ARN(s).
DescribeCrossAccountAccessRoleResult	describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest request) Describes the IAM role that enables Inspector to access your AWS account.
DescribeFindingsResult	describeFindings(DescribeFindingsRequest request) Describes the finding(s) specified by the finding ARN(s).
DescribeResourceGroupsResult	describeResourceGroups(DescribeResourceGroupsRequest request) Describes resource group(s) specified by the resource group ARN(s).
DescribeRulesPackagesResult	describeRulesPackages(DescribeRulesPackagesRequest request) 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 request) Information about the data collected for the specified assessment run.
ListAssessmentRunAgentsResult	listAssessmentRunAgents(ListAssessmentRunAgentsRequest request) Lists the agents of the assessment run specified by the assessment run ARN.
ListAssessmentRunsResult	listAssessmentRuns(ListAssessmentRunsRequest request) Lists the assessments run corresponding to assessment template(s) specified by the assessment template(s)' ARN(s).
ListAssessmentTargetsResult	listAssessmentTargets(ListAssessmentTargetsRequest request) Lists the ARN(s) of the assessment target(s) within this AWS account.
ListAssessmentTemplatesResult	listAssessmentTemplates(ListAssessmentTemplatesRequest request) Lists the assessment template(s) corresponding to the assessment target(s) specified by the assessment targets' ARN(s).
ListEventSubscriptionsResult	listEventSubscriptions(ListEventSubscriptionsRequest request) Lists all the event subscriptions for the assessment template specified by the assessment template ARN.
ListFindingsResult	listFindings(ListFindingsRequest request) Lists findings generated by the assessment run(s) specified by the assessment run ARN(s).
ListRulesPackagesResult	listRulesPackages(ListRulesPackagesRequest request) Lists all available 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.
void	registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest request) 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 request) 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 AmazonInspector.setEndpoint(String), sets the regional endpoint for this client's service calls.
void	setTagsForResource(SetTagsForResourceRequest request) 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 request) Starts the assessment run specified by the assessment template ARN.
void	stopAssessmentRun(StopAssessmentRunRequest request) Stops the assessment run specified by the assessment run ARN.
void	subscribeToEvent(SubscribeToEventRequest request) Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified topic.
void	unsubscribeFromEvent(UnsubscribeFromEventRequest request) Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified topic.
void	updateAssessmentTarget(UpdateAssessmentTargetRequest request) Updates the assessment target specified by the assessment target ARN.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAmazonInspector

protected AbstractAmazonInspector()

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.

createAssessmentTarget

public CreateAssessmentTargetResult createAssessmentTarget(CreateAssessmentTargetRequest request)

Description copied from interface: AmazonInspector

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.

Specified by:

createAssessmentTarget in interface AmazonInspector

Returns:

Result of the CreateAssessmentTarget operation returned by the service.

createAssessmentTemplate

public CreateAssessmentTemplateResult createAssessmentTemplate(CreateAssessmentTemplateRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

createAssessmentTemplate in interface AmazonInspector

Returns:

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

Specified by:

createResourceGroup in interface AmazonInspector

Returns:

Result of the CreateResourceGroup operation returned by the service.

deleteAssessmentRun

public void deleteAssessmentRun(DeleteAssessmentRunRequest request)

Description copied from interface: AmazonInspector

Deletes the assessment run specified by the assessment run ARN.

Specified by:

deleteAssessmentRun in interface AmazonInspector

deleteAssessmentTarget

public void deleteAssessmentTarget(DeleteAssessmentTargetRequest request)

Description copied from interface: AmazonInspector

Deletes the assessment target specified by the assessment target ARN.

Specified by:

deleteAssessmentTarget in interface AmazonInspector

deleteAssessmentTemplate

public void deleteAssessmentTemplate(DeleteAssessmentTemplateRequest request)

Description copied from interface: AmazonInspector

Deletes the assessment template specified by the assessment template ARN.

Specified by:

deleteAssessmentTemplate in interface AmazonInspector

describeAssessmentRuns

public DescribeAssessmentRunsResult describeAssessmentRuns(DescribeAssessmentRunsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

describeAssessmentRuns in interface AmazonInspector

Returns:

Result of the DescribeAssessmentRuns operation returned by the service.

describeAssessmentTargets

public DescribeAssessmentTargetsResult describeAssessmentTargets(DescribeAssessmentTargetsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

describeAssessmentTargets in interface AmazonInspector

Returns:

Result of the DescribeAssessmentTargets operation returned by the service.

describeAssessmentTemplates

public DescribeAssessmentTemplatesResult describeAssessmentTemplates(DescribeAssessmentTemplatesRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

describeAssessmentTemplates in interface AmazonInspector

Returns:

Result of the DescribeAssessmentTemplates 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.

describeFindings

public DescribeFindingsResult describeFindings(DescribeFindingsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

describeFindings in interface AmazonInspector

Returns:

Result of the DescribeFindings operation returned by the service.

describeResourceGroups

public DescribeResourceGroupsResult describeResourceGroups(DescribeResourceGroupsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

describeResourceGroups in interface AmazonInspector

Returns:

Result of the DescribeResourceGroups operation returned by the service.

describeRulesPackages

public DescribeRulesPackagesResult describeRulesPackages(DescribeRulesPackagesRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

describeRulesPackages in interface AmazonInspector

Returns:

Result of the DescribeRulesPackages operation returned by the service.

getTelemetryMetadata

public GetTelemetryMetadataResult getTelemetryMetadata(GetTelemetryMetadataRequest request)

Description copied from interface: AmazonInspector

Information about the data collected for the specified assessment run.

Specified by:

getTelemetryMetadata in interface AmazonInspector

Returns:

Result of the GetTelemetryMetadata operation returned by the service.

listAssessmentRunAgents

public ListAssessmentRunAgentsResult listAssessmentRunAgents(ListAssessmentRunAgentsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listAssessmentRunAgents in interface AmazonInspector

Returns:

Result of the ListAssessmentRunAgents operation returned by the service.

listAssessmentRuns

public ListAssessmentRunsResult listAssessmentRuns(ListAssessmentRunsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listAssessmentRuns in interface AmazonInspector

Returns:

Result of the ListAssessmentRuns operation returned by the service.

listAssessmentTargets

public ListAssessmentTargetsResult listAssessmentTargets(ListAssessmentTargetsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listAssessmentTargets in interface AmazonInspector

Returns:

Result of the ListAssessmentTargets operation returned by the service.

listAssessmentTemplates

public ListAssessmentTemplatesResult listAssessmentTemplates(ListAssessmentTemplatesRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listAssessmentTemplates in interface AmazonInspector

Returns:

Result of the ListAssessmentTemplates operation returned by the service.

listEventSubscriptions

public ListEventSubscriptionsResult listEventSubscriptions(ListEventSubscriptionsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

listEventSubscriptions in interface AmazonInspector

Returns:

Result of the ListEventSubscriptions operation returned by the service.

listFindings

public ListFindingsResult listFindings(ListFindingsRequest request)

Description copied from interface: AmazonInspector

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

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.

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonInspector

Lists all tags associated with an assessment template.

Specified by:

listTagsForResource in interface AmazonInspector

Returns:

Result of the ListTagsForResource operation returned by the service.

previewAgents

public PreviewAgentsResult previewAgents(PreviewAgentsRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

previewAgents in interface AmazonInspector

Returns:

Result of the PreviewAgents operation returned by the service.

registerCrossAccountAccessRole

public void registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest request)

Description copied from interface: AmazonInspector

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.

Specified by:

registerCrossAccountAccessRole in interface AmazonInspector

removeAttributesFromFindings

public RemoveAttributesFromFindingsResult removeAttributesFromFindings(RemoveAttributesFromFindingsRequest request)

Description copied from interface: AmazonInspector

Removes entire attributes (key and value pairs) 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.

setTagsForResource

public void setTagsForResource(SetTagsForResourceRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

setTagsForResource in interface AmazonInspector

startAssessmentRun

public StartAssessmentRunResult startAssessmentRun(StartAssessmentRunRequest request)

Description copied from interface: AmazonInspector

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.

Specified by:

startAssessmentRun in interface AmazonInspector

Returns:

Result of the StartAssessmentRun operation returned by the service.

stopAssessmentRun

public void stopAssessmentRun(StopAssessmentRunRequest request)

Description copied from interface: AmazonInspector

Stops the assessment run specified by the assessment run ARN.

Specified by:

stopAssessmentRun in interface AmazonInspector

subscribeToEvent

public void subscribeToEvent(SubscribeToEventRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

subscribeToEvent in interface AmazonInspector

unsubscribeFromEvent

public void unsubscribeFromEvent(UnsubscribeFromEventRequest request)

Description copied from interface: AmazonInspector

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

Specified by:

unsubscribeFromEvent in interface AmazonInspector

updateAssessmentTarget

public void updateAssessmentTarget(UpdateAssessmentTargetRequest request)

Description copied from interface: AmazonInspector

Updates the assessment target specified by the assessment target ARN.

Specified by:

updateAssessmentTarget in interface AmazonInspector

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.