SecurityAgent / Paginator / ListCodeReviewJobsForCodeReview
ListCodeReviewJobsForCodeReview¶
- class SecurityAgent.Paginator.ListCodeReviewJobsForCodeReview¶
paginator = client.get_paginator('list_code_review_jobs_for_code_review')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
SecurityAgent.Client.list_code_review_jobs_for_code_review().See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( codeReviewId='string', agentSpaceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
codeReviewId (string) –
[REQUIRED]
The unique identifier of the code review to list jobs for.
agentSpaceId (string) –
[REQUIRED]
The unique identifier of the agent space.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextTokenwill be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextTokenfrom a previous response.
- 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 resume pagination.