inspector2/aws.sdk.kotlin.services.inspector2

Package-level declarations

Types

Link copied to clipboard
interface Inspector2Client : SdkClient

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun Inspector2Client.associateMember(crossinline block: AssociateMemberRequest.Builder.() -> Unit): AssociateMemberResponse

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.

Link copied to clipboard
inline suspend fun Inspector2Client.batchGetAccountStatus(crossinline block: BatchGetAccountStatusRequest.Builder.() -> Unit): BatchGetAccountStatusResponse

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

Link copied to clipboard
inline suspend fun Inspector2Client.batchGetCodeSnippet(crossinline block: BatchGetCodeSnippetRequest.Builder.() -> Unit): BatchGetCodeSnippetResponse

Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.

Link copied to clipboard
inline suspend fun Inspector2Client.batchGetFindingDetails(crossinline block: BatchGetFindingDetailsRequest.Builder.() -> Unit): BatchGetFindingDetailsResponse

Gets vulnerability details for findings.

Link copied to clipboard
inline suspend fun Inspector2Client.batchGetFreeTrialInfo(crossinline block: BatchGetFreeTrialInfoRequest.Builder.() -> Unit): BatchGetFreeTrialInfoResponse

Gets free trial status for multiple Amazon Web Services accounts.

Link copied to clipboard
inline suspend fun Inspector2Client.batchGetMemberEc2DeepInspectionStatus(crossinline block: BatchGetMemberEc2DeepInspectionStatusRequest.Builder.() -> Unit): BatchGetMemberEc2DeepInspectionStatusResponse

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.

Link copied to clipboard
inline suspend fun Inspector2Client.batchUpdateMemberEc2DeepInspectionStatus(crossinline block: BatchUpdateMemberEc2DeepInspectionStatusRequest.Builder.() -> Unit): BatchUpdateMemberEc2DeepInspectionStatusResponse

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.

Link copied to clipboard
inline suspend fun Inspector2Client.cancelFindingsReport(crossinline block: CancelFindingsReportRequest.Builder.() -> Unit): CancelFindingsReportResponse

Cancels the given findings report.

Link copied to clipboard
inline suspend fun Inspector2Client.cancelSbomExport(crossinline block: CancelSbomExportRequest.Builder.() -> Unit): CancelSbomExportResponse

Cancels a software bill of materials (SBOM) report.

Link copied to clipboard
inline suspend fun Inspector2Client.createCisScanConfiguration(crossinline block: CreateCisScanConfigurationRequest.Builder.() -> Unit): CreateCisScanConfigurationResponse

Creates a CIS scan configuration.

Link copied to clipboard
inline suspend fun Inspector2Client.createFilter(crossinline block: CreateFilterRequest.Builder.() -> Unit): CreateFilterResponse

Creates a filter resource using specified filter criteria. When the filter action is set to SUPPRESS this action creates a suppression rule.

Link copied to clipboard
inline suspend fun Inspector2Client.createFindingsReport(crossinline block: CreateFindingsReportRequest.Builder.() -> Unit): CreateFindingsReportResponse

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.

Link copied to clipboard
inline suspend fun Inspector2Client.createSbomExport(crossinline block: CreateSbomExportRequest.Builder.() -> Unit): CreateSbomExportResponse

Creates a software bill of materials (SBOM) report.

Link copied to clipboard
inline suspend fun Inspector2Client.deleteCisScanConfiguration(crossinline block: DeleteCisScanConfigurationRequest.Builder.() -> Unit): DeleteCisScanConfigurationResponse

Deletes a CIS scan configuration.

Link copied to clipboard
inline suspend fun Inspector2Client.deleteFilter(crossinline block: DeleteFilterRequest.Builder.() -> Unit): DeleteFilterResponse

Deletes a filter resource.

Link copied to clipboard
inline suspend fun Inspector2Client.describeOrganizationConfiguration(crossinline block: DescribeOrganizationConfigurationRequest.Builder.() -> Unit): DescribeOrganizationConfigurationResponse

Describe Amazon Inspector configuration settings for an Amazon Web Services organization.

Link copied to clipboard
inline suspend fun Inspector2Client.disable(crossinline block: DisableRequest.Builder.() -> Unit): DisableResponse

Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.

Link copied to clipboard
inline suspend fun Inspector2Client.disableDelegatedAdminAccount(crossinline block: DisableDelegatedAdminAccountRequest.Builder.() -> Unit): DisableDelegatedAdminAccountResponse

Disables the Amazon Inspector delegated administrator for your organization.

