@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonInspectorClient extends AmazonWebServiceClient implements AmazonInspector
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonInspectorClient()
Deprecated.
|
AmazonInspectorClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonInspectorClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonInspectorClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonInspectorClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| 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.
|
static AmazonInspectorClientBuilder |
builder() |
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.
|
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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AmazonInspectorClient()
AmazonInspectorClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonInspectorClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonInspectorClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonInspectorClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonInspectorClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy
settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonInspectorClientBuilder builder()
public AddAttributesToFindingsResult addAttributesToFindings(AddAttributesToFindingsRequest request)
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
addAttributesToFindings in interface AmazonInspectoraddAttributesToFindingsRequest - 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);public CreateAssessmentTargetResult createAssessmentTarget(CreateAssessmentTargetRequest request)
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 AmazonInspectorcreateAssessmentTargetRequest - 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);public CreateAssessmentTemplateResult createAssessmentTemplate(CreateAssessmentTemplateRequest request)
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 AmazonInspectorcreateAssessmentTemplateRequest - 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);public CreateExclusionsPreviewResult createExclusionsPreview(CreateExclusionsPreviewRequest request)
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 AmazonInspectorcreateExclusionsPreviewRequest - 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.public 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. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.
createResourceGroup in interface AmazonInspectorcreateResourceGroupRequest - 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);public DeleteAssessmentRunResult deleteAssessmentRun(DeleteAssessmentRunRequest request)
Deletes the assessment run that is specified by the ARN of the assessment run.
deleteAssessmentRun in interface AmazonInspectordeleteAssessmentRunRequest - 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);public DeleteAssessmentTargetResult deleteAssessmentTarget(DeleteAssessmentTargetRequest request)
Deletes the assessment target that is specified by the ARN of the assessment target.
deleteAssessmentTarget in interface AmazonInspectordeleteAssessmentTargetRequest - 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);public DeleteAssessmentTemplateResult deleteAssessmentTemplate(DeleteAssessmentTemplateRequest request)
Deletes the assessment template that is specified by the ARN of the assessment template.
deleteAssessmentTemplate in interface AmazonInspectordeleteAssessmentTemplateRequest - 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);public DescribeAssessmentRunsResult describeAssessmentRuns(DescribeAssessmentRunsRequest request)
Describes the assessment runs that are specified by the ARNs of the assessment runs.
describeAssessmentRuns in interface AmazonInspectordescribeAssessmentRunsRequest - 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);public DescribeAssessmentTargetsResult describeAssessmentTargets(DescribeAssessmentTargetsRequest request)
Describes the assessment targets that are specified by the ARNs of the assessment targets.
describeAssessmentTargets in interface AmazonInspectordescribeAssessmentTargetsRequest - 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);public DescribeAssessmentTemplatesResult describeAssessmentTemplates(DescribeAssessmentTemplatesRequest request)
Describes the assessment templates that are specified by the ARNs of the assessment templates.
describeAssessmentTemplates in interface AmazonInspectordescribeAssessmentTemplatesRequest - 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);public DescribeCrossAccountAccessRoleResult describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest request)
Describes the IAM role that enables Amazon Inspector to access your AWS account.
describeCrossAccountAccessRole in interface AmazonInspectordescribeCrossAccountAccessRoleRequest - InternalException - Internal server error.AmazonInspector client = AmazonInspectorClientBuilder.standard().build(); DescribeCrossAccountAccessRoleRequest request = new DescribeCrossAccountAccessRoleRequest(); DescribeCrossAccountAccessRoleResult response = client.describeCrossAccountAccessRole(request);
public DescribeExclusionsResult describeExclusions(DescribeExclusionsRequest request)
Describes the exclusions that are specified by the exclusions' ARNs.
describeExclusions in interface AmazonInspectordescribeExclusionsRequest - InternalException - Internal server error.InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.public DescribeFindingsResult describeFindings(DescribeFindingsRequest request)
Describes the findings that are specified by the ARNs of the findings.
describeFindings in interface AmazonInspectordescribeFindingsRequest - 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);public DescribeResourceGroupsResult describeResourceGroups(DescribeResourceGroupsRequest request)
Describes the resource groups that are specified by the ARNs of the resource groups.
describeResourceGroups in interface AmazonInspectordescribeResourceGroupsRequest - 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);public DescribeRulesPackagesResult describeRulesPackages(DescribeRulesPackagesRequest request)
Describes the rules packages that are specified by the ARNs of the rules packages.
describeRulesPackages in interface AmazonInspectordescribeRulesPackagesRequest - 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);public GetAssessmentReportResult getAssessmentReport(GetAssessmentReportRequest request)
Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
getAssessmentReport in interface AmazonInspectorgetAssessmentReportRequest - 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.public GetExclusionsPreviewResult getExclusionsPreview(GetExclusionsPreviewRequest request)
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 AmazonInspectorgetExclusionsPreviewRequest - 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.public GetTelemetryMetadataResult getTelemetryMetadata(GetTelemetryMetadataRequest request)
Information about the data that is collected for the specified assessment run.
getTelemetryMetadata in interface AmazonInspectorgetTelemetryMetadataRequest - 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);public ListAssessmentRunAgentsResult listAssessmentRunAgents(ListAssessmentRunAgentsRequest request)
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
listAssessmentRunAgents in interface AmazonInspectorlistAssessmentRunAgentsRequest - 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);public ListAssessmentRunsResult listAssessmentRuns(ListAssessmentRunsRequest request)
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
listAssessmentRuns in interface AmazonInspectorlistAssessmentRunsRequest - 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);public ListAssessmentTargetsResult listAssessmentTargets(ListAssessmentTargetsRequest request)
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 AmazonInspectorlistAssessmentTargetsRequest - 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);
public ListAssessmentTemplatesResult listAssessmentTemplates(ListAssessmentTemplatesRequest request)
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
listAssessmentTemplates in interface AmazonInspectorlistAssessmentTemplatesRequest - 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);public ListEventSubscriptionsResult listEventSubscriptions(ListEventSubscriptionsRequest request)
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 AmazonInspectorlistEventSubscriptionsRequest - 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);public ListExclusionsResult listExclusions(ListExclusionsRequest request)
List exclusions that are generated by the assessment run.
listExclusions in interface AmazonInspectorlistExclusionsRequest - 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.public ListFindingsResult listFindings(ListFindingsRequest request)
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
listFindings in interface AmazonInspectorlistFindingsRequest - 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);public ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest request)
Lists all available Amazon Inspector rules packages.
listRulesPackages in interface AmazonInspectorlistRulesPackagesRequest - 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);
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all tags associated with an assessment template.
listTagsForResource in interface AmazonInspectorlistTagsForResourceRequest - 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);public PreviewAgentsResult previewAgents(PreviewAgentsRequest request)
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
previewAgents in interface AmazonInspectorpreviewAgentsRequest - 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);public RegisterCrossAccountAccessRoleResult registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest request)
Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
registerCrossAccountAccessRole in interface AmazonInspectorregisterCrossAccountAccessRoleRequest - 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);public 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.
removeAttributesFromFindings in interface AmazonInspectorremoveAttributesFromFindingsRequest - 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);public SetTagsForResourceResult setTagsForResource(SetTagsForResourceRequest request)
Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
setTagsForResource in interface AmazonInspectorsetTagsForResourceRequest - 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);public StartAssessmentRunResult startAssessmentRun(StartAssessmentRunRequest request)
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 AmazonInspectorstartAssessmentRunRequest - 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);public StopAssessmentRunResult stopAssessmentRun(StopAssessmentRunRequest request)
Stops the assessment run that is specified by the ARN of the assessment run.
stopAssessmentRun in interface AmazonInspectorstopAssessmentRunRequest - 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);public SubscribeToEventResult subscribeToEvent(SubscribeToEventRequest request)
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
subscribeToEvent in interface AmazonInspectorsubscribeToEventRequest - 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);public UnsubscribeFromEventResult unsubscribeFromEvent(UnsubscribeFromEventRequest request)
Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
unsubscribeFromEvent in interface AmazonInspectorunsubscribeFromEventRequest - 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);public UpdateAssessmentTargetResult updateAssessmentTarget(UpdateAssessmentTargetRequest request)
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 AmazonInspectorupdateAssessmentTargetRequest - 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);public 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 the request.
getCachedResponseMetadata in interface AmazonInspectorrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonInspectorshutdown in class AmazonWebServiceClient