AmazonInspector (AWS SDK for Java

All Known Subinterfaces:

AmazonInspectorAsync

All Known Implementing Classes:

AbstractAmazonInspector, AbstractAmazonInspectorAsync, AmazonInspectorAsyncClient, AmazonInspectorClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonInspector
```
Interface for accessing Amazon Inspector.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonInspector instead.

Amazon Inspector
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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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.
`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.
`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.
`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.
`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 Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.
`RemoveAttributesFromFindingsResult`	`removeAttributesFromFindings(RemoveAttributesFromFindingsRequest 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.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("https://inspector.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "inspector.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://inspector.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    endpoint - The endpoint (ex: "inspector.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://inspector.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to 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.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addAttributesToFindings
```
AddAttributesToFindingsResult addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)
```
    Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
    
    Parameters:
    
    addAttributesToFindingsRequest -
    
    Returns:
    
    Result of the AddAttributesToFindings operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createAssessmentTarget
```
CreateAssessmentTargetResult createAssessmentTarget(CreateAssessmentTargetRequest createAssessmentTargetRequest)
```
    Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets.
    
    Parameters:
    
    createAssessmentTargetRequest -
    
    Returns:
    
    Result of the CreateAssessmentTarget operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createAssessmentTemplate
```
CreateAssessmentTemplateResult createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest)
```
    Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
    
    Parameters:
    
    createAssessmentTemplateRequest -
    
    Returns:
    
    Result of the CreateAssessmentTemplate operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createResourceGroup
```
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.
    
    Parameters:
    
    createResourceGroupRequest -
    
    Returns:
    
    Result of the CreateResourceGroup operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteAssessmentRun
```
DeleteAssessmentRunResult deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest)
```
    Deletes the assessment run that is specified by the ARN of the assessment run.
    
    Parameters:
    
    deleteAssessmentRunRequest -
    
    Returns:
    
    Result of the DeleteAssessmentRun operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteAssessmentTarget
```
DeleteAssessmentTargetResult deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest)
```
    Deletes the assessment target that is specified by the ARN of the assessment target.
    
    Parameters:
    
    deleteAssessmentTargetRequest -
    
    Returns:
    
    Result of the DeleteAssessmentTarget operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteAssessmentTemplate
```
DeleteAssessmentTemplateResult deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest)
```
    Deletes the assessment template that is specified by the ARN of the assessment template.
    
    Parameters:
    
    deleteAssessmentTemplateRequest -
    
    Returns:
    
    Result of the DeleteAssessmentTemplate operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeAssessmentRuns
```
DescribeAssessmentRunsResult describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest)
```
    Describes the assessment runs that are specified by the ARNs of the assessment runs.
    
    Parameters:
    
    describeAssessmentRunsRequest -
    
    Returns:
    
    Result of the DescribeAssessmentRuns operation returned by the service.
    
    Throws:
    
    InternalException - Internal server error.
    
    InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
    
    See Also:
    
    AWS API Documentation
  - describeAssessmentTargets
```
DescribeAssessmentTargetsResult describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest)
```
    Describes the assessment targets that are specified by the ARNs of the assessment targets.
    
    Parameters:
    
    describeAssessmentTargetsRequest -
    
    Returns:
    
    Result of the DescribeAssessmentTargets operation returned by the service.
    
    Throws:
    
    InternalException - Internal server error.
    
    InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
    
    See Also:
    
    AWS API Documentation
  - describeAssessmentTemplates
```
DescribeAssessmentTemplatesResult describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest)
```
    Describes the assessment templates that are specified by the ARNs of the assessment templates.
    
    Parameters:
    
    describeAssessmentTemplatesRequest -
    
    Returns:
    
    Result of the DescribeAssessmentTemplates operation returned by the service.
    
    Throws:
    
    InternalException - Internal server error.
    
    InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
    
    See Also:
    
    AWS API Documentation
  - describeCrossAccountAccessRole
```
DescribeCrossAccountAccessRoleResult describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)
```
    Describes the IAM role that enables Amazon Inspector to access your AWS account.
    
    Parameters:
    
    describeCrossAccountAccessRoleRequest -
    
    Returns:
    
    Result of the DescribeCrossAccountAccessRole operation returned by the service.
    
    Throws:
    
    InternalException - Internal server error.
    
    See Also:
    
    AWS API Documentation
  - describeFindings
```
DescribeFindingsResult describeFindings(DescribeFindingsRequest describeFindingsRequest)
```
    Describes the findings that are specified by the ARNs of the findings.
    
    Parameters:
    
    describeFindingsRequest -
    
    Returns:
    
    Result of the DescribeFindings operation returned by the service.
    
    Throws:
    
    InternalException - Internal server error.
    
    InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
    
    See Also:
    
    AWS API Documentation
  - describeResourceGroups
```
DescribeResourceGroupsResult describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest)
```
    Describes the resource groups that are specified by the ARNs of the resource groups.
    
    Parameters:
    
    describeResourceGroupsRequest -
    
    Returns:
    
    Result of the DescribeResourceGroups operation returned by the service.
    
    Throws:
    
    InternalException - Internal server error.
    
    InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
    
    See Also:
    
    AWS API Documentation
  - describeRulesPackages
```
DescribeRulesPackagesResult describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest)
```
    Describes the rules packages that are specified by the ARNs of the rules packages.
    
    Parameters:
    
    describeRulesPackagesRequest -
    
    Returns:
    
    Result of the DescribeRulesPackages operation returned by the service.
    
    Throws:
    
    InternalException - Internal server error.
    
    InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
    
    See Also:
    
    AWS API Documentation
  - getAssessmentReport
```
GetAssessmentReportResult getAssessmentReport(GetAssessmentReportRequest getAssessmentReportRequest)
```
    Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
    
    Parameters:
    
    getAssessmentReportRequest -
    
    Returns:
    
    Result of the GetAssessmentReport operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getTelemetryMetadata
```
GetTelemetryMetadataResult getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest)
```
    Information about the data that is collected for the specified assessment run.
    
    Parameters:
    
    getTelemetryMetadataRequest -
    
    Returns:
    
    Result of the GetTelemetryMetadata operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listAssessmentRunAgents
```
ListAssessmentRunAgentsResult listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest)
```
    Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
    
    Parameters:
    
    listAssessmentRunAgentsRequest -
    
    Returns:
    
    Result of the ListAssessmentRunAgents operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listAssessmentRuns
```
ListAssessmentRunsResult listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest)
```
    Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
    
    Parameters:
    
    listAssessmentRunsRequest -
    
    Returns:
    
    Result of the ListAssessmentRuns operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listAssessmentTargets
```
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.
    
    Parameters:
    
    listAssessmentTargetsRequest -
    
    Returns:
    
    Result of the ListAssessmentTargets operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listAssessmentTemplates
```
ListAssessmentTemplatesResult listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest)
```
    Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
    
    Parameters:
    
    listAssessmentTemplatesRequest -
    
    Returns:
    
    Result of the ListAssessmentTemplates operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEventSubscriptions
```
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.
    
    Parameters:
    
    listEventSubscriptionsRequest -
    
    Returns:
    
    Result of the ListEventSubscriptions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listFindings
```
ListFindingsResult listFindings(ListFindingsRequest listFindingsRequest)
```
    Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
    
    Parameters:
    
    listFindingsRequest -
    
    Returns:
    
    Result of the ListFindings operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listRulesPackages
```
ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)
```
    Lists all available Amazon Inspector rules packages.
    
    Parameters:
    
    listRulesPackagesRequest -
    
    Returns:
    
    Result of the ListRulesPackages operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists all tags associated with an assessment template.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - previewAgents
```
PreviewAgentsResult previewAgents(PreviewAgentsRequest previewAgentsRequest)
```
    Previews the agents installed on the EC2 instances that are part of the specified assessment target.
    
    Parameters:
    
    previewAgentsRequest -
    
    Returns:
    
    Result of the PreviewAgents operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - registerCrossAccountAccessRole
```
RegisterCrossAccountAccessRoleResult registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest)
```
    Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.
    
    Parameters:
    
    registerCrossAccountAccessRoleRequest -
    
    Returns:
    
    Result of the RegisterCrossAccountAccessRole operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - removeAttributesFromFindings
```
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.
    
    Parameters:
    
    removeAttributesFromFindingsRequest -
    
    Returns:
    
    Result of the RemoveAttributesFromFindings operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - setTagsForResource
```
SetTagsForResourceResult setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)
```
    Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
    
    Parameters:
    
    setTagsForResourceRequest -
    
    Returns:
    
    Result of the SetTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startAssessmentRun
```
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.
    
    Parameters:
    
    startAssessmentRunRequest -
    
    Returns:
    
    Result of the StartAssessmentRun operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - stopAssessmentRun
```
StopAssessmentRunResult stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest)
```
    Stops the assessment run that is specified by the ARN of the assessment run.
    
    Parameters:
    
    stopAssessmentRunRequest -
    
    Returns:
    
    Result of the StopAssessmentRun operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - subscribeToEvent
```
SubscribeToEventResult subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest)
```
    Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
    
    Parameters:
    
    subscribeToEventRequest -
    
    Returns:
    
    Result of the SubscribeToEvent operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - unsubscribeFromEvent
```
UnsubscribeFromEventResult unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest)
```
    Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
    
    Parameters:
    
    unsubscribeFromEventRequest -
    
    Returns:
    
    Result of the UnsubscribeFromEvent operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateAssessmentTarget
```
UpdateAssessmentTargetResult updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest)
```
    Updates the assessment target that is specified by the ARN of the assessment target.
    
    Parameters:
    
    updateAssessmentTargetRequest -
    
    Returns:
    
    Result of the UpdateAssessmentTarget operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonInspector

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

addAttributesToFindings

createAssessmentTarget

createAssessmentTemplate

createResourceGroup

deleteAssessmentRun

deleteAssessmentTarget

deleteAssessmentTemplate

describeAssessmentRuns

describeAssessmentTargets

describeAssessmentTemplates

describeCrossAccountAccessRole

describeFindings

describeResourceGroups

describeRulesPackages

getAssessmentReport

getTelemetryMetadata

listAssessmentRunAgents

listAssessmentRuns

listAssessmentTargets

listAssessmentTemplates

listEventSubscriptions

listFindings

listRulesPackages

listTagsForResource

previewAgents

registerCrossAccountAccessRole

removeAttributesFromFindings

setTagsForResource

startAssessmentRun

stopAssessmentRun

subscribeToEvent

unsubscribeFromEvent

updateAssessmentTarget

shutdown

getCachedResponseMetadata