com.amazonaws.services.inspector2.AWSInspector2 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-inspector2 Show documentation
Show all versions of aws-java-sdk-inspector2 Show documentation
The AWS Java SDK for Inspector2 module holds the client classes that are used for communicating with Inspector2 Service
/*
* 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.inspector2;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.inspector2.model.*;
/**
* Interface for accessing Inspector2.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.inspector2.AbstractAWSInspector2} instead.
*
*
*
* Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities
* within your Amazon EC2, Amazon ECR, and Amazon Web Services Lambda environments.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSInspector2 {
/**
* 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 = "inspector2";
/**
*
* Associates an Amazon Web Services account with an Amazon Inspector delegated administrator. An HTTP 200 response
* indicates the association was successfully started, but doesn’t indicate whether it was completed. You can check
* if the association completed by using ListMembers for multiple
* accounts or GetMembers for
* a single account.
*
*
* @param associateMemberRequest
* @return Result of the AssociateMember operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.AssociateMember
* @see AWS API
* Documentation
*/
AssociateMemberResult associateMember(AssociateMemberRequest associateMemberRequest);
/**
*
* Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
*
*
* @param batchGetAccountStatusRequest
* @return Result of the BatchGetAccountStatus operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.BatchGetAccountStatus
* @see AWS API Documentation
*/
BatchGetAccountStatusResult batchGetAccountStatus(BatchGetAccountStatusRequest batchGetAccountStatusRequest);
/**
*
* Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.
*
*
* @param batchGetCodeSnippetRequest
* @return Result of the BatchGetCodeSnippet operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.BatchGetCodeSnippet
* @see AWS
* API Documentation
*/
BatchGetCodeSnippetResult batchGetCodeSnippet(BatchGetCodeSnippetRequest batchGetCodeSnippetRequest);
/**
*
* Gets vulnerability details for findings.
*
*
* @param batchGetFindingDetailsRequest
* @return Result of the BatchGetFindingDetails operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.BatchGetFindingDetails
* @see AWS API Documentation
*/
BatchGetFindingDetailsResult batchGetFindingDetails(BatchGetFindingDetailsRequest batchGetFindingDetailsRequest);
/**
*
* Gets free trial status for multiple Amazon Web Services accounts.
*
*
* @param batchGetFreeTrialInfoRequest
* @return Result of the BatchGetFreeTrialInfo operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.BatchGetFreeTrialInfo
* @see AWS API Documentation
*/
BatchGetFreeTrialInfoResult batchGetFreeTrialInfo(BatchGetFreeTrialInfoRequest batchGetFreeTrialInfoRequest);
/**
*
* Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your
* organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.
*
*
* @param batchGetMemberEc2DeepInspectionStatusRequest
* @return Result of the BatchGetMemberEc2DeepInspectionStatus operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.BatchGetMemberEc2DeepInspectionStatus
* @see AWS API Documentation
*/
BatchGetMemberEc2DeepInspectionStatusResult batchGetMemberEc2DeepInspectionStatus(
BatchGetMemberEc2DeepInspectionStatusRequest batchGetMemberEc2DeepInspectionStatusRequest);
/**
*
* Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization.
* You must be the delegated administrator of an organization in Amazon Inspector to use this API.
*
*
* @param batchUpdateMemberEc2DeepInspectionStatusRequest
* @return Result of the BatchUpdateMemberEc2DeepInspectionStatus operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.BatchUpdateMemberEc2DeepInspectionStatus
* @see AWS API Documentation
*/
BatchUpdateMemberEc2DeepInspectionStatusResult batchUpdateMemberEc2DeepInspectionStatus(
BatchUpdateMemberEc2DeepInspectionStatusRequest batchUpdateMemberEc2DeepInspectionStatusRequest);
/**
*
* Cancels the given findings report.
*
*
* @param cancelFindingsReportRequest
* @return Result of the CancelFindingsReport operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.CancelFindingsReport
* @see AWS API Documentation
*/
CancelFindingsReportResult cancelFindingsReport(CancelFindingsReportRequest cancelFindingsReportRequest);
/**
*
* Cancels a software bill of materials (SBOM) report.
*
*
* @param cancelSbomExportRequest
* @return Result of the CancelSbomExport operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.CancelSbomExport
* @see AWS
* API Documentation
*/
CancelSbomExportResult cancelSbomExport(CancelSbomExportRequest cancelSbomExportRequest);
/**
*
* Creates a CIS scan configuration.
*
*
* @param createCisScanConfigurationRequest
* @return Result of the CreateCisScanConfiguration operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.CreateCisScanConfiguration
* @see AWS API Documentation
*/
CreateCisScanConfigurationResult createCisScanConfiguration(CreateCisScanConfigurationRequest createCisScanConfigurationRequest);
/**
*
* Creates a filter resource using specified filter criteria. When the filter action is set to SUPPRESS
* this action creates a suppression rule.
*
*
* @param createFilterRequest
* @return Result of the CreateFilter operation returned by the service.
* @throws ServiceQuotaExceededException
* You have exceeded your service quota. To perform the requested action, remove some of the relevant
* resources, or use Service Quotas to request a service quota increase.
* @throws BadRequestException
* One or more tags submitted as part of the request is not valid.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.CreateFilter
* @see AWS API
* Documentation
*/
CreateFilterResult createFilter(CreateFilterRequest createFilterRequest);
/**
*
* Creates a finding report. By default only ACTIVE findings are returned in the report. To see
* SUPRESSED or CLOSED findings you must specify a value for the
* findingStatus filter criteria.
*
*
* @param createFindingsReportRequest
* @return Result of the CreateFindingsReport operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.CreateFindingsReport
* @see AWS API Documentation
*/
CreateFindingsReportResult createFindingsReport(CreateFindingsReportRequest createFindingsReportRequest);
/**
*
* Creates a software bill of materials (SBOM) report.
*
*
* @param createSbomExportRequest
* @return Result of the CreateSbomExport operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.CreateSbomExport
* @see AWS
* API Documentation
*/
CreateSbomExportResult createSbomExport(CreateSbomExportRequest createSbomExportRequest);
/**
*
* Deletes a CIS scan configuration.
*
*
* @param deleteCisScanConfigurationRequest
* @return Result of the DeleteCisScanConfiguration operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.DeleteCisScanConfiguration
* @see AWS API Documentation
*/
DeleteCisScanConfigurationResult deleteCisScanConfiguration(DeleteCisScanConfigurationRequest deleteCisScanConfigurationRequest);
/**
*
* Deletes a filter resource.
*
*
* @param deleteFilterRequest
* @return Result of the DeleteFilter operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.DeleteFilter
* @see AWS API
* Documentation
*/
DeleteFilterResult deleteFilter(DeleteFilterRequest deleteFilterRequest);
/**
*
* Describe Amazon Inspector configuration settings for an Amazon Web Services organization.
*
*
* @param describeOrganizationConfigurationRequest
* @return Result of the DescribeOrganizationConfiguration operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.DescribeOrganizationConfiguration
* @see AWS API Documentation
*/
DescribeOrganizationConfigurationResult describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest);
/**
*
* Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an
* account disables the Amazon Inspector service.
*
*
* @param disableRequest
* @return Result of the Disable operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.Disable
* @see AWS API
* Documentation
*/
DisableResult disable(DisableRequest disableRequest);
/**
*
* Disables the Amazon Inspector delegated administrator for your organization.
*
*
* @param disableDelegatedAdminAccountRequest
* @return Result of the DisableDelegatedAdminAccount operation returned by the service.
* @throws ConflictException
* A conflict occurred.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.DisableDelegatedAdminAccount
* @see AWS API Documentation
*/
DisableDelegatedAdminAccountResult disableDelegatedAdminAccount(DisableDelegatedAdminAccountRequest disableDelegatedAdminAccountRequest);
/**
*
* Disassociates a member account from an Amazon Inspector delegated administrator.
*
*
* @param disassociateMemberRequest
* @return Result of the DisassociateMember operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.DisassociateMember
* @see AWS
* API Documentation
*/
DisassociateMemberResult disassociateMember(DisassociateMemberRequest disassociateMemberRequest);
/**
*
* Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
*
*
* @param enableRequest
* @return Result of the Enable operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.Enable
* @see AWS API
* Documentation
*/
EnableResult enable(EnableRequest enableRequest);
/**
*
* Enables the Amazon Inspector delegated administrator for your Organizations organization.
*
*
* @param enableDelegatedAdminAccountRequest
* @return Result of the EnableDelegatedAdminAccount operation returned by the service.
* @throws ConflictException
* A conflict occurred.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.EnableDelegatedAdminAccount
* @see AWS API Documentation
*/
EnableDelegatedAdminAccountResult enableDelegatedAdminAccount(EnableDelegatedAdminAccountRequest enableDelegatedAdminAccountRequest);
/**
*
* Retrieves a CIS scan report.
*
*
* @param getCisScanReportRequest
* @return Result of the GetCisScanReport operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.GetCisScanReport
* @see AWS
* API Documentation
*/
GetCisScanReportResult getCisScanReport(GetCisScanReportRequest getCisScanReportRequest);
/**
*
* Retrieves CIS scan result details.
*
*
* @param getCisScanResultDetailsRequest
* @return Result of the GetCisScanResultDetails operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.GetCisScanResultDetails
* @see AWS API Documentation
*/
GetCisScanResultDetailsResult getCisScanResultDetails(GetCisScanResultDetailsRequest getCisScanResultDetailsRequest);
/**
*
* Retrieves setting configurations for Inspector scans.
*
*
* @param getConfigurationRequest
* @return Result of the GetConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.GetConfiguration
* @see AWS
* API Documentation
*/
GetConfigurationResult getConfiguration(GetConfigurationRequest getConfigurationRequest);
/**
*
* Retrieves information about the Amazon Inspector delegated administrator for your organization.
*
*
* @param getDelegatedAdminAccountRequest
* @return Result of the GetDelegatedAdminAccount operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.GetDelegatedAdminAccount
* @see AWS API Documentation
*/
GetDelegatedAdminAccountResult getDelegatedAdminAccount(GetDelegatedAdminAccountRequest getDelegatedAdminAccountRequest);
/**
*
* Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your
* account.
*
*
* @param getEc2DeepInspectionConfigurationRequest
* @return Result of the GetEc2DeepInspectionConfiguration operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.GetEc2DeepInspectionConfiguration
* @see AWS API Documentation
*/
GetEc2DeepInspectionConfigurationResult getEc2DeepInspectionConfiguration(GetEc2DeepInspectionConfigurationRequest getEc2DeepInspectionConfigurationRequest);
/**
*
* Gets an encryption key.
*
*
* @param getEncryptionKeyRequest
* @return Result of the GetEncryptionKey operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.GetEncryptionKey
* @see AWS
* API Documentation
*/
GetEncryptionKeyResult getEncryptionKey(GetEncryptionKeyRequest getEncryptionKeyRequest);
/**
*
* Gets the status of a findings report.
*
*
* @param getFindingsReportStatusRequest
* @return Result of the GetFindingsReportStatus operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.GetFindingsReportStatus
* @see AWS API Documentation
*/
GetFindingsReportStatusResult getFindingsReportStatus(GetFindingsReportStatusRequest getFindingsReportStatusRequest);
/**
*
* Gets member information for your organization.
*
*
* @param getMemberRequest
* @return Result of the GetMember operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.GetMember
* @see AWS API
* Documentation
*/
GetMemberResult getMember(GetMemberRequest getMemberRequest);
/**
*
* Gets details of a software bill of materials (SBOM) report.
*
*
* @param getSbomExportRequest
* @return Result of the GetSbomExport operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.GetSbomExport
* @see AWS API
* Documentation
*/
GetSbomExportResult getSbomExport(GetSbomExportRequest getSbomExportRequest);
/**
*
* Lists the permissions an account has to configure Amazon Inspector.
*
*
* @param listAccountPermissionsRequest
* @return Result of the ListAccountPermissions operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListAccountPermissions
* @see AWS API Documentation
*/
ListAccountPermissionsResult listAccountPermissions(ListAccountPermissionsRequest listAccountPermissionsRequest);
/**
*
* Lists CIS scan configurations.
*
*
* @param listCisScanConfigurationsRequest
* @return Result of the ListCisScanConfigurations operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListCisScanConfigurations
* @see AWS API Documentation
*/
ListCisScanConfigurationsResult listCisScanConfigurations(ListCisScanConfigurationsRequest listCisScanConfigurationsRequest);
/**
*
* Lists scan results aggregated by checks.
*
*
* @param listCisScanResultsAggregatedByChecksRequest
* @return Result of the ListCisScanResultsAggregatedByChecks operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListCisScanResultsAggregatedByChecks
* @see AWS API Documentation
*/
ListCisScanResultsAggregatedByChecksResult listCisScanResultsAggregatedByChecks(
ListCisScanResultsAggregatedByChecksRequest listCisScanResultsAggregatedByChecksRequest);
/**
*
* Lists scan results aggregated by a target resource.
*
*
* @param listCisScanResultsAggregatedByTargetResourceRequest
* @return Result of the ListCisScanResultsAggregatedByTargetResource operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListCisScanResultsAggregatedByTargetResource
* @see AWS API Documentation
*/
ListCisScanResultsAggregatedByTargetResourceResult listCisScanResultsAggregatedByTargetResource(
ListCisScanResultsAggregatedByTargetResourceRequest listCisScanResultsAggregatedByTargetResourceRequest);
/**
*
* Returns a CIS scan list.
*
*
* @param listCisScansRequest
* @return Result of the ListCisScans operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListCisScans
* @see AWS API
* Documentation
*/
ListCisScansResult listCisScans(ListCisScansRequest listCisScansRequest);
/**
*
* Lists coverage details for you environment.
*
*
* @param listCoverageRequest
* @return Result of the ListCoverage operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListCoverage
* @see AWS API
* Documentation
*/
ListCoverageResult listCoverage(ListCoverageRequest listCoverageRequest);
/**
*
* Lists Amazon Inspector coverage statistics for your environment.
*
*
* @param listCoverageStatisticsRequest
* @return Result of the ListCoverageStatistics operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListCoverageStatistics
* @see AWS API Documentation
*/
ListCoverageStatisticsResult listCoverageStatistics(ListCoverageStatisticsRequest listCoverageStatisticsRequest);
/**
*
* Lists information about the Amazon Inspector delegated administrator of your organization.
*
*
* @param listDelegatedAdminAccountsRequest
* @return Result of the ListDelegatedAdminAccounts operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListDelegatedAdminAccounts
* @see AWS API Documentation
*/
ListDelegatedAdminAccountsResult listDelegatedAdminAccounts(ListDelegatedAdminAccountsRequest listDelegatedAdminAccountsRequest);
/**
*
* Lists the filters associated with your account.
*
*
* @param listFiltersRequest
* @return Result of the ListFilters operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListFilters
* @see AWS API
* Documentation
*/
ListFiltersResult listFilters(ListFiltersRequest listFiltersRequest);
/**
*
* Lists aggregated finding data for your environment based on specific criteria.
*
*
* @param listFindingAggregationsRequest
* @return Result of the ListFindingAggregations operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListFindingAggregations
* @see AWS API Documentation
*/
ListFindingAggregationsResult listFindingAggregations(ListFindingAggregationsRequest listFindingAggregationsRequest);
/**
*
* Lists findings for your environment.
*
*
* @param listFindingsRequest
* @return Result of the ListFindings operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListFindings
* @see AWS API
* Documentation
*/
ListFindingsResult listFindings(ListFindingsRequest listFindingsRequest);
/**
*
* List members associated with the Amazon Inspector delegated administrator for your organization.
*
*
* @param listMembersRequest
* @return Result of the ListMembers operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListMembers
* @see AWS API
* Documentation
*/
ListMembersResult listMembers(ListMembersRequest listMembersRequest);
/**
*
* Lists all tags attached to a given resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the Amazon Inspector usage totals over the last 30 days.
*
*
* @param listUsageTotalsRequest
* @return Result of the ListUsageTotals operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ListUsageTotals
* @see AWS API
* Documentation
*/
ListUsageTotalsResult listUsageTotals(ListUsageTotalsRequest listUsageTotalsRequest);
/**
*
* Resets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned
* key.
*
*
* @param resetEncryptionKeyRequest
* @return Result of the ResetEncryptionKey operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.ResetEncryptionKey
* @see AWS
* API Documentation
*/
ResetEncryptionKeyResult resetEncryptionKey(ResetEncryptionKeyRequest resetEncryptionKeyRequest);
/**
*
* Lists Amazon Inspector coverage details for a specific vulnerability.
*
*
* @param searchVulnerabilitiesRequest
* @return Result of the SearchVulnerabilities operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.SearchVulnerabilities
* @see AWS API Documentation
*/
SearchVulnerabilitiesResult searchVulnerabilities(SearchVulnerabilitiesRequest searchVulnerabilitiesRequest);
/**
*
* Sends a CIS session health. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon
* Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID
* supplied by the service.
*
*
* @param sendCisSessionHealthRequest
* @return Result of the SendCisSessionHealth operation returned by the service.
* @throws ConflictException
* A conflict occurred.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.SendCisSessionHealth
* @see AWS API Documentation
*/
SendCisSessionHealthResult sendCisSessionHealth(SendCisSessionHealthRequest sendCisSessionHealthRequest);
/**
*
* Sends a CIS session telemetry. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon
* Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID
* supplied by the service.
*
*
* @param sendCisSessionTelemetryRequest
* @return Result of the SendCisSessionTelemetry operation returned by the service.
* @throws ConflictException
* A conflict occurred.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.SendCisSessionTelemetry
* @see AWS API Documentation
*/
SendCisSessionTelemetryResult sendCisSessionTelemetry(SendCisSessionTelemetryRequest sendCisSessionTelemetryRequest);
/**
*
* Starts a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon
* Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID
* supplied by the service.
*
*
* @param startCisSessionRequest
* @return Result of the StartCisSession operation returned by the service.
* @throws ConflictException
* A conflict occurred.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.StartCisSession
* @see AWS API
* Documentation
*/
StartCisSessionResult startCisSession(StartCisSessionRequest startCisSessionRequest);
/**
*
* Stops a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector
* service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by
* the service.
*
*
* @param stopCisSessionRequest
* @return Result of the StopCisSession operation returned by the service.
* @throws ConflictException
* A conflict occurred.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.StopCisSession
* @see AWS API
* Documentation
*/
StopCisSessionResult stopCisSession(StopCisSessionRequest stopCisSessionRequest);
/**
*
* Adds tags to a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws BadRequestException
* One or more tags submitted as part of the request is not valid.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes tags from a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates a CIS scan configuration.
*
*
* @param updateCisScanConfigurationRequest
* @return Result of the UpdateCisScanConfiguration operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.UpdateCisScanConfiguration
* @see AWS API Documentation
*/
UpdateCisScanConfigurationResult updateCisScanConfiguration(UpdateCisScanConfigurationRequest updateCisScanConfigurationRequest);
/**
*
* Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector
* delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization
* cannot update this setting.
*
*
* @param updateConfigurationRequest
* @return Result of the UpdateConfiguration operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.UpdateConfiguration
* @see AWS
* API Documentation
*/
UpdateConfigurationResult updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest);
/**
*
* Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.
*
*
* @param updateEc2DeepInspectionConfigurationRequest
* @return Result of the UpdateEc2DeepInspectionConfiguration operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.UpdateEc2DeepInspectionConfiguration
* @see AWS API Documentation
*/
UpdateEc2DeepInspectionConfigurationResult updateEc2DeepInspectionConfiguration(
UpdateEc2DeepInspectionConfigurationRequest updateEc2DeepInspectionConfigurationRequest);
/**
*
* Updates an encryption key. A ResourceNotFoundException means that an Amazon Web Services owned key
* is being used for encryption.
*
*
* @param updateEncryptionKeyRequest
* @return Result of the UpdateEncryptionKey operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.UpdateEncryptionKey
* @see AWS
* API Documentation
*/
UpdateEncryptionKeyResult updateEncryptionKey(UpdateEncryptionKeyRequest updateEncryptionKeyRequest);
/**
*
* Specifies the action that is to be applied to the findings that match the filter.
*
*
* @param updateFilterRequest
* @return Result of the UpdateFilter operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ResourceNotFoundException
* The operation tried to access an invalid resource. Make sure the resource is specified correctly.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.UpdateFilter
* @see AWS API
* Documentation
*/
UpdateFilterResult updateFilter(UpdateFilterRequest updateFilterRequest);
/**
*
* Updates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector
* delegated administrator to use this API.
*
*
* @param updateOrgEc2DeepInspectionConfigurationRequest
* @return Result of the UpdateOrgEc2DeepInspectionConfiguration operation returned by the service.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.UpdateOrgEc2DeepInspectionConfiguration
* @see AWS API Documentation
*/
UpdateOrgEc2DeepInspectionConfigurationResult updateOrgEc2DeepInspectionConfiguration(
UpdateOrgEc2DeepInspectionConfigurationRequest updateOrgEc2DeepInspectionConfigurationRequest);
/**
*
* Updates the configurations for your Amazon Inspector organization.
*
*
* @param updateOrganizationConfigurationRequest
* @return Result of the UpdateOrganizationConfiguration operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The request has failed validation due to missing required fields or having invalid inputs.
* @throws ThrottlingException
* The limit on the number of requests per second was exceeded.
* @throws InternalServerException
* The request has failed due to an internal failure of the Amazon Inspector service.
* @sample AWSInspector2.UpdateOrganizationConfiguration
* @see AWS API Documentation
*/
UpdateOrganizationConfigurationResult updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest);
/**
* 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);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy