@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonInspector extends Object implements AmazonInspector
AmazonInspector
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and 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.
|
CreateExclusionsPreviewResult |
createExclusionsPreview(CreateExclusionsPreviewRequest request)
Starts the generation of an exclusions preview for the specified assessment template.
|
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.
|
DescribeExclusionsResult |
describeExclusions(DescribeExclusionsRequest request)
Describes the exclusions that are specified by the exclusions' ARNs.
|
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.
|
GetAssessmentReportResult |
getAssessmentReport(GetAssessmentReportRequest request)
Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
|
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.
|
GetExclusionsPreviewResult |
getExclusionsPreview(GetExclusionsPreviewRequest request)
Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token.
|
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.
|
ListExclusionsResult |
listExclusions(ListExclusionsRequest request)
List exclusions that are generated by the assessment run.
|
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 grants Amazon Inspector access to AWS Services needed to perform security
assessments.
|
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 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 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.
|
public void setEndpoint(String endpoint)
AmazonInspector
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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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.
setEndpoint
in interface AmazonInspector
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.public void setRegion(Region region)
AmazonInspector
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.
setRegion
in interface AmazonInspector
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.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AddAttributesToFindingsResult addAttributesToFindings(AddAttributesToFindingsRequest request)
AmazonInspector
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
addAttributesToFindings
in interface AmazonInspector
public CreateAssessmentTargetResult createAssessmentTarget(CreateAssessmentTargetRequest request)
AmazonInspector
Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. 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.
createAssessmentTarget
in interface AmazonInspector
public CreateAssessmentTemplateResult createAssessmentTemplate(CreateAssessmentTemplateRequest request)
AmazonInspector
Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.
createAssessmentTemplate
in interface AmazonInspector
public CreateExclusionsPreviewResult createExclusionsPreview(CreateExclusionsPreviewRequest request)
AmazonInspector
Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.
createExclusionsPreview
in interface AmazonInspector
public CreateResourceGroupResult createResourceGroup(CreateResourceGroupRequest request)
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.
createResourceGroup
in interface AmazonInspector
public DeleteAssessmentRunResult deleteAssessmentRun(DeleteAssessmentRunRequest request)
AmazonInspector
Deletes the assessment run that is specified by the ARN of the assessment run.
deleteAssessmentRun
in interface AmazonInspector
public DeleteAssessmentTargetResult deleteAssessmentTarget(DeleteAssessmentTargetRequest request)
AmazonInspector
Deletes the assessment target that is specified by the ARN of the assessment target.
deleteAssessmentTarget
in interface AmazonInspector
public DeleteAssessmentTemplateResult deleteAssessmentTemplate(DeleteAssessmentTemplateRequest request)
AmazonInspector
Deletes the assessment template that is specified by the ARN of the assessment template.
deleteAssessmentTemplate
in interface AmazonInspector
public DescribeAssessmentRunsResult describeAssessmentRuns(DescribeAssessmentRunsRequest request)
AmazonInspector
Describes the assessment runs that are specified by the ARNs of the assessment runs.
describeAssessmentRuns
in interface AmazonInspector
public DescribeAssessmentTargetsResult describeAssessmentTargets(DescribeAssessmentTargetsRequest request)
AmazonInspector
Describes the assessment targets that are specified by the ARNs of the assessment targets.
describeAssessmentTargets
in interface AmazonInspector
public DescribeAssessmentTemplatesResult describeAssessmentTemplates(DescribeAssessmentTemplatesRequest request)
AmazonInspector
Describes the assessment templates that are specified by the ARNs of the assessment templates.
describeAssessmentTemplates
in interface AmazonInspector
public DescribeCrossAccountAccessRoleResult describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest request)
AmazonInspector
Describes the IAM role that enables Amazon Inspector to access your AWS account.
describeCrossAccountAccessRole
in interface AmazonInspector
public DescribeExclusionsResult describeExclusions(DescribeExclusionsRequest request)
AmazonInspector
Describes the exclusions that are specified by the exclusions' ARNs.
describeExclusions
in interface AmazonInspector
public DescribeFindingsResult describeFindings(DescribeFindingsRequest request)
AmazonInspector
Describes the findings that are specified by the ARNs of the findings.
describeFindings
in interface AmazonInspector
public DescribeResourceGroupsResult describeResourceGroups(DescribeResourceGroupsRequest request)
AmazonInspector
Describes the resource groups that are specified by the ARNs of the resource groups.
describeResourceGroups
in interface AmazonInspector
public DescribeRulesPackagesResult describeRulesPackages(DescribeRulesPackagesRequest request)
AmazonInspector
Describes the rules packages that are specified by the ARNs of the rules packages.
describeRulesPackages
in interface AmazonInspector
public GetAssessmentReportResult getAssessmentReport(GetAssessmentReportRequest request)
AmazonInspector
Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
getAssessmentReport
in interface AmazonInspector
public GetExclusionsPreviewResult getExclusionsPreview(GetExclusionsPreviewRequest request)
AmazonInspector
Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.
getExclusionsPreview
in interface AmazonInspector
public GetTelemetryMetadataResult getTelemetryMetadata(GetTelemetryMetadataRequest request)
AmazonInspector
Information about the data that is collected for the specified assessment run.
getTelemetryMetadata
in interface AmazonInspector
public ListAssessmentRunAgentsResult listAssessmentRunAgents(ListAssessmentRunAgentsRequest request)
AmazonInspector
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
listAssessmentRunAgents
in interface AmazonInspector
public ListAssessmentRunsResult listAssessmentRuns(ListAssessmentRunsRequest request)
AmazonInspector
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
listAssessmentRuns
in interface AmazonInspector
public ListAssessmentTargetsResult listAssessmentTargets(ListAssessmentTargetsRequest request)
AmazonInspector
Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.
listAssessmentTargets
in interface AmazonInspector
public ListAssessmentTemplatesResult listAssessmentTemplates(ListAssessmentTemplatesRequest request)
AmazonInspector
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
listAssessmentTemplates
in interface AmazonInspector
public ListEventSubscriptionsResult listEventSubscriptions(ListEventSubscriptionsRequest request)
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.
listEventSubscriptions
in interface AmazonInspector
public ListExclusionsResult listExclusions(ListExclusionsRequest request)
AmazonInspector
List exclusions that are generated by the assessment run.
listExclusions
in interface AmazonInspector
public ListFindingsResult listFindings(ListFindingsRequest request)
AmazonInspector
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
listFindings
in interface AmazonInspector
public ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest request)
AmazonInspector
Lists all available Amazon Inspector rules packages.
listRulesPackages
in interface AmazonInspector
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonInspector
Lists all tags associated with an assessment template.
listTagsForResource
in interface AmazonInspector
public PreviewAgentsResult previewAgents(PreviewAgentsRequest request)
AmazonInspector
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
previewAgents
in interface AmazonInspector
public RegisterCrossAccountAccessRoleResult registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest request)
AmazonInspector
Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
registerCrossAccountAccessRole
in interface AmazonInspector
public RemoveAttributesFromFindingsResult removeAttributesFromFindings(RemoveAttributesFromFindingsRequest request)
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.
removeAttributesFromFindings
in interface AmazonInspector
public SetTagsForResourceResult setTagsForResource(SetTagsForResourceRequest request)
AmazonInspector
Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
setTagsForResource
in interface AmazonInspector
public StartAssessmentRunResult startAssessmentRun(StartAssessmentRunRequest request)
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.
startAssessmentRun
in interface AmazonInspector
public StopAssessmentRunResult stopAssessmentRun(StopAssessmentRunRequest request)
AmazonInspector
Stops the assessment run that is specified by the ARN of the assessment run.
stopAssessmentRun
in interface AmazonInspector
public SubscribeToEventResult subscribeToEvent(SubscribeToEventRequest request)
AmazonInspector
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
subscribeToEvent
in interface AmazonInspector
public UnsubscribeFromEventResult unsubscribeFromEvent(UnsubscribeFromEventRequest request)
AmazonInspector
Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
unsubscribeFromEvent
in interface AmazonInspector
public UpdateAssessmentTargetResult updateAssessmentTarget(UpdateAssessmentTargetRequest request)
AmazonInspector
Updates the assessment target that is specified by the ARN of the assessment target.
If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.
updateAssessmentTarget
in interface AmazonInspector
public void shutdown()
AmazonInspector
shutdown
in interface AmazonInspector
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonInspector
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.
getCachedResponseMetadata
in interface AmazonInspector
request
- The originally executed request.