Package software.amazon.awssdk.services.inspector

Interface InspectorClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface InspectorClient
extends AutoCloseable

Service client for accessing null. This can be created using the static builder() method. 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	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AddAttributesToFindingsResponse	addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)	Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
static InspectorClientBuilder	builder()	Create a builder that can be used to configure and create a InspectorClient.
static InspectorClient	create()	Create a InspectorClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAssessmentTargetResponse	createAssessmentTarget(CreateAssessmentTargetRequest createAssessmentTargetRequest)	Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup.
default CreateAssessmentTemplateResponse	createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest)	Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
default CreateResourceGroupResponse	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.
default DeleteAssessmentRunResponse	deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest)	Deletes the assessment run that is specified by the ARN of the assessment run.
default DeleteAssessmentTargetResponse	deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest)	Deletes the assessment target that is specified by the ARN of the assessment target.
default DeleteAssessmentTemplateResponse	deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest)	Deletes the assessment template that is specified by the ARN of the assessment template.
default DescribeAssessmentRunsResponse	describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest)	Describes the assessment runs that are specified by the ARNs of the assessment runs.
default DescribeAssessmentTargetsResponse	describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest)	Describes the assessment targets that are specified by the ARNs of the assessment targets.
default DescribeAssessmentTemplatesResponse	describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest)	Describes the assessment templates that are specified by the ARNs of the assessment templates.
default DescribeCrossAccountAccessRoleResponse	describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)	Describes the IAM role that enables Amazon Inspector to access your AWS account.
default DescribeFindingsResponse	describeFindings(DescribeFindingsRequest describeFindingsRequest)	Describes the findings that are specified by the ARNs of the findings.
default DescribeResourceGroupsResponse	describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest)	Describes the resource groups that are specified by the ARNs of the resource groups.
default DescribeRulesPackagesResponse	describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest)	Describes the rules packages that are specified by the ARNs of the rules packages.
default GetAssessmentReportResponse	getAssessmentReport(GetAssessmentReportRequest getAssessmentReportRequest)	Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
default GetTelemetryMetadataResponse	getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest)	Information about the data that is collected for the specified assessment run.
default ListAssessmentRunAgentsResponse	listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest)	Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
default ListAssessmentRunsResponse	listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest)	Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
default ListAssessmentTargetsResponse	listAssessmentTargets(ListAssessmentTargetsRequest listAssessmentTargetsRequest)	Lists the ARNs of the assessment targets within this AWS account.
default ListAssessmentTemplatesResponse	listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest)	Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
default ListEventSubscriptionsResponse	listEventSubscriptions(ListEventSubscriptionsRequest listEventSubscriptionsRequest)	Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template.
default ListFindingsResponse	listFindings(ListFindingsRequest listFindingsRequest)	Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
default ListRulesPackagesResponse	listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)	Lists all available Amazon Inspector rules packages.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags associated with an assessment template.
default PreviewAgentsResponse	previewAgents(PreviewAgentsRequest previewAgentsRequest)	Previews the agents installed on the EC2 instances that are part of the specified assessment target.
default RegisterCrossAccountAccessRoleResponse	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.
default RemoveAttributesFromFindingsResponse	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.
static ServiceMetadata	serviceMetadata()
default SetTagsForResourceResponse	setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)	Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
default StartAssessmentRunResponse	startAssessmentRun(StartAssessmentRunRequest startAssessmentRunRequest)	Starts the assessment run specified by the ARN of the assessment template.
default StopAssessmentRunResponse	stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest)	Stops the assessment run that is specified by the ARN of the assessment run.
default SubscribeToEventResponse	subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest)	Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
default UnsubscribeFromEventResponse	unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest)	Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
default UpdateAssessmentTargetResponse	updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest)	Updates the assessment target that is specified by the ARN of the assessment target.

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static InspectorClient create()

Create a InspectorClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static InspectorClientBuilder builder()

Create a builder that can be used to configure and create a InspectorClient.

addAttributesToFindings

default AddAttributesToFindingsResponse addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)
                                                         throws InternalException,
                                                                InvalidInputException,
                                                                AccessDeniedException,
                                                                NoSuchEntityException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createAssessmentTarget

default CreateAssessmentTargetResponse createAssessmentTarget(CreateAssessmentTargetRequest createAssessmentTargetRequest)
                                                       throws InternalException,
                                                              InvalidInputException,
                                                              LimitExceededException,
                                                              AccessDeniedException,
                                                              NoSuchEntityException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createAssessmentTemplate

default CreateAssessmentTemplateResponse createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest)
                                                           throws InternalException,
                                                                  InvalidInputException,
                                                                  LimitExceededException,
                                                                  AccessDeniedException,
                                                                  NoSuchEntityException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createResourceGroup

default CreateResourceGroupResponse createResourceGroup(CreateResourceGroupRequest createResourceGroupRequest)
                                                 throws InternalException,
                                                        InvalidInputException,
                                                        LimitExceededException,
                                                        AccessDeniedException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteAssessmentRun

default DeleteAssessmentRunResponse deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest)
                                                 throws InternalException,
                                                        InvalidInputException,
                                                        AssessmentRunInProgressException,
                                                        AccessDeniedException,
                                                        NoSuchEntityException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteAssessmentTarget

default DeleteAssessmentTargetResponse deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest)
                                                       throws InternalException,
                                                              InvalidInputException,
                                                              AssessmentRunInProgressException,
                                                              AccessDeniedException,
                                                              NoSuchEntityException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteAssessmentTemplate

default DeleteAssessmentTemplateResponse deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest)
                                                           throws InternalException,
                                                                  InvalidInputException,
                                                                  AssessmentRunInProgressException,
                                                                  AccessDeniedException,
                                                                  NoSuchEntityException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeAssessmentRuns

default DescribeAssessmentRunsResponse describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest)
                                                       throws InternalException,
                                                              InvalidInputException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeAssessmentTargets

default DescribeAssessmentTargetsResponse describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest)
                                                             throws InternalException,
                                                                    InvalidInputException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeAssessmentTemplates

default DescribeAssessmentTemplatesResponse describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest)
                                                                 throws InternalException,
                                                                        InvalidInputException,
                                                                        SdkBaseException,
                                                                        SdkClientException,
                                                                        InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeCrossAccountAccessRole

default DescribeCrossAccountAccessRoleResponse describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)
                                                                       throws InternalException,
                                                                              SdkBaseException,
                                                                              SdkClientException,
                                                                              InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeFindings

default DescribeFindingsResponse describeFindings(DescribeFindingsRequest describeFindingsRequest)
                                           throws InternalException,
                                                  InvalidInputException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeResourceGroups

default DescribeResourceGroupsResponse describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest)
                                                       throws InternalException,
                                                              InvalidInputException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeRulesPackages

default DescribeRulesPackagesResponse describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest)
                                                     throws InternalException,
                                                            InvalidInputException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getAssessmentReport

default GetAssessmentReportResponse getAssessmentReport(GetAssessmentReportRequest getAssessmentReportRequest)
                                                 throws InternalException,
                                                        InvalidInputException,
                                                        AccessDeniedException,
                                                        NoSuchEntityException,
                                                        AssessmentRunInProgressException,
                                                        UnsupportedFeatureException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getTelemetryMetadata

default GetTelemetryMetadataResponse getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest)
                                                   throws InternalException,
                                                          InvalidInputException,
                                                          AccessDeniedException,
                                                          NoSuchEntityException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listAssessmentRunAgents

default ListAssessmentRunAgentsResponse listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest)
                                                         throws InternalException,
                                                                InvalidInputException,
                                                                AccessDeniedException,
                                                                NoSuchEntityException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listAssessmentRuns

default ListAssessmentRunsResponse listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest)
                                               throws InternalException,
                                                      InvalidInputException,
                                                      AccessDeniedException,
                                                      NoSuchEntityException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listAssessmentTargets

default ListAssessmentTargetsResponse listAssessmentTargets(ListAssessmentTargetsRequest listAssessmentTargetsRequest)
                                                     throws InternalException,
                                                            InvalidInputException,
                                                            AccessDeniedException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listAssessmentTemplates

default ListAssessmentTemplatesResponse listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest)
                                                         throws InternalException,
                                                                InvalidInputException,
                                                                AccessDeniedException,
                                                                NoSuchEntityException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listEventSubscriptions

default ListEventSubscriptionsResponse listEventSubscriptions(ListEventSubscriptionsRequest listEventSubscriptionsRequest)
                                                       throws InternalException,
                                                              InvalidInputException,
                                                              AccessDeniedException,
                                                              NoSuchEntityException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listFindings

default ListFindingsResponse listFindings(ListFindingsRequest listFindingsRequest)
                                   throws InternalException,
                                          InvalidInputException,
                                          AccessDeniedException,
                                          NoSuchEntityException,
                                          SdkBaseException,
                                          SdkClientException,
                                          InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listRulesPackages

default ListRulesPackagesResponse listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)
                                             throws InternalException,
                                                    InvalidInputException,
                                                    AccessDeniedException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalException,
                                                        InvalidInputException,
                                                        AccessDeniedException,
                                                        NoSuchEntityException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

previewAgents

default PreviewAgentsResponse previewAgents(PreviewAgentsRequest previewAgentsRequest)
                                     throws InternalException,
                                            InvalidInputException,
                                            AccessDeniedException,
                                            NoSuchEntityException,
                                            InvalidCrossAccountRoleException,
                                            SdkBaseException,
                                            SdkClientException,
                                            InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

registerCrossAccountAccessRole

default RegisterCrossAccountAccessRoleResponse registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest)
                                                                       throws InternalException,
                                                                              InvalidInputException,
                                                                              AccessDeniedException,
                                                                              InvalidCrossAccountRoleException,
                                                                              SdkBaseException,
                                                                              SdkClientException,
                                                                              InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

removeAttributesFromFindings

default RemoveAttributesFromFindingsResponse removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest)
                                                                   throws InternalException,
                                                                          InvalidInputException,
                                                                          AccessDeniedException,
                                                                          NoSuchEntityException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

setTagsForResource

default SetTagsForResourceResponse setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)
                                               throws InternalException,
                                                      InvalidInputException,
                                                      AccessDeniedException,
                                                      NoSuchEntityException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

startAssessmentRun

default StartAssessmentRunResponse startAssessmentRun(StartAssessmentRunRequest startAssessmentRunRequest)
                                               throws InternalException,
                                                      InvalidInputException,
                                                      LimitExceededException,
                                                      AccessDeniedException,
                                                      NoSuchEntityException,
                                                      InvalidCrossAccountRoleException,
                                                      AgentsAlreadyRunningAssessmentException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

stopAssessmentRun

default StopAssessmentRunResponse stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest)
                                             throws InternalException,
                                                    InvalidInputException,
                                                    AccessDeniedException,
                                                    NoSuchEntityException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

subscribeToEvent

default SubscribeToEventResponse subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest)
                                           throws InternalException,
                                                  InvalidInputException,
                                                  LimitExceededException,
                                                  AccessDeniedException,
                                                  NoSuchEntityException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

unsubscribeFromEvent

default UnsubscribeFromEventResponse unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest)
                                                   throws InternalException,
                                                          InvalidInputException,
                                                          AccessDeniedException,
                                                          NoSuchEntityException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateAssessmentTarget

default UpdateAssessmentTargetResponse updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest)
                                                       throws InternalException,
                                                              InvalidInputException,
                                                              AccessDeniedException,
                                                              NoSuchEntityException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              InspectorException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

InspectorException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()