Link copied to clipboard
inline suspend fun Inspector2Client.disassociateMember(crossinline block: DisassociateMemberRequest.Builder.() -> Unit): DisassociateMemberResponse

Disassociates a member account from an Amazon Inspector delegated administrator.

Link copied to clipboard
inline suspend fun Inspector2Client.enable(crossinline block: EnableRequest.Builder.() -> Unit): EnableResponse

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

Link copied to clipboard
inline suspend fun Inspector2Client.enableDelegatedAdminAccount(crossinline block: EnableDelegatedAdminAccountRequest.Builder.() -> Unit): EnableDelegatedAdminAccountResponse

Enables the Amazon Inspector delegated administrator for your Organizations organization.

Link copied to clipboard
inline suspend fun Inspector2Client.getCisScanReport(crossinline block: GetCisScanReportRequest.Builder.() -> Unit): GetCisScanReportResponse

Retrieves a CIS scan report.

Link copied to clipboard
inline suspend fun Inspector2Client.getCisScanResultDetails(crossinline block: GetCisScanResultDetailsRequest.Builder.() -> Unit): GetCisScanResultDetailsResponse

Retrieves CIS scan result details.

Link copied to clipboard
inline suspend fun Inspector2Client.getConfiguration(crossinline block: GetConfigurationRequest.Builder.() -> Unit): GetConfigurationResponse

Retrieves setting configurations for Inspector scans.

Link copied to clipboard
inline suspend fun Inspector2Client.getDelegatedAdminAccount(crossinline block: GetDelegatedAdminAccountRequest.Builder.() -> Unit): GetDelegatedAdminAccountResponse

Retrieves information about the Amazon Inspector delegated administrator for your organization.

Link copied to clipboard
inline suspend fun Inspector2Client.getEc2DeepInspectionConfiguration(crossinline block: GetEc2DeepInspectionConfigurationRequest.Builder.() -> Unit): GetEc2DeepInspectionConfigurationResponse

Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.

Link copied to clipboard
inline suspend fun Inspector2Client.getEncryptionKey(crossinline block: GetEncryptionKeyRequest.Builder.() -> Unit): GetEncryptionKeyResponse

Gets an encryption key.

Link copied to clipboard
inline suspend fun Inspector2Client.getFindingsReportStatus(crossinline block: GetFindingsReportStatusRequest.Builder.() -> Unit): GetFindingsReportStatusResponse

Gets the status of a findings report.

Link copied to clipboard
inline suspend fun Inspector2Client.getMember(crossinline block: GetMemberRequest.Builder.() -> Unit): GetMemberResponse

Gets member information for your organization.

Link copied to clipboard
inline suspend fun Inspector2Client.getSbomExport(crossinline block: GetSbomExportRequest.Builder.() -> Unit): GetSbomExportResponse

Gets details of a software bill of materials (SBOM) report.

Link copied to clipboard
inline suspend fun Inspector2Client.listAccountPermissions(crossinline block: ListAccountPermissionsRequest.Builder.() -> Unit): ListAccountPermissionsResponse

Lists the permissions an account has to configure Amazon Inspector.

Link copied to clipboard
inline suspend fun Inspector2Client.listCisScanConfigurations(crossinline block: ListCisScanConfigurationsRequest.Builder.() -> Unit): ListCisScanConfigurationsResponse

Lists CIS scan configurations.

Link copied to clipboard
Link copied to clipboard
inline suspend fun Inspector2Client.listCisScans(crossinline block: ListCisScansRequest.Builder.() -> Unit): ListCisScansResponse

Returns a CIS scan list.

Link copied to clipboard
inline suspend fun Inspector2Client.listCoverage(crossinline block: ListCoverageRequest.Builder.() -> Unit): ListCoverageResponse

Lists coverage details for you environment.

Link copied to clipboard
inline suspend fun Inspector2Client.listCoverageStatistics(crossinline block: ListCoverageStatisticsRequest.Builder.() -> Unit): ListCoverageStatisticsResponse

Lists Amazon Inspector coverage statistics for your environment.

Link copied to clipboard
inline suspend fun Inspector2Client.listDelegatedAdminAccounts(crossinline block: ListDelegatedAdminAccountsRequest.Builder.() -> Unit): ListDelegatedAdminAccountsResponse

Lists information about the Amazon Inspector delegated administrator of your organization.

Link copied to clipboard
inline suspend fun Inspector2Client.listFilters(crossinline block: ListFiltersRequest.Builder.() -> Unit): ListFiltersResponse

Lists the filters associated with your account.

