com.amazonaws.services.inspector.AmazonInspector Maven / Gradle / Ivy
Show all versions of aws-java-sdk-inspector Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.inspector;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.inspector.model.*;
/**
* Interface for accessing Amazon Inspector.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.inspector.AbstractAmazonInspector} instead.
*
*
* Amazon Inspector
*
* Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues.
* For more information, see Amazon Inspector User
* Guide.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonInspector {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "inspector";
/**
* Overrides the default endpoint for this client ("https://inspector.us-east-1.amazonaws.com"). Callers can use
* this method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "inspector.us-east-1.amazonaws.com") or a full URL, including the
* protocol (ex: "https://inspector.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
* protocol from this client's {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param endpoint
* The endpoint (ex: "inspector.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
* "https://inspector.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
* communicate with.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonInspector#setEndpoint(String)}, sets the regional endpoint for this client's
* service calls. Callers can use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
*
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
*
*
* @param addAttributesToFindingsRequest
* @return Result of the AddAttributesToFindings operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.AddAttributesToFindings
* @see AWS API Documentation
*/
AddAttributesToFindingsResult addAttributesToFindings(AddAttributesToFindingsRequest addAttributesToFindingsRequest);
/**
*
* Creates a new assessment target using the ARN of the resource group that is generated by
* CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account
* and region are included in the assessment target. If the service-linked role isn’t
* already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access
* to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS
* account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector
* Assessment Targets.
*
*
* @param createAssessmentTargetRequest
* @return Result of the CreateAssessmentTarget operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws LimitExceededException
* The request was rejected because it attempted to create resources beyond the current AWS account limits.
* The error code describes the limit exceeded.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws InvalidCrossAccountRoleException
* Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the
* assessment run.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.CreateAssessmentTarget
* @see AWS API Documentation
*/
CreateAssessmentTargetResult createAssessmentTarget(CreateAssessmentTargetRequest createAssessmentTargetRequest);
/**
*
* Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
* If the service-linked
* role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon
* Inspector access to AWS Services needed to perform security assessments.
*
*
* @param createAssessmentTemplateRequest
* @return Result of the CreateAssessmentTemplate operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws LimitExceededException
* The request was rejected because it attempted to create resources beyond the current AWS account limits.
* The error code describes the limit exceeded.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.CreateAssessmentTemplate
* @see AWS API Documentation
*/
CreateAssessmentTemplateResult createAssessmentTemplate(CreateAssessmentTemplateRequest createAssessmentTemplateRequest);
/**
*
* Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview
* lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.
*
*
* @param createExclusionsPreviewRequest
* @return Result of the CreateExclusionsPreview operation returned by the service.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws PreviewGenerationInProgressException
* The request is rejected. The specified assessment template is currently generating an exclusions preview.
* @throws InternalException
* Internal server error.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.CreateExclusionsPreview
* @see AWS API Documentation
*/
CreateExclusionsPreviewResult createExclusionsPreview(CreateExclusionsPreviewRequest createExclusionsPreviewRequest);
/**
*
* 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.
*
*
* @param createResourceGroupRequest
* @return Result of the CreateResourceGroup operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws LimitExceededException
* The request was rejected because it attempted to create resources beyond the current AWS account limits.
* The error code describes the limit exceeded.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.CreateResourceGroup
* @see AWS
* API Documentation
*/
CreateResourceGroupResult createResourceGroup(CreateResourceGroupRequest createResourceGroupRequest);
/**
*
* Deletes the assessment run that is specified by the ARN of the assessment run.
*
*
* @param deleteAssessmentRunRequest
* @return Result of the DeleteAssessmentRun operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AssessmentRunInProgressException
* You cannot perform a specified action if an assessment run is currently in progress.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.DeleteAssessmentRun
* @see AWS
* API Documentation
*/
DeleteAssessmentRunResult deleteAssessmentRun(DeleteAssessmentRunRequest deleteAssessmentRunRequest);
/**
*
* Deletes the assessment target that is specified by the ARN of the assessment target.
*
*
* @param deleteAssessmentTargetRequest
* @return Result of the DeleteAssessmentTarget operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AssessmentRunInProgressException
* You cannot perform a specified action if an assessment run is currently in progress.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.DeleteAssessmentTarget
* @see AWS API Documentation
*/
DeleteAssessmentTargetResult deleteAssessmentTarget(DeleteAssessmentTargetRequest deleteAssessmentTargetRequest);
/**
*
* Deletes the assessment template that is specified by the ARN of the assessment template.
*
*
* @param deleteAssessmentTemplateRequest
* @return Result of the DeleteAssessmentTemplate operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AssessmentRunInProgressException
* You cannot perform a specified action if an assessment run is currently in progress.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.DeleteAssessmentTemplate
* @see AWS API Documentation
*/
DeleteAssessmentTemplateResult deleteAssessmentTemplate(DeleteAssessmentTemplateRequest deleteAssessmentTemplateRequest);
/**
*
* Describes the assessment runs that are specified by the ARNs of the assessment runs.
*
*
* @param describeAssessmentRunsRequest
* @return Result of the DescribeAssessmentRuns operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @sample AmazonInspector.DescribeAssessmentRuns
* @see AWS API Documentation
*/
DescribeAssessmentRunsResult describeAssessmentRuns(DescribeAssessmentRunsRequest describeAssessmentRunsRequest);
/**
*
* Describes the assessment targets that are specified by the ARNs of the assessment targets.
*
*
* @param describeAssessmentTargetsRequest
* @return Result of the DescribeAssessmentTargets operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @sample AmazonInspector.DescribeAssessmentTargets
* @see AWS API Documentation
*/
DescribeAssessmentTargetsResult describeAssessmentTargets(DescribeAssessmentTargetsRequest describeAssessmentTargetsRequest);
/**
*
* Describes the assessment templates that are specified by the ARNs of the assessment templates.
*
*
* @param describeAssessmentTemplatesRequest
* @return Result of the DescribeAssessmentTemplates operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @sample AmazonInspector.DescribeAssessmentTemplates
* @see AWS API Documentation
*/
DescribeAssessmentTemplatesResult describeAssessmentTemplates(DescribeAssessmentTemplatesRequest describeAssessmentTemplatesRequest);
/**
*
* Describes the IAM role that enables Amazon Inspector to access your AWS account.
*
*
* @param describeCrossAccountAccessRoleRequest
* @return Result of the DescribeCrossAccountAccessRole operation returned by the service.
* @throws InternalException
* Internal server error.
* @sample AmazonInspector.DescribeCrossAccountAccessRole
* @see AWS API Documentation
*/
DescribeCrossAccountAccessRoleResult describeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest describeCrossAccountAccessRoleRequest);
/**
*
* Describes the exclusions that are specified by the exclusions' ARNs.
*
*
* @param describeExclusionsRequest
* @return Result of the DescribeExclusions operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @sample AmazonInspector.DescribeExclusions
* @see AWS
* API Documentation
*/
DescribeExclusionsResult describeExclusions(DescribeExclusionsRequest describeExclusionsRequest);
/**
*
* Describes the findings that are specified by the ARNs of the findings.
*
*
* @param describeFindingsRequest
* @return Result of the DescribeFindings operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @sample AmazonInspector.DescribeFindings
* @see AWS API
* Documentation
*/
DescribeFindingsResult describeFindings(DescribeFindingsRequest describeFindingsRequest);
/**
*
* Describes the resource groups that are specified by the ARNs of the resource groups.
*
*
* @param describeResourceGroupsRequest
* @return Result of the DescribeResourceGroups operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @sample AmazonInspector.DescribeResourceGroups
* @see AWS API Documentation
*/
DescribeResourceGroupsResult describeResourceGroups(DescribeResourceGroupsRequest describeResourceGroupsRequest);
/**
*
* Describes the rules packages that are specified by the ARNs of the rules packages.
*
*
* @param describeRulesPackagesRequest
* @return Result of the DescribeRulesPackages operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @sample AmazonInspector.DescribeRulesPackages
* @see AWS API Documentation
*/
DescribeRulesPackagesResult describeRulesPackages(DescribeRulesPackagesRequest describeRulesPackagesRequest);
/**
*
* Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
*
*
* @param getAssessmentReportRequest
* @return Result of the GetAssessmentReport operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws AssessmentRunInProgressException
* You cannot perform a specified action if an assessment run is currently in progress.
* @throws 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.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.GetAssessmentReport
* @see AWS
* API Documentation
*/
GetAssessmentReportResult getAssessmentReport(GetAssessmentReportRequest getAssessmentReportRequest);
/**
*
* Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can
* obtain the preview token by running the CreateExclusionsPreview API.
*
*
* @param getExclusionsPreviewRequest
* @return Result of the GetExclusionsPreview operation returned by the service.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws InternalException
* Internal server error.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @sample AmazonInspector.GetExclusionsPreview
* @see AWS
* API Documentation
*/
GetExclusionsPreviewResult getExclusionsPreview(GetExclusionsPreviewRequest getExclusionsPreviewRequest);
/**
*
* Information about the data that is collected for the specified assessment run.
*
*
* @param getTelemetryMetadataRequest
* @return Result of the GetTelemetryMetadata operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @sample AmazonInspector.GetTelemetryMetadata
* @see AWS
* API Documentation
*/
GetTelemetryMetadataResult getTelemetryMetadata(GetTelemetryMetadataRequest getTelemetryMetadataRequest);
/**
*
* Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
*
*
* @param listAssessmentRunAgentsRequest
* @return Result of the ListAssessmentRunAgents operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @sample AmazonInspector.ListAssessmentRunAgents
* @see AWS API Documentation
*/
ListAssessmentRunAgentsResult listAssessmentRunAgents(ListAssessmentRunAgentsRequest listAssessmentRunAgentsRequest);
/**
*
* Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the
* assessment templates.
*
*
* @param listAssessmentRunsRequest
* @return Result of the ListAssessmentRuns operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @sample AmazonInspector.ListAssessmentRuns
* @see AWS
* API Documentation
*/
ListAssessmentRunsResult listAssessmentRuns(ListAssessmentRunsRequest listAssessmentRunsRequest);
/**
*
* Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets,
* see Amazon Inspector
* Assessment Targets.
*
*
* @param listAssessmentTargetsRequest
* @return Result of the ListAssessmentTargets operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @sample AmazonInspector.ListAssessmentTargets
* @see AWS API Documentation
*/
ListAssessmentTargetsResult listAssessmentTargets(ListAssessmentTargetsRequest listAssessmentTargetsRequest);
/**
*
* Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the
* assessment targets.
*
*
* @param listAssessmentTemplatesRequest
* @return Result of the ListAssessmentTemplates operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @sample AmazonInspector.ListAssessmentTemplates
* @see AWS API Documentation
*/
ListAssessmentTemplatesResult listAssessmentTemplates(ListAssessmentTemplatesRequest listAssessmentTemplatesRequest);
/**
*
* 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.
*
*
* @param listEventSubscriptionsRequest
* @return Result of the ListEventSubscriptions operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @sample AmazonInspector.ListEventSubscriptions
* @see AWS API Documentation
*/
ListEventSubscriptionsResult listEventSubscriptions(ListEventSubscriptionsRequest listEventSubscriptionsRequest);
/**
*
* List exclusions that are generated by the assessment run.
*
*
* @param listExclusionsRequest
* @return Result of the ListExclusions operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @sample AmazonInspector.ListExclusions
* @see AWS API
* Documentation
*/
ListExclusionsResult listExclusions(ListExclusionsRequest listExclusionsRequest);
/**
*
* Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
*
*
* @param listFindingsRequest
* @return Result of the ListFindings operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @sample AmazonInspector.ListFindings
* @see AWS API
* Documentation
*/
ListFindingsResult listFindings(ListFindingsRequest listFindingsRequest);
/**
*
* Lists all available Amazon Inspector rules packages.
*
*
* @param listRulesPackagesRequest
* @return Result of the ListRulesPackages operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @sample AmazonInspector.ListRulesPackages
* @see AWS
* API Documentation
*/
ListRulesPackagesResult listRulesPackages(ListRulesPackagesRequest listRulesPackagesRequest);
/**
*
* Lists all tags associated with an assessment template.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @sample AmazonInspector.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Previews the agents installed on the EC2 instances that are part of the specified assessment target.
*
*
* @param previewAgentsRequest
* @return Result of the PreviewAgents operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws InvalidCrossAccountRoleException
* Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the
* assessment run.
* @sample AmazonInspector.PreviewAgents
* @see AWS API
* Documentation
*/
PreviewAgentsResult previewAgents(PreviewAgentsRequest previewAgentsRequest);
/**
*
* Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security
* assessments.
*
*
* @param registerCrossAccountAccessRoleRequest
* @return Result of the RegisterCrossAccountAccessRole operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws InvalidCrossAccountRoleException
* Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the
* assessment run.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.RegisterCrossAccountAccessRole
* @see AWS API Documentation
*/
RegisterCrossAccountAccessRoleResult registerCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest registerCrossAccountAccessRoleRequest);
/**
*
* 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.
*
*
* @param removeAttributesFromFindingsRequest
* @return Result of the RemoveAttributesFromFindings operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.RemoveAttributesFromFindings
* @see AWS API Documentation
*/
RemoveAttributesFromFindingsResult removeAttributesFromFindings(RemoveAttributesFromFindingsRequest removeAttributesFromFindingsRequest);
/**
*
* Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment
* template.
*
*
* @param setTagsForResourceRequest
* @return Result of the SetTagsForResource operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.SetTagsForResource
* @see AWS
* API Documentation
*/
SetTagsForResourceResult setTagsForResource(SetTagsForResourceRequest setTagsForResourceRequest);
/**
*
* 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.
*
*
* @param startAssessmentRunRequest
* @return Result of the StartAssessmentRun operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws LimitExceededException
* The request was rejected because it attempted to create resources beyond the current AWS account limits.
* The error code describes the limit exceeded.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws InvalidCrossAccountRoleException
* Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the
* assessment run.
* @throws AgentsAlreadyRunningAssessmentException
* You started an assessment run, but one of the instances is already participating in another assessment
* run.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.StartAssessmentRun
* @see AWS
* API Documentation
*/
StartAssessmentRunResult startAssessmentRun(StartAssessmentRunRequest startAssessmentRunRequest);
/**
*
* Stops the assessment run that is specified by the ARN of the assessment run.
*
*
* @param stopAssessmentRunRequest
* @return Result of the StopAssessmentRun operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.StopAssessmentRun
* @see AWS
* API Documentation
*/
StopAssessmentRunResult stopAssessmentRun(StopAssessmentRunRequest stopAssessmentRunRequest);
/**
*
* Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to
* a specified SNS topic.
*
*
* @param subscribeToEventRequest
* @return Result of the SubscribeToEvent operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws LimitExceededException
* The request was rejected because it attempted to create resources beyond the current AWS account limits.
* The error code describes the limit exceeded.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.SubscribeToEvent
* @see AWS API
* Documentation
*/
SubscribeToEventResult subscribeToEvent(SubscribeToEventRequest subscribeToEventRequest);
/**
*
* Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to
* a specified SNS topic.
*
*
* @param unsubscribeFromEventRequest
* @return Result of the UnsubscribeFromEvent operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.UnsubscribeFromEvent
* @see AWS
* API Documentation
*/
UnsubscribeFromEventResult unsubscribeFromEvent(UnsubscribeFromEventRequest unsubscribeFromEventRequest);
/**
*
* Updates the assessment target that is specified by the ARN of the assessment target.
*
*
* If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the
* assessment target.
*
*
* @param updateAssessmentTargetRequest
* @return Result of the UpdateAssessmentTarget operation returned by the service.
* @throws InternalException
* Internal server error.
* @throws InvalidInputException
* The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
* @throws AccessDeniedException
* You do not have required permissions to access the requested resource.
* @throws NoSuchEntityException
* The request was rejected because it referenced an entity that does not exist. The error code describes
* the entity.
* @throws ServiceTemporarilyUnavailableException
* The serice is temporary unavailable.
* @sample AmazonInspector.UpdateAssessmentTarget
* @see AWS API Documentation
*/
UpdateAssessmentTargetResult updateAssessmentTarget(UpdateAssessmentTargetRequest updateAssessmentTargetRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}