@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonInspector
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonInspector instead.
Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AddAttributesToFindingsResult |
addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
|
CreateAssessmentTargetResult |
createAssessmentTarget(CreateAssessmentTargetRequest createAssessmentTargetRequest)
Creates a new assessment target using the ARN of the resource group that is generated by
CreateResourceGroup.
|
CreateAssessmentTemplateResult |
createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest)
Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
|
CreateExclusionsPreviewResult |
createExclusionsPreview(CreateExclusionsPreviewRequest createExclusionsPreviewRequest)
Starts the generation of an exclusions preview for the specified assessment template.
|
CreateResourceGroupResult |
createResourceGroup(CreateResourceGroupRequest createResourceGroupRequest)
Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2
instances to be included in an Amazon Inspector assessment target.
|
DeleteAssessmentRunResult |
deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest)
Deletes the assessment run that is specified by the ARN of the assessment run.
|
DeleteAssessmentTargetResult |
deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest)
Deletes the assessment target that is specified by the ARN of the assessment target.
|
DeleteAssessmentTemplateResult |
deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest)
Deletes the assessment template that is specified by the ARN of the assessment template.
|
DescribeAssessmentRunsResult |
describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest)
Describes the assessment runs that are specified by the ARNs of the assessment runs.
|
DescribeAssessmentTargetsResult |
describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest)
Describes the assessment targets that are specified by the ARNs of the assessment targets.
|
DescribeAssessmentTemplatesResult |
describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest)
Describes the assessment templates that are specified by the ARNs of the assessment templates.
|
DescribeCrossAccountAccessRoleResult |
describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)
Describes the IAM role that enables Amazon Inspector to access your AWS account.
|
DescribeExclusionsResult |
describeExclusions(DescribeExclusionsRequest describeExclusionsRequest)
Describes the exclusions that are specified by the exclusions' ARNs.
|
DescribeFindingsResult |
describeFindings(DescribeFindingsRequest describeFindingsRequest)
Describes the findings that are specified by the ARNs of the findings.
|
DescribeResourceGroupsResult |
describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest)
Describes the resource groups that are specified by the ARNs of the resource groups.
|
DescribeRulesPackagesResult |
describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest)
Describes the rules packages that are specified by the ARNs of the rules packages.
|
GetAssessmentReportResult |
getAssessmentReport(GetAssessmentReportRequest getAssessmentReportRequest)
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 getExclusionsPreviewRequest)
Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token.
|
GetTelemetryMetadataResult |
getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest)
Information about the data that is collected for the specified assessment run.
|
ListAssessmentRunAgentsResult |
listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest)
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
|
ListAssessmentRunsResult |
listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest)
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the
assessment templates.
|
ListAssessmentTargetsResult |
listAssessmentTargets(ListAssessmentTargetsRequest listAssessmentTargetsRequest)
Lists the ARNs of the assessment targets within this AWS account.
|
ListAssessmentTemplatesResult |
listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest)
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the
assessment targets.
|
ListEventSubscriptionsResult |
listEventSubscriptions(ListEventSubscriptionsRequest listEventSubscriptionsRequest)
Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment
template.
|
ListExclusionsResult |
listExclusions(ListExclusionsRequest listExclusionsRequest)
List exclusions that are generated by the assessment run.
|
ListFindingsResult |
listFindings(ListFindingsRequest listFindingsRequest)
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
|
ListRulesPackagesResult |
listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)
Lists all available Amazon Inspector rules packages.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with an assessment template.
|
PreviewAgentsResult |
previewAgents(PreviewAgentsRequest previewAgentsRequest)
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
|
RegisterCrossAccountAccessRoleResult |
registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest)
Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security
assessments.
|
RemoveAttributesFromFindingsResult |
removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest)
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)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
SetTagsForResourceResult |
setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)
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 startAssessmentRunRequest)
Starts the assessment run specified by the ARN of the assessment template.
|
StopAssessmentRunResult |
stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest)
Stops the assessment run that is specified by the ARN of the assessment run.
|
SubscribeToEventResult |
subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest)
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to
a specified SNS topic.
|
UnsubscribeFromEventResult |
unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest)
Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to
a specified SNS topic.
|
UpdateAssessmentTargetResult |
updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest)
Updates the assessment target that is specified by the ARN of the assessment target.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
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)AddAttributesToFindingsResult addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
addAttributesToFindingsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
AddAttributesToFindingsRequest request = new AddAttributesToFindingsRequest().withFindingArns(
"arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU").withAttributes(
new Attribute().withKey("Example").withValue("example"));
AddAttributesToFindingsResult response = client.addAttributesToFindings(request);CreateAssessmentTargetResult createAssessmentTarget(CreateAssessmentTargetRequest createAssessmentTargetRequest)
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.
createAssessmentTargetRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error code describes the limit exceeded.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.InvalidCrossAccountRoleException - Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the
assessment run.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
CreateAssessmentTargetRequest request = new CreateAssessmentTargetRequest().withAssessmentTargetName("ExampleAssessmentTarget").withResourceGroupArn(
"arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv");
CreateAssessmentTargetResult response = client.createAssessmentTarget(request);CreateAssessmentTemplateResult createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest)
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.
createAssessmentTemplateRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error code describes the limit exceeded.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
CreateAssessmentTemplateRequest request = new CreateAssessmentTemplateRequest()
.withAssessmentTargetArn("arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX").withAssessmentTemplateName("ExampleAssessmentTemplate")
.withDurationInSeconds(180).withRulesPackageArns("arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp")
.withUserAttributesForFindings(new Attribute().withKey("Example").withValue("example"));
CreateAssessmentTemplateResult response = client.createAssessmentTemplate(request);CreateExclusionsPreviewResult createExclusionsPreview(CreateExclusionsPreviewRequest createExclusionsPreviewRequest)
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.
createExclusionsPreviewRequest - InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.PreviewGenerationInProgressException - The request is rejected. The specified assessment template is currently generating an exclusions preview.InternalException - Internal server error.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.CreateResourceGroupResult createResourceGroup(CreateResourceGroupRequest createResourceGroupRequest)
Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.
createResourceGroupRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error code describes the limit exceeded.AccessDeniedException - You do not have required permissions to access the requested resource.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
CreateResourceGroupRequest request = new CreateResourceGroupRequest()
.withResourceGroupTags(new ResourceGroupTag().withKey("Name").withValue("example"));
CreateResourceGroupResult response = client.createResourceGroup(request);DeleteAssessmentRunResult deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest)
Deletes the assessment run that is specified by the ARN of the assessment run.
deleteAssessmentRunRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AssessmentRunInProgressException - You cannot perform a specified action if an assessment run is currently in progress.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
DeleteAssessmentRunRequest request = new DeleteAssessmentRunRequest()
.withAssessmentRunArn("arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe");
DeleteAssessmentRunResult response = client.deleteAssessmentRun(request);DeleteAssessmentTargetResult deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest)
Deletes the assessment target that is specified by the ARN of the assessment target.
deleteAssessmentTargetRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AssessmentRunInProgressException - You cannot perform a specified action if an assessment run is currently in progress.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
DeleteAssessmentTargetRequest request = new DeleteAssessmentTargetRequest()
.withAssessmentTargetArn("arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq");
DeleteAssessmentTargetResult response = client.deleteAssessmentTarget(request);DeleteAssessmentTemplateResult deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest)
Deletes the assessment template that is specified by the ARN of the assessment template.
deleteAssessmentTemplateRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AssessmentRunInProgressException - You cannot perform a specified action if an assessment run is currently in progress.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
DeleteAssessmentTemplateRequest request = new DeleteAssessmentTemplateRequest()
.withAssessmentTemplateArn("arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T");
DeleteAssessmentTemplateResult response = client.deleteAssessmentTemplate(request);DescribeAssessmentRunsResult describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest)
Describes the assessment runs that are specified by the ARNs of the assessment runs.
describeAssessmentRunsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
DescribeAssessmentRunsRequest request = new DescribeAssessmentRunsRequest()
.withAssessmentRunArns("arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE");
DescribeAssessmentRunsResult response = client.describeAssessmentRuns(request);DescribeAssessmentTargetsResult describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest)
Describes the assessment targets that are specified by the ARNs of the assessment targets.
describeAssessmentTargetsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
DescribeAssessmentTargetsRequest request = new DescribeAssessmentTargetsRequest()
.withAssessmentTargetArns("arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq");
DescribeAssessmentTargetsResult response = client.describeAssessmentTargets(request);DescribeAssessmentTemplatesResult describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest)
Describes the assessment templates that are specified by the ARNs of the assessment templates.
describeAssessmentTemplatesRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
DescribeAssessmentTemplatesRequest request = new DescribeAssessmentTemplatesRequest()
.withAssessmentTemplateArns("arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw");
DescribeAssessmentTemplatesResult response = client.describeAssessmentTemplates(request);DescribeCrossAccountAccessRoleResult describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)
Describes the IAM role that enables Amazon Inspector to access your AWS account.
describeCrossAccountAccessRoleRequest - InternalException - Internal server error.AmazonInspector client = AmazonInspectorClientBuilder.standard().build(); DescribeCrossAccountAccessRoleRequest request = new DescribeCrossAccountAccessRoleRequest(); DescribeCrossAccountAccessRoleResult response = client.describeCrossAccountAccessRole(request);
DescribeExclusionsResult describeExclusions(DescribeExclusionsRequest describeExclusionsRequest)
Describes the exclusions that are specified by the exclusions' ARNs.
describeExclusionsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.DescribeFindingsResult describeFindings(DescribeFindingsRequest describeFindingsRequest)
Describes the findings that are specified by the ARNs of the findings.
describeFindingsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
DescribeFindingsRequest request = new DescribeFindingsRequest()
.withFindingArns("arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4");
DescribeFindingsResult response = client.describeFindings(request);DescribeResourceGroupsResult describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest)
Describes the resource groups that are specified by the ARNs of the resource groups.
describeResourceGroupsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
DescribeResourceGroupsRequest request = new DescribeResourceGroupsRequest()
.withResourceGroupArns("arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI");
DescribeResourceGroupsResult response = client.describeResourceGroups(request);DescribeRulesPackagesResult describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest)
Describes the rules packages that are specified by the ARNs of the rules packages.
describeRulesPackagesRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
DescribeRulesPackagesRequest request = new DescribeRulesPackagesRequest()
.withRulesPackageArns("arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ");
DescribeRulesPackagesResult response = client.describeRulesPackages(request);GetAssessmentReportResult getAssessmentReport(GetAssessmentReportRequest getAssessmentReportRequest)
Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
getAssessmentReportRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.AssessmentRunInProgressException - You cannot perform a specified action if an assessment run is currently in progress.UnsupportedFeatureException - Used by the GetAssessmentReport API. The request was rejected because you tried to generate a
report for an assessment run that existed before reporting was supported in Amazon Inspector. You can
only generate reports for assessment runs that took place or will take place after generating reports in
Amazon Inspector became available.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.GetExclusionsPreviewResult getExclusionsPreview(GetExclusionsPreviewRequest getExclusionsPreviewRequest)
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.
getExclusionsPreviewRequest - InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.InternalException - Internal server error.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.GetTelemetryMetadataResult getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest)
Information about the data that is collected for the specified assessment run.
getTelemetryMetadataRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
GetTelemetryMetadataRequest request = new GetTelemetryMetadataRequest()
.withAssessmentRunArn("arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE");
GetTelemetryMetadataResult response = client.getTelemetryMetadata(request);ListAssessmentRunAgentsResult listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest)
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
listAssessmentRunAgentsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
ListAssessmentRunAgentsRequest request = new ListAssessmentRunAgentsRequest().withAssessmentRunArn(
"arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE").withMaxResults(123);
ListAssessmentRunAgentsResult response = client.listAssessmentRunAgents(request);ListAssessmentRunsResult listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest)
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
listAssessmentRunsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
ListAssessmentRunsRequest request = new ListAssessmentRunsRequest().withAssessmentTemplateArns(
"arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw").withMaxResults(123);
ListAssessmentRunsResult response = client.listAssessmentRuns(request);ListAssessmentTargetsResult listAssessmentTargets(ListAssessmentTargetsRequest listAssessmentTargetsRequest)
Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.
listAssessmentTargetsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.AmazonInspector client = AmazonInspectorClientBuilder.standard().build(); ListAssessmentTargetsRequest request = new ListAssessmentTargetsRequest().withMaxResults(123); ListAssessmentTargetsResult response = client.listAssessmentTargets(request);
ListAssessmentTemplatesResult listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest)
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
listAssessmentTemplatesRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
ListAssessmentTemplatesRequest request = new ListAssessmentTemplatesRequest().withAssessmentTargetArns(
"arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq").withMaxResults(123);
ListAssessmentTemplatesResult response = client.listAssessmentTemplates(request);ListEventSubscriptionsResult listEventSubscriptions(ListEventSubscriptionsRequest listEventSubscriptionsRequest)
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.
listEventSubscriptionsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
ListEventSubscriptionsRequest request = new ListEventSubscriptionsRequest().withResourceArn(
"arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0").withMaxResults(123);
ListEventSubscriptionsResult response = client.listEventSubscriptions(request);ListExclusionsResult listExclusions(ListExclusionsRequest listExclusionsRequest)
List exclusions that are generated by the assessment run.
listExclusionsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ListFindingsResult listFindings(ListFindingsRequest listFindingsRequest)
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
listFindingsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
ListFindingsRequest request = new ListFindingsRequest().withAssessmentRunArns(
"arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE").withMaxResults(123);
ListFindingsResult response = client.listFindings(request);ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)
Lists all available Amazon Inspector rules packages.
listRulesPackagesRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.AmazonInspector client = AmazonInspectorClientBuilder.standard().build(); ListRulesPackagesRequest request = new ListRulesPackagesRequest().withMaxResults(123); ListRulesPackagesResult response = client.listRulesPackages(request);
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with an assessment template.
listTagsForResourceRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
ListTagsForResourceRequest request = new ListTagsForResourceRequest()
.withResourceArn("arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu");
ListTagsForResourceResult response = client.listTagsForResource(request);PreviewAgentsResult previewAgents(PreviewAgentsRequest previewAgentsRequest)
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
previewAgentsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.InvalidCrossAccountRoleException - Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the
assessment run.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
PreviewAgentsRequest request = new PreviewAgentsRequest().withPreviewAgentsArn("arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq")
.withMaxResults(123);
PreviewAgentsResult response = client.previewAgents(request);RegisterCrossAccountAccessRoleResult registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest)
Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
registerCrossAccountAccessRoleRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.InvalidCrossAccountRoleException - Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the
assessment run.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
RegisterCrossAccountAccessRoleRequest request = new RegisterCrossAccountAccessRoleRequest().withRoleArn("arn:aws:iam::123456789012:role/inspector");
RegisterCrossAccountAccessRoleResult response = client.registerCrossAccountAccessRole(request);RemoveAttributesFromFindingsResult removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest)
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.
removeAttributesFromFindingsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
RemoveAttributesFromFindingsRequest request = new RemoveAttributesFromFindingsRequest().withFindingArns(
"arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU").withAttributeKeys(
"key=Example,value=example");
RemoveAttributesFromFindingsResult response = client.removeAttributesFromFindings(request);SetTagsForResourceResult setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)
Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
setTagsForResourceRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
SetTagsForResourceRequest request = new SetTagsForResourceRequest().withResourceArn(
"arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0").withTags(new Tag().withKey("Example").withValue("example"));
SetTagsForResourceResult response = client.setTagsForResource(request);StartAssessmentRunResult startAssessmentRun(StartAssessmentRunRequest startAssessmentRunRequest)
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.
startAssessmentRunRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error code describes the limit exceeded.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.InvalidCrossAccountRoleException - Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the
assessment run.AgentsAlreadyRunningAssessmentException - You started an assessment run, but one of the instances is already participating in another assessment
run.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
StartAssessmentRunRequest request = new StartAssessmentRunRequest().withAssessmentTemplateArn(
"arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T").withAssessmentRunName("examplerun");
StartAssessmentRunResult response = client.startAssessmentRun(request);StopAssessmentRunResult stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest)
Stops the assessment run that is specified by the ARN of the assessment run.
stopAssessmentRunRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
StopAssessmentRunRequest request = new StopAssessmentRunRequest()
.withAssessmentRunArn("arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe");
StopAssessmentRunResult response = client.stopAssessmentRun(request);SubscribeToEventResult subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest)
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
subscribeToEventRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits.
The error code describes the limit exceeded.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
SubscribeToEventRequest request = new SubscribeToEventRequest()
.withResourceArn("arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0").withEvent("ASSESSMENT_RUN_COMPLETED")
.withTopicArn("arn:aws:sns:us-west-2:123456789012:exampletopic");
SubscribeToEventResult response = client.subscribeToEvent(request);UnsubscribeFromEventResult unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest)
Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
unsubscribeFromEventRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
UnsubscribeFromEventRequest request = new UnsubscribeFromEventRequest()
.withResourceArn("arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0").withEvent("ASSESSMENT_RUN_COMPLETED")
.withTopicArn("arn:aws:sns:us-west-2:123456789012:exampletopic");
UnsubscribeFromEventResult response = client.unsubscribeFromEvent(request);UpdateAssessmentTargetResult updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest)
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.
updateAssessmentTargetRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.AccessDeniedException - You do not have required permissions to access the requested resource.NoSuchEntityException - The request was rejected because it referenced an entity that does not exist. The error code describes
the entity.ServiceTemporarilyUnavailableException - The serice is temporary unavailable.AmazonInspector client = AmazonInspectorClientBuilder.standard().build();
UpdateAssessmentTargetRequest request = new UpdateAssessmentTargetRequest()
.withAssessmentTargetArn("arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX").withAssessmentTargetName("Example")
.withResourceGroupArn("arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-yNbgL5Pt");
UpdateAssessmentTargetResult response = client.updateAssessmentTarget(request);void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.