ScanSummary - Amazon CodeGuru Security

ScanSummary

Information about a scan.

Contents

createdAt

The time when the scan was created.

Type: Timestamp

Required: Yes

runId

The identifier for the scan run.

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

scanName

The name of the scan.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 140.

Pattern: ^[a-zA-Z0-9-_$:.]*$

Required: Yes

scanState

The state of the scan. A scan can be In Progress, Complete, or Failed.

Type: String

Valid Values: InProgress | Successful | Failed

Required: Yes

scanNameArn

The ARN for the scan name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Pattern: ^arn:aws:codeguru-security:[\S]+:[\d]{12}:scans\/[a-zA-Z0-9-_$:.]*$

Required: No

updatedAt

The time the scan was last updated. A scan is updated when it is re-run.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: