SecurityAgent / Client / list_code_review_jobs_for_code_review

list_code_review_jobs_for_code_review

SecurityAgent.Client.list_code_review_jobs_for_code_review(**kwargs)

Returns a paginated list of code review job summaries for the specified code review configuration.

See also: AWS API Documentation

Request Syntax

response = client.list_code_review_jobs_for_code_review(
    maxResults=123,
    codeReviewId='string',
    agentSpaceId='string',
    nextToken='string'
)
Parameters:

  • maxResults (integer) – The maximum number of results to return in a single call.

  • codeReviewId (string) –

    [REQUIRED]

    The unique identifier of the code review to list jobs for.

  • agentSpaceId (string) –

    [REQUIRED]

    The unique identifier of the agent space.

  • nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    Output for the ListCodeReviewJobsForCodeReview operation.

    • codeReviewJobSummaries (list) –

      The list of code review job summaries.

      • (dict) –

        Contains summary information about a code review job.

        • codeReviewJobId (string) –

          The unique identifier of the code review job.

        • codeReviewId (string) –

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

        • 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.

    • nextToken (string) –

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.