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 ofAmazonInspector
. Convenient method forms pass through to the corresponding overload that takes a request object, which throws anUnsupportedOperationException
.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractAmazonInspector()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddAttributesToFindingsResult
addAttributesToFindings(AddAttributesToFindingsRequest request)
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.CreateAssessmentTargetResult
createAssessmentTarget(CreateAssessmentTargetRequest request)
Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup.CreateAssessmentTemplateResult
createAssessmentTemplate(CreateAssessmentTemplateRequest request)
Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.CreateResourceGroupResult
createResourceGroup(CreateResourceGroupRequest request)
Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target.DeleteAssessmentRunResult
deleteAssessmentRun(DeleteAssessmentRunRequest request)
Deletes the assessment run that is specified by the ARN of the assessment run.DeleteAssessmentTargetResult
deleteAssessmentTarget(DeleteAssessmentTargetRequest request)
Deletes the assessment target that is specified by the ARN of the assessment target.DeleteAssessmentTemplateResult
deleteAssessmentTemplate(DeleteAssessmentTemplateRequest request)
Deletes the assessment template that is specified by the ARN of the assessment template.DescribeAssessmentRunsResult
describeAssessmentRuns(DescribeAssessmentRunsRequest request)
Describes the assessment runs that are specified by the ARNs of the assessment runs.DescribeAssessmentTargetsResult
describeAssessmentTargets(DescribeAssessmentTargetsRequest request)
Describes the assessment targets that are specified by the ARNs of the assessment targets.DescribeAssessmentTemplatesResult
describeAssessmentTemplates(DescribeAssessmentTemplatesRequest request)
Describes the assessment templates that are specified by the ARNs of the assessment templates.DescribeCrossAccountAccessRoleResult
describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest request)
Describes the IAM role that enables Amazon Inspector to access your AWS account.DescribeFindingsResult
describeFindings(DescribeFindingsRequest request)
Describes the findings that are specified by the ARNs of the findings.DescribeResourceGroupsResult
describeResourceGroups(DescribeResourceGroupsRequest request)
Describes the resource groups that are specified by the ARNs of the resource groups.DescribeRulesPackagesResult
describeRulesPackages(DescribeRulesPackagesRequest request)
Describes the rules packages that are specified by the ARNs of the rules packages.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 that is collected for the specified assessment run.ListAssessmentRunAgentsResult
listAssessmentRunAgents(ListAssessmentRunAgentsRequest request)
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.ListAssessmentRunsResult
listAssessmentRuns(ListAssessmentRunsRequest request)
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.ListAssessmentTargetsResult
listAssessmentTargets(ListAssessmentTargetsRequest request)
Lists the ARNs of the assessment targets within this AWS account.ListAssessmentTemplatesResult
listAssessmentTemplates(ListAssessmentTemplatesRequest request)
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.ListEventSubscriptionsResult
listEventSubscriptions(ListEventSubscriptionsRequest request)
Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template.ListFindingsResult
listFindings(ListFindingsRequest request)
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.ListRulesPackagesResult
listRulesPackages(ListRulesPackagesRequest request)
Lists all available Amazon Inspector rules packages.ListTagsForResourceResult
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags associated with an assessment template.PreviewAgentsResult
previewAgents(PreviewAgentsRequest request)
Previews the agents installed on the EC2 instances that are part of the specified assessment target.RegisterCrossAccountAccessRoleResult
registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest request)
Registers the IAM role that Amazon 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 that are specified by the ARNs of the findings 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 toAmazonInspector.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 template that is specified by the ARN of the assessment template.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.StartAssessmentRunResult
startAssessmentRun(StartAssessmentRunRequest request)
Starts the assessment run specified by the ARN of the assessment template.StopAssessmentRunResult
stopAssessmentRun(StopAssessmentRunRequest request)
Stops the assessment run that is specified by the ARN of the assessment run.SubscribeToEventResult
subscribeToEvent(SubscribeToEventRequest request)
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.UnsubscribeFromEventResult
unsubscribeFromEvent(UnsubscribeFromEventRequest request)
Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.UpdateAssessmentTargetResult
updateAssessmentTarget(UpdateAssessmentTargetRequest request)
Updates the assessment target that is specified by the ARN of the assessment target.
-
-
-
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 interfaceAmazonInspector
- 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 toAmazonInspector.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 interfaceAmazonInspector
- Parameters:
region
- The region this client will communicate with. SeeRegion.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 pairs) to the findings that are specified by the ARNs of the findings.
- Specified by:
addAttributesToFindings
in interfaceAmazonInspector
- 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 ARN of the resource group that is 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 interfaceAmazonInspector
- 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 that is specified by the ARN of the assessment target.
- Specified by:
createAssessmentTemplate
in interfaceAmazonInspector
- 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 Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.
- Specified by:
createResourceGroup
in interfaceAmazonInspector
- Returns:
- Result of the CreateResourceGroup operation returned by the service.
-
deleteAssessmentRun
public DeleteAssessmentRunResult deleteAssessmentRun(DeleteAssessmentRunRequest request)
Description copied from interface:AmazonInspector
Deletes the assessment run that is specified by the ARN of the assessment run.
- Specified by:
deleteAssessmentRun
in interfaceAmazonInspector
- Returns:
- Result of the DeleteAssessmentRun operation returned by the service.
-
deleteAssessmentTarget
public DeleteAssessmentTargetResult deleteAssessmentTarget(DeleteAssessmentTargetRequest request)
Description copied from interface:AmazonInspector
Deletes the assessment target that is specified by the ARN of the assessment target.
- Specified by:
deleteAssessmentTarget
in interfaceAmazonInspector
- Returns:
- Result of the DeleteAssessmentTarget operation returned by the service.
-
deleteAssessmentTemplate
public DeleteAssessmentTemplateResult deleteAssessmentTemplate(DeleteAssessmentTemplateRequest request)
Description copied from interface:AmazonInspector
Deletes the assessment template that is specified by the ARN of the assessment template.
- Specified by:
deleteAssessmentTemplate
in interfaceAmazonInspector
- Returns:
- Result of the DeleteAssessmentTemplate operation returned by the service.
-
describeAssessmentRuns
public DescribeAssessmentRunsResult describeAssessmentRuns(DescribeAssessmentRunsRequest request)
Description copied from interface:AmazonInspector
Describes the assessment runs that are specified by the ARNs of the assessment runs.
- Specified by:
describeAssessmentRuns
in interfaceAmazonInspector
- Returns:
- Result of the DescribeAssessmentRuns operation returned by the service.
-
describeAssessmentTargets
public DescribeAssessmentTargetsResult describeAssessmentTargets(DescribeAssessmentTargetsRequest request)
Description copied from interface:AmazonInspector
Describes the assessment targets that are specified by the ARNs of the assessment targets.
- Specified by:
describeAssessmentTargets
in interfaceAmazonInspector
- Returns:
- Result of the DescribeAssessmentTargets operation returned by the service.
-
describeAssessmentTemplates
public DescribeAssessmentTemplatesResult describeAssessmentTemplates(DescribeAssessmentTemplatesRequest request)
Description copied from interface:AmazonInspector
Describes the assessment templates that are specified by the ARNs of the assessment templates.
- Specified by:
describeAssessmentTemplates
in interfaceAmazonInspector
- 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 Amazon Inspector to access your AWS account.
- Specified by:
describeCrossAccountAccessRole
in interfaceAmazonInspector
- Returns:
- Result of the DescribeCrossAccountAccessRole operation returned by the service.
-
describeFindings
public DescribeFindingsResult describeFindings(DescribeFindingsRequest request)
Description copied from interface:AmazonInspector
Describes the findings that are specified by the ARNs of the findings.
- Specified by:
describeFindings
in interfaceAmazonInspector
- Returns:
- Result of the DescribeFindings operation returned by the service.
-
describeResourceGroups
public DescribeResourceGroupsResult describeResourceGroups(DescribeResourceGroupsRequest request)
Description copied from interface:AmazonInspector
Describes the resource groups that are specified by the ARNs of the resource groups.
- Specified by:
describeResourceGroups
in interfaceAmazonInspector
- Returns:
- Result of the DescribeResourceGroups operation returned by the service.
-
describeRulesPackages
public DescribeRulesPackagesResult describeRulesPackages(DescribeRulesPackagesRequest request)
Description copied from interface:AmazonInspector
Describes the rules packages that are specified by the ARNs of the rules packages.
- Specified by:
describeRulesPackages
in interfaceAmazonInspector
- 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 that is collected for the specified assessment run.
- Specified by:
getTelemetryMetadata
in interfaceAmazonInspector
- 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 runs that are specified by the ARNs of the assessment runs.
- Specified by:
listAssessmentRunAgents
in interfaceAmazonInspector
- Returns:
- Result of the ListAssessmentRunAgents operation returned by the service.
-
listAssessmentRuns
public ListAssessmentRunsResult listAssessmentRuns(ListAssessmentRunsRequest request)
Description copied from interface:AmazonInspector
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
- Specified by:
listAssessmentRuns
in interfaceAmazonInspector
- Returns:
- Result of the ListAssessmentRuns operation returned by the service.
-
listAssessmentTargets
public ListAssessmentTargetsResult listAssessmentTargets(ListAssessmentTargetsRequest request)
Description copied from interface:AmazonInspector
Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.
- Specified by:
listAssessmentTargets
in interfaceAmazonInspector
- Returns:
- Result of the ListAssessmentTargets operation returned by the service.
-
listAssessmentTemplates
public ListAssessmentTemplatesResult listAssessmentTemplates(ListAssessmentTemplatesRequest request)
Description copied from interface:AmazonInspector
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
- Specified by:
listAssessmentTemplates
in interfaceAmazonInspector
- 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 that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.
- Specified by:
listEventSubscriptions
in interfaceAmazonInspector
- Returns:
- Result of the ListEventSubscriptions operation returned by the service.
-
listFindings
public ListFindingsResult listFindings(ListFindingsRequest request)
Description copied from interface:AmazonInspector
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
- Specified by:
listFindings
in interfaceAmazonInspector
- Returns:
- Result of the ListFindings operation returned by the service.
-
listRulesPackages
public ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest request)
Description copied from interface:AmazonInspector
Lists all available Amazon Inspector rules packages.
- Specified by:
listRulesPackages
in interfaceAmazonInspector
- 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 interfaceAmazonInspector
- 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 interfaceAmazonInspector
- Returns:
- Result of the PreviewAgents operation returned by the service.
-
registerCrossAccountAccessRole
public RegisterCrossAccountAccessRoleResult registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest request)
Description copied from interface:AmazonInspector
Registers the IAM role that Amazon 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 interfaceAmazonInspector
- Returns:
- Result of the RegisterCrossAccountAccessRole operation returned by the service.
-
removeAttributesFromFindings
public RemoveAttributesFromFindingsResult removeAttributesFromFindings(RemoveAttributesFromFindingsRequest request)
Description copied from interface:AmazonInspector
Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.
- Specified by:
removeAttributesFromFindings
in interfaceAmazonInspector
- Returns:
- Result of the RemoveAttributesFromFindings 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 template that is specified by the ARN of the assessment template.
- Specified by:
setTagsForResource
in interfaceAmazonInspector
- Returns:
- Result of the SetTagsForResource operation returned by the service.
-
startAssessmentRun
public StartAssessmentRunResult startAssessmentRun(StartAssessmentRunRequest request)
Description copied from interface:AmazonInspector
Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.
- Specified by:
startAssessmentRun
in interfaceAmazonInspector
- Returns:
- Result of the StartAssessmentRun operation returned by the service.
-
stopAssessmentRun
public StopAssessmentRunResult stopAssessmentRun(StopAssessmentRunRequest request)
Description copied from interface:AmazonInspector
Stops the assessment run that is specified by the ARN of the assessment run.
- Specified by:
stopAssessmentRun
in interfaceAmazonInspector
- Returns:
- Result of the StopAssessmentRun operation returned by the service.
-
subscribeToEvent
public SubscribeToEventResult 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 SNS topic.
- Specified by:
subscribeToEvent
in interfaceAmazonInspector
- Returns:
- Result of the SubscribeToEvent operation returned by the service.
-
unsubscribeFromEvent
public UnsubscribeFromEventResult 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 SNS topic.
- Specified by:
unsubscribeFromEvent
in interfaceAmazonInspector
- Returns:
- Result of the UnsubscribeFromEvent operation returned by the service.
-
updateAssessmentTarget
public UpdateAssessmentTargetResult updateAssessmentTarget(UpdateAssessmentTargetRequest request)
Description copied from interface:AmazonInspector
Updates the assessment target that is specified by the ARN of the assessment target.
- Specified by:
updateAssessmentTarget
in interfaceAmazonInspector
- Returns:
- Result of the UpdateAssessmentTarget 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 interfaceAmazonInspector
-
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 interfaceAmazonInspector
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-