CodeGuruSecurityClient

Amazon CodeGuru Security is in preview release and is subject to change.

This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.

By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide.

Properties

Link copied to clipboard
abstract override val config: CodeGuruSecurityClient.Config

CodeGuruSecurityClient's configuration

Functions

Link copied to clipboard

Returns a list of requested findings from standard scans.

Link copied to clipboard
abstract suspend fun createScan(input: CreateScanRequest): CreateScanResponse

Use to create a scan using code uploaded to an Amazon S3 bucket.

Link copied to clipboard

Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.

Link copied to clipboard
abstract suspend fun getAccountConfiguration(input: GetAccountConfigurationRequest = GetAccountConfigurationRequest { }): GetAccountConfigurationResponse

Use to get the encryption configuration for an account.

Link copied to clipboard
abstract suspend fun getFindings(input: GetFindingsRequest): GetFindingsResponse

Returns a list of all findings generated by a particular scan.

Link copied to clipboard

Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.

Link copied to clipboard
abstract suspend fun getScan(input: GetScanRequest): GetScanResponse

Returns details about a scan, including whether or not a scan has completed.

Link copied to clipboard

Returns metrics about all findings in an account within a specified time range.

Link copied to clipboard
abstract suspend fun listScans(input: ListScansRequest = ListScansRequest { }): ListScansResponse

Returns a list of all scans in an account. Does not return EXPRESS scans.

Link copied to clipboard

Returns a list of all tags associated with a scan.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Use to add one or more tags to an existing scan.

Link copied to clipboard

Use to remove one or more tags from an existing scan.

Link copied to clipboard

Use to update the encryption configuration for an account.

Inherited functions

Link copied to clipboard

Returns a list of requested findings from standard scans.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Use to create a scan using code uploaded to an Amazon S3 bucket.

Link copied to clipboard

Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.

Link copied to clipboard

Use to get the encryption configuration for an account.

Link copied to clipboard

Returns a list of all findings generated by a particular scan.

Link copied to clipboard

Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.

Link copied to clipboard
inline suspend fun CodeGuruSecurityClient.getScan(crossinline block: GetScanRequest.Builder.() -> Unit): GetScanResponse

Returns details about a scan, including whether or not a scan has completed.

Link copied to clipboard

Returns metrics about all findings in an account within a specified time range.

Link copied to clipboard

Returns a list of all scans in an account. Does not return EXPRESS scans.

Link copied to clipboard
Link copied to clipboard

Returns a list of all tags associated with a scan.

Link copied to clipboard

Use to add one or more tags to an existing scan.

Link copied to clipboard

Use to remove one or more tags from an existing scan.

Link copied to clipboard

Use to update the encryption configuration for an account.

Link copied to clipboard

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.