SecurityAgent / Client / start_code_review_job

start_code_review_job

SecurityAgent.Client.start_code_review_job(**kwargs)

Starts a new code review job for a code review configuration. The job executes the security-focused code analysis defined in the code review.

See also: AWS API Documentation

Request Syntax

response = client.start_code_review_job(
    agentSpaceId='string',
    codeReviewId='string'
)

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier of the agent space.

• codeReviewId (string) –

  [REQUIRED]

  The unique identifier of the code review to start a job for.

Return type:

dict

Returns:

Response Syntax

{
    'title': 'string',
    'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'FAILED'|'COMPLETED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'codeReviewId': 'string',
    'codeReviewJobId': 'string',
    'agentSpaceId': 'string'
}

Response Structure

• (dict) –

  Output for the StartCodeReviewJob operation.

  • title (string) –

    The title of the code review job.

  • status (string) –

    The current status of the code review job.

  • createdAt (datetime) –

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

  • updatedAt (datetime) –

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

  • codeReviewId (string) –

    The unique identifier of the code review.

  • codeReviewJobId (string) –

    The unique identifier of the started code review job.

  • agentSpaceId (string) –

    The unique identifier of the agent space.