public class AmazonInspectorClient extends AmazonWebServiceClient implements AmazonInspector
Amazon Inspector enables you to analyze the behavior of the applications you run in AWS and to identify potential security issues. For more information, see Amazon Inspector User Guide.
LOGGING_AWS_REQUEST_METRIC
Constructor and 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(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(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(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Inspector.
|
Modifier and Type | Method and Description |
---|---|
AddAttributesToFindingsResult |
addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)
Assigns attributes (key and value pair) to the findings specified by the
findings' ARNs.
|
AttachAssessmentAndRulesPackageResult |
attachAssessmentAndRulesPackage(AttachAssessmentAndRulesPackageRequest attachAssessmentAndRulesPackageRequest)
Attaches the rules package specified by the rules package ARN to the
assessment specified by the assessment ARN.
|
CreateApplicationResult |
createApplication(CreateApplicationRequest createApplicationRequest)
Creates a new application using the resource group ARN generated by
CreateResourceGroup.
|
CreateAssessmentResult |
createAssessment(CreateAssessmentRequest createAssessmentRequest)
Creates an assessment for the application specified by the application
ARN.
|
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
Inspector application.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes the application specified by the application ARN.
|
DeleteAssessmentResult |
deleteAssessment(DeleteAssessmentRequest deleteAssessmentRequest)
Deletes the assessment specified by the assessment ARN.
|
DeleteRunResult |
deleteRun(DeleteRunRequest deleteRunRequest)
Deletes the assessment run specified by the run ARN.
|
DescribeApplicationResult |
describeApplication(DescribeApplicationRequest describeApplicationRequest)
Describes the application specified by the application ARN.
|
DescribeAssessmentResult |
describeAssessment(DescribeAssessmentRequest describeAssessmentRequest)
Describes the assessment specified by the assessment ARN.
|
DescribeCrossAccountAccessRoleResult |
describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)
Describes the IAM role that enables Inspector to access your AWS account.
|
DescribeFindingResult |
describeFinding(DescribeFindingRequest describeFindingRequest)
Describes the finding specified by the finding ARN.
|
DescribeResourceGroupResult |
describeResourceGroup(DescribeResourceGroupRequest describeResourceGroupRequest)
Describes the resource group specified by the resource group ARN.
|
DescribeRulesPackageResult |
describeRulesPackage(DescribeRulesPackageRequest describeRulesPackageRequest)
Describes the rules package specified by the rules package ARN.
|
DescribeRunResult |
describeRun(DescribeRunRequest describeRunRequest)
Describes the assessment run specified by the run ARN.
|
DetachAssessmentAndRulesPackageResult |
detachAssessmentAndRulesPackage(DetachAssessmentAndRulesPackageRequest detachAssessmentAndRulesPackageRequest)
Detaches the rules package specified by the rules package ARN from the
assessment specified by the assessment ARN.
|
GetAssessmentTelemetryResult |
getAssessmentTelemetry(GetAssessmentTelemetryRequest getAssessmentTelemetryRequest)
Returns the metadata about the telemetry (application behavioral data)
for the assessment specified by the assessment ARN.
|
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.
|
ListApplicationsResult |
listApplications(ListApplicationsRequest listApplicationsRequest)
Lists the ARNs of the applications within this AWS account.
|
ListAssessmentAgentsResult |
listAssessmentAgents(ListAssessmentAgentsRequest listAssessmentAgentsRequest)
Lists the agents of the assessment specified by the assessment ARN.
|
ListAssessmentsResult |
listAssessments(ListAssessmentsRequest listAssessmentsRequest)
Lists the assessments corresponding to applications specified by the
applications' ARNs.
|
ListAttachedAssessmentsResult |
listAttachedAssessments(ListAttachedAssessmentsRequest listAttachedAssessmentsRequest)
Lists the assessments attached to the rules package specified by the
rules package ARN.
|
ListAttachedRulesPackagesResult |
listAttachedRulesPackages(ListAttachedRulesPackagesRequest listAttachedRulesPackagesRequest)
Lists the rules packages attached to the assessment specified by the
assessment ARN.
|
ListFindingsResult |
listFindings(ListFindingsRequest listFindingsRequest)
Lists findings generated by the assessment run specified by the run ARNs.
|
ListRulesPackagesResult |
listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)
Lists all available Inspector rules packages.
|
ListRunsResult |
listRuns(ListRunsRequest listRunsRequest)
Lists the assessment runs associated with the assessments specified by
the assessment ARNs.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a resource.
|
LocalizeTextResult |
localizeText(LocalizeTextRequest localizeTextRequest)
Translates a textual identifier into a user-readable text in a specified
locale.
|
PreviewAgentsForResourceGroupResult |
previewAgentsForResourceGroup(PreviewAgentsForResourceGroupRequest previewAgentsForResourceGroupRequest)
Previews the agents installed on the EC2 instances that are included in
the application created with the specified resource group.
|
RegisterCrossAccountAccessRoleResult |
registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest)
Register the role that Inspector uses to list your EC2 instances during
the assessment.
|
RemoveAttributesFromFindingsResult |
removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest)
Removes the entire attribute (key and value pair) from the findings
specified by the finding ARNs where an attribute with the specified key
exists.
|
RunAssessmentResult |
runAssessment(RunAssessmentRequest runAssessmentRequest)
Starts the analysis of the application’s behavior against selected rule
packages for the assessment specified by the assessment ARN.
|
SetTagsForResourceResult |
setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)
Sets tags (key and value pairs) to the assessment specified by the
assessment ARN.
|
StartDataCollectionResult |
startDataCollection(StartDataCollectionRequest startDataCollectionRequest)
Starts data collection for the assessment specified by the assessment
ARN.
|
StopDataCollectionResult |
stopDataCollection(StopDataCollectionRequest stopDataCollectionRequest)
Stop data collection for the assessment specified by the assessment ARN.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates application specified by the application ARN.
|
UpdateAssessmentResult |
updateAssessment(UpdateAssessmentRequest updateAssessmentRequest)
Updates the assessment specified by the assessment ARN.
|
addRequestHandler, addRequestHandler, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
public AmazonInspectorClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonInspectorClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to Amazon Inspector (ex: proxy settings, retry counts,
etc.).DefaultAWSCredentialsProviderChain
public AmazonInspectorClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonInspectorClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon Inspector (ex: proxy settings, retry counts,
etc.).public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon Inspector (ex: proxy settings, retry counts,
etc.).public AmazonInspectorClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon Inspector (ex: proxy settings, retry counts,
etc.).requestMetricCollector
- optional request metric collectorpublic AddAttributesToFindingsResult addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest)
Assigns attributes (key and value pair) to the findings specified by the findings' ARNs.
addAttributesToFindings
in interface AmazonInspector
addAttributesToFindingsRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public AttachAssessmentAndRulesPackageResult attachAssessmentAndRulesPackage(AttachAssessmentAndRulesPackageRequest attachAssessmentAndRulesPackageRequest)
Attaches the rules package specified by the rules package ARN to the assessment specified by the assessment ARN.
attachAssessmentAndRulesPackage
in interface AmazonInspector
attachAssessmentAndRulesPackageRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
Creates a new application using the resource group ARN generated by CreateResourceGroup. You can create up to 50 applications per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Inspector Applications.
createApplication
in interface AmazonInspector
createApplicationRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public CreateAssessmentResult createAssessment(CreateAssessmentRequest createAssessmentRequest)
Creates an assessment for the application specified by the application ARN. You can create up to 500 assessments per AWS account.
createAssessment
in interface AmazonInspector
createAssessmentRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
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 Inspector application. The created resource group is then used to create an Inspector application.
createResourceGroup
in interface AmazonInspector
createResourceGroupRequest
- InternalException
InvalidInputException
AccessDeniedException
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes the application specified by the application ARN.
deleteApplication
in interface AmazonInspector
deleteApplicationRequest
- InternalException
InvalidInputException
OperationInProgressException
AccessDeniedException
NoSuchEntityException
public DeleteAssessmentResult deleteAssessment(DeleteAssessmentRequest deleteAssessmentRequest)
Deletes the assessment specified by the assessment ARN.
deleteAssessment
in interface AmazonInspector
deleteAssessmentRequest
- InternalException
InvalidInputException
OperationInProgressException
AccessDeniedException
NoSuchEntityException
public DeleteRunResult deleteRun(DeleteRunRequest deleteRunRequest)
Deletes the assessment run specified by the run ARN.
deleteRun
in interface AmazonInspector
deleteRunRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public DescribeApplicationResult describeApplication(DescribeApplicationRequest describeApplicationRequest)
Describes the application specified by the application ARN.
describeApplication
in interface AmazonInspector
describeApplicationRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public DescribeAssessmentResult describeAssessment(DescribeAssessmentRequest describeAssessmentRequest)
Describes the assessment specified by the assessment ARN.
describeAssessment
in interface AmazonInspector
describeAssessmentRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public DescribeCrossAccountAccessRoleResult describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest)
Describes the IAM role that enables Inspector to access your AWS account.
describeCrossAccountAccessRole
in interface AmazonInspector
describeCrossAccountAccessRoleRequest
- InternalException
AccessDeniedException
public DescribeFindingResult describeFinding(DescribeFindingRequest describeFindingRequest)
Describes the finding specified by the finding ARN.
describeFinding
in interface AmazonInspector
describeFindingRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public DescribeResourceGroupResult describeResourceGroup(DescribeResourceGroupRequest describeResourceGroupRequest)
Describes the resource group specified by the resource group ARN.
describeResourceGroup
in interface AmazonInspector
describeResourceGroupRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public DescribeRulesPackageResult describeRulesPackage(DescribeRulesPackageRequest describeRulesPackageRequest)
Describes the rules package specified by the rules package ARN.
describeRulesPackage
in interface AmazonInspector
describeRulesPackageRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public DescribeRunResult describeRun(DescribeRunRequest describeRunRequest)
Describes the assessment run specified by the run ARN.
describeRun
in interface AmazonInspector
describeRunRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public DetachAssessmentAndRulesPackageResult detachAssessmentAndRulesPackage(DetachAssessmentAndRulesPackageRequest detachAssessmentAndRulesPackageRequest)
Detaches the rules package specified by the rules package ARN from the assessment specified by the assessment ARN.
detachAssessmentAndRulesPackage
in interface AmazonInspector
detachAssessmentAndRulesPackageRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public GetAssessmentTelemetryResult getAssessmentTelemetry(GetAssessmentTelemetryRequest getAssessmentTelemetryRequest)
Returns the metadata about the telemetry (application behavioral data) for the assessment specified by the assessment ARN.
getAssessmentTelemetry
in interface AmazonInspector
getAssessmentTelemetryRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)
Lists the ARNs of the applications within this AWS account. For more information about applications, see Inspector Applications.
listApplications
in interface AmazonInspector
listApplicationsRequest
- InternalException
InvalidInputException
AccessDeniedException
public ListAssessmentAgentsResult listAssessmentAgents(ListAssessmentAgentsRequest listAssessmentAgentsRequest)
Lists the agents of the assessment specified by the assessment ARN.
listAssessmentAgents
in interface AmazonInspector
listAssessmentAgentsRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public ListAssessmentsResult listAssessments(ListAssessmentsRequest listAssessmentsRequest)
Lists the assessments corresponding to applications specified by the applications' ARNs.
listAssessments
in interface AmazonInspector
listAssessmentsRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public ListAttachedAssessmentsResult listAttachedAssessments(ListAttachedAssessmentsRequest listAttachedAssessmentsRequest)
Lists the assessments attached to the rules package specified by the rules package ARN.
listAttachedAssessments
in interface AmazonInspector
listAttachedAssessmentsRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public ListAttachedRulesPackagesResult listAttachedRulesPackages(ListAttachedRulesPackagesRequest listAttachedRulesPackagesRequest)
Lists the rules packages attached to the assessment specified by the assessment ARN.
listAttachedRulesPackages
in interface AmazonInspector
listAttachedRulesPackagesRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public ListFindingsResult listFindings(ListFindingsRequest listFindingsRequest)
Lists findings generated by the assessment run specified by the run ARNs.
listFindings
in interface AmazonInspector
listFindingsRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest)
Lists all available Inspector rules packages.
listRulesPackages
in interface AmazonInspector
listRulesPackagesRequest
- InternalException
InvalidInputException
AccessDeniedException
public ListRunsResult listRuns(ListRunsRequest listRunsRequest)
Lists the assessment runs associated with the assessments specified by the assessment ARNs.
listRuns
in interface AmazonInspector
listRunsRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a resource.
listTagsForResource
in interface AmazonInspector
listTagsForResourceRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public LocalizeTextResult localizeText(LocalizeTextRequest localizeTextRequest)
Translates a textual identifier into a user-readable text in a specified locale.
localizeText
in interface AmazonInspector
localizeTextRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public PreviewAgentsForResourceGroupResult previewAgentsForResourceGroup(PreviewAgentsForResourceGroupRequest previewAgentsForResourceGroupRequest)
Previews the agents installed on the EC2 instances that are included in the application created with the specified resource group.
previewAgentsForResourceGroup
in interface AmazonInspector
previewAgentsForResourceGroupRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
InvalidCrossAccountRoleException
public RegisterCrossAccountAccessRoleResult registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest)
Register the role that Inspector uses to list your EC2 instances during the assessment.
registerCrossAccountAccessRole
in interface AmazonInspector
registerCrossAccountAccessRoleRequest
- InternalException
InvalidInputException
AccessDeniedException
InvalidCrossAccountRoleException
public RemoveAttributesFromFindingsResult removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest)
Removes the entire attribute (key and value pair) from the findings specified by the finding ARNs where an attribute with the specified key exists.
removeAttributesFromFindings
in interface AmazonInspector
removeAttributesFromFindingsRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public RunAssessmentResult runAssessment(RunAssessmentRequest runAssessmentRequest)
Starts the analysis of the application’s behavior against selected rule packages for the assessment specified by the assessment ARN.
runAssessment
in interface AmazonInspector
runAssessmentRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public SetTagsForResourceResult setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest)
Sets tags (key and value pairs) to the assessment specified by the assessment ARN.
setTagsForResource
in interface AmazonInspector
setTagsForResourceRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public StartDataCollectionResult startDataCollection(StartDataCollectionRequest startDataCollectionRequest)
Starts data collection for the assessment specified by the assessment ARN. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.
startDataCollection
in interface AmazonInspector
startDataCollectionRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
InvalidCrossAccountRoleException
public StopDataCollectionResult stopDataCollection(StopDataCollectionRequest stopDataCollectionRequest)
Stop data collection for the assessment specified by the assessment ARN.
stopDataCollection
in interface AmazonInspector
stopDataCollectionRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates application specified by the application ARN.
updateApplication
in interface AmazonInspector
updateApplicationRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public UpdateAssessmentResult updateAssessment(UpdateAssessmentRequest updateAssessmentRequest)
Updates the assessment specified by the assessment ARN.
updateAssessment
in interface AmazonInspector
updateAssessmentRequest
- InternalException
InvalidInputException
AccessDeniedException
NoSuchEntityException
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonInspector
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.