View a markdown version of this page

CodeReviewJob - AWS Security Agent

CodeReviewJob

Represents a code review job, which is an execution instance of a code review. A code review job progresses through preflight, static analysis, and finalizing steps.

Contents

codeRemediationStrategy

The code remediation strategy for the code review job.

Type: String

Valid Values: AUTOMATIC | DISABLED

Required: No

codeReviewId

The unique identifier of the code review associated with the job.

Type: String

Required: No

codeReviewJobId

The unique identifier of the code review job.

Type: String

Required: No

createdAt

The date and time the code review job was created, in UTC format.

Type: Timestamp

Required: No

documents

The list of documents providing context for the code review job.

Type: Array of DocumentInfo objects

Required: No

errorInformation

Error information if the code review job encountered an error.

Type: ErrorInformation object

Required: No

executionContext

The execution context messages for the code review job.

Type: Array of ExecutionContext objects

Required: No

integratedRepositories

The list of integrated repositories associated with the code review job.

Type: Array of IntegratedRepository objects

Required: No

logConfig

The CloudWatch Logs configuration for the code review job.

Type: CloudWatchLog object

Required: No

overview

An overview of the code review job results.

Type: String

Required: No

serviceRole

The IAM service role used for the code review job.

Type: String

Required: No

sourceCode

The list of source code repositories analyzed during the code review job.

Type: Array of SourceCodeRepository objects

Required: No

status

The current status of the code review job.

Type: String

Valid Values: IN_PROGRESS | STOPPING | STOPPED | FAILED | COMPLETED

Required: No

steps

The list of steps in the code review job execution.

Type: Array of Step objects

Required: No

title

The title of the code review job.

Type: String

Required: No

updatedAt

The date and time the code review job was last updated, in UTC format.

Type: Timestamp

Required: No

See Also

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