Link copied to clipboard
inline suspend fun Inspector2Client.listFindingAggregations(crossinline block: ListFindingAggregationsRequest.Builder.() -> Unit): ListFindingAggregationsResponse

Lists aggregated finding data for your environment based on specific criteria.

Link copied to clipboard
inline suspend fun Inspector2Client.listFindings(crossinline block: ListFindingsRequest.Builder.() -> Unit): ListFindingsResponse

Lists findings for your environment.

Link copied to clipboard
inline suspend fun Inspector2Client.listMembers(crossinline block: ListMembersRequest.Builder.() -> Unit): ListMembersResponse

List members associated with the Amazon Inspector delegated administrator for your organization.

Link copied to clipboard
inline suspend fun Inspector2Client.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all tags attached to a given resource.

Link copied to clipboard
inline suspend fun Inspector2Client.listUsageTotals(crossinline block: ListUsageTotalsRequest.Builder.() -> Unit): ListUsageTotalsResponse

Lists the Amazon Inspector usage totals over the last 30 days.

Link copied to clipboard
inline suspend fun Inspector2Client.resetEncryptionKey(crossinline block: ResetEncryptionKeyRequest.Builder.() -> Unit): ResetEncryptionKeyResponse

Resets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned key.

Link copied to clipboard
inline suspend fun Inspector2Client.searchVulnerabilities(crossinline block: SearchVulnerabilitiesRequest.Builder.() -> Unit): SearchVulnerabilitiesResponse

Lists Amazon Inspector coverage details for a specific vulnerability.

Link copied to clipboard
inline suspend fun Inspector2Client.sendCisSessionHealth(crossinline block: SendCisSessionHealthRequest.Builder.() -> Unit): SendCisSessionHealthResponse

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.

Link copied to clipboard
inline suspend fun Inspector2Client.sendCisSessionTelemetry(crossinline block: SendCisSessionTelemetryRequest.Builder.() -> Unit): SendCisSessionTelemetryResponse

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.

Link copied to clipboard
inline suspend fun Inspector2Client.startCisSession(crossinline block: StartCisSessionRequest.Builder.() -> Unit): StartCisSessionResponse

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.

Link copied to clipboard
inline suspend fun Inspector2Client.stopCisSession(crossinline block: StopCisSessionRequest.Builder.() -> Unit): StopCisSessionResponse

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.

Link copied to clipboard
inline suspend fun Inspector2Client.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds tags to a resource.

Link copied to clipboard
inline suspend fun Inspector2Client.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from a resource.

Link copied to clipboard
inline suspend fun Inspector2Client.updateCisScanConfiguration(crossinline block: UpdateCisScanConfigurationRequest.Builder.() -> Unit): UpdateCisScanConfigurationResponse

Updates a CIS scan configuration.

Link copied to clipboard
inline suspend fun Inspector2Client.updateConfiguration(crossinline block: UpdateConfigurationRequest.Builder.() -> Unit): UpdateConfigurationResponse

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.

Link copied to clipboard
inline suspend fun Inspector2Client.updateEc2DeepInspectionConfiguration(crossinline block: UpdateEc2DeepInspectionConfigurationRequest.Builder.() -> Unit): UpdateEc2DeepInspectionConfigurationResponse

Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.

Link copied to clipboard
inline suspend fun Inspector2Client.updateEncryptionKey(crossinline block: UpdateEncryptionKeyRequest.Builder.() -> Unit): UpdateEncryptionKeyResponse

Updates an encryption key. A ResourceNotFoundException means that an Amazon Web Services owned key is being used for encryption.

Link copied to clipboard
inline suspend fun Inspector2Client.updateFilter(crossinline block: UpdateFilterRequest.Builder.() -> Unit): UpdateFilterResponse

Specifies the action that is to be applied to the findings that match the filter.

Link copied to clipboard
inline suspend fun Inspector2Client.updateOrganizationConfiguration(crossinline block: UpdateOrganizationConfigurationRequest.Builder.() -> Unit): UpdateOrganizationConfigurationResponse

Updates the configurations for your Amazon Inspector organization.

Link copied to clipboard
inline suspend fun Inspector2Client.updateOrgEc2DeepInspectionConfiguration(crossinline block: UpdateOrgEc2DeepInspectionConfigurationRequest.Builder.() -> Unit): UpdateOrgEc2DeepInspectionConfigurationResponse

Updates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector delegated administrator to use this API.

Link copied to clipboard
fun Inspector2Client.withConfig(block: Inspector2Client.Config.Builder.() -> Unit): Inspector2Client

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.