Class AmazonInspectorClient
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceClient
-
- com.amazonaws.services.inspector.AmazonInspectorClient
-
- All Implemented Interfaces:
AmazonInspector
- Direct Known Subclasses:
AmazonInspectorAsyncClient
@ThreadSafe public class AmazonInspectorClient extends AmazonWebServiceClient implements AmazonInspector
Client for accessing Amazon Inspector. All service calls made using this client are blocking, and will not return until the service call completes.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 protected static ClientConfigurationFactory
configFactory
Client configuration factory providing ClientConfigurations tailored to this client-
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
-
Constructor Summary
Constructors Constructor Description AmazonInspectorClient()
Constructs a new client to invoke service methods on Amazon Inspector.AmazonInspectorClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials.AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials provider.AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials provider and client configuration options.AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials provider, client configuration options, and request metric collector.AmazonInspectorClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials and client configuration options.AmazonInspectorClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Inspector.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.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.SetTagsForResourceResult
setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)
Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.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.-
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.amazonaws.services.inspector.AmazonInspector
setEndpoint, setRegion, shutdown
-
-
-
-
Field Detail
-
configFactory
protected static final ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
-
-
Constructor Detail
-
AmazonInspectorClient
public AmazonInspectorClient()
Constructs a new client to invoke service methods on Amazon Inspector. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
DefaultAWSCredentialsProviderChain
-
AmazonInspectorClient
public AmazonInspectorClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Inspector. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy settings, retry counts, etc.).- See Also:
DefaultAWSCredentialsProviderChain
-
AmazonInspectorClient
public AmazonInspectorClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AmazonInspectorClient
public AmazonInspectorClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy settings, retry counts, etc.).
-
AmazonInspectorClient
public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AmazonInspectorClient
public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy settings, retry counts, etc.).
-
AmazonInspectorClient
public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon Inspector using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Inspector (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collector
-
-
Method Detail
-
addAttributesToFindings
public AddAttributesToFindingsResult addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
- Specified by:
addAttributesToFindings
in interfaceAmazonInspector
- 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.
-
createAssessmentTarget
public 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.
- Specified by:
createAssessmentTarget
in interfaceAmazonInspector
- 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.
-
createAssessmentTemplate
public CreateAssessmentTemplateResult createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest)
Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
- Specified by:
createAssessmentTemplate
in interfaceAmazonInspector
- 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.
-
createResourceGroup
public 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.
- Specified by:
createResourceGroup
in interfaceAmazonInspector
- 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.
-
deleteAssessmentRun
public DeleteAssessmentRunResult deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest)
Deletes the assessment run that is specified by the ARN of the assessment run.
- Specified by:
deleteAssessmentRun
in interfaceAmazonInspector
- 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.
-
deleteAssessmentTarget
public DeleteAssessmentTargetResult deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest)
Deletes the assessment target that is specified by the ARN of the assessment target.
- Specified by:
deleteAssessmentTarget
in interfaceAmazonInspector
- 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.
-
deleteAssessmentTemplate
public DeleteAssessmentTemplateResult deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest)
Deletes the assessment template that is specified by the ARN of the assessment template.
- Specified by:
deleteAssessmentTemplate
in interfaceAmazonInspector
- 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.
-
describeAssessmentRuns
public DescribeAssessmentRunsResult describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest)
Describes the assessment runs that are specified by the ARNs of the assessment runs.
- Specified by:
describeAssessmentRuns
in interfaceAmazonInspector
- 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.
-
describeAssessmentTargets
public DescribeAssessmentTargetsResult describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest)
Describes the assessment targets that are specified by the ARNs of the assessment targets.
- Specified by:
describeAssessmentTargets
in interfaceAmazonInspector
- 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.
-
describeAssessmentTemplates
public DescribeAssessmentTemplatesResult describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest)
Describes the assessment templates that are specified by the ARNs of the assessment templates.
- Specified by:
describeAssessmentTemplates
in interfaceAmazonInspector
- 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.
-
describeCrossAccountAccessRole
public DescribeCrossAccountAccessRoleResult describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)
Describes the IAM role that enables Amazon Inspector to access your AWS account.
- Specified by:
describeCrossAccountAccessRole
in interfaceAmazonInspector
- Parameters:
describeCrossAccountAccessRoleRequest
-- Returns:
- Result of the DescribeCrossAccountAccessRole operation returned by the service.
- Throws:
InternalException
- Internal server error.
-
describeFindings
public DescribeFindingsResult describeFindings(DescribeFindingsRequest describeFindingsRequest)
Describes the findings that are specified by the ARNs of the findings.
- Specified by:
describeFindings
in interfaceAmazonInspector
- 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.
-
describeResourceGroups
public DescribeResourceGroupsResult describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest)
Describes the resource groups that are specified by the ARNs of the resource groups.
- Specified by:
describeResourceGroups
in interfaceAmazonInspector
- 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.
-
describeRulesPackages
public DescribeRulesPackagesResult describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest)
Describes the rules packages that are specified by the ARNs of the rules packages.
- Specified by:
describeRulesPackages
in interfaceAmazonInspector
- 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.
-
getTelemetryMetadata
public GetTelemetryMetadataResult getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest)
Information about the data that is collected for the specified assessment run.
- Specified by:
getTelemetryMetadata
in interfaceAmazonInspector
- 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.
-
listAssessmentRunAgents
public ListAssessmentRunAgentsResult listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest)
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
- Specified by:
listAssessmentRunAgents
in interfaceAmazonInspector
- 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.
-
listAssessmentRuns
public ListAssessmentRunsResult listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest)
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
- Specified by:
listAssessmentRuns
in interfaceAmazonInspector
- 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.
-
listAssessmentTargets
public 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.
- Specified by:
listAssessmentTargets
in interfaceAmazonInspector
- 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.
-
listAssessmentTemplates
public ListAssessmentTemplatesResult listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest)
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
- Specified by:
listAssessmentTemplates
in interfaceAmazonInspector
- 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.
-
listEventSubscriptions
public 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.
- Specified by:
listEventSubscriptions
in interfaceAmazonInspector
- 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.
-
listFindings
public ListFindingsResult listFindings(ListFindingsRequest listFindingsRequest)
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
- Specified by:
listFindings
in interfaceAmazonInspector
- 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.
-
listRulesPackages
public ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)
Lists all available Amazon Inspector rules packages.
- Specified by:
listRulesPackages
in interfaceAmazonInspector
- 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.
-
listTagsForResource
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with an assessment template.
- Specified by:
listTagsForResource
in interfaceAmazonInspector
- 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.
-
previewAgents
public PreviewAgentsResult previewAgents(PreviewAgentsRequest previewAgentsRequest)
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
- Specified by:
previewAgents
in interfaceAmazonInspector
- 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.
-
registerCrossAccountAccessRole
public 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.
- Specified by:
registerCrossAccountAccessRole
in interfaceAmazonInspector
- 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.
-
removeAttributesFromFindings
public 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.
- Specified by:
removeAttributesFromFindings
in interfaceAmazonInspector
- 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.
-
setTagsForResource
public SetTagsForResourceResult setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)
Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
- Specified by:
setTagsForResource
in interfaceAmazonInspector
- 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.
-
startAssessmentRun
public 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.
- Specified by:
startAssessmentRun
in interfaceAmazonInspector
- 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.
-
stopAssessmentRun
public StopAssessmentRunResult stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest)
Stops the assessment run that is specified by the ARN of the assessment run.
- Specified by:
stopAssessmentRun
in interfaceAmazonInspector
- 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.
-
subscribeToEvent
public SubscribeToEventResult subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest)
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
- Specified by:
subscribeToEvent
in interfaceAmazonInspector
- 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.
-
unsubscribeFromEvent
public UnsubscribeFromEventResult unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest)
Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
- Specified by:
unsubscribeFromEvent
in interfaceAmazonInspector
- 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.
-
updateAssessmentTarget
public UpdateAssessmentTargetResult updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest)
Updates the assessment target that is specified by the ARN of the assessment target.
- Specified by:
updateAssessmentTarget
in interfaceAmazonInspector
- 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.
-
getCachedResponseMetadata
public 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 the request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonInspector
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-
-