CodeCatalyst / Paginator / ListWorkflowRuns
ListWorkflowRuns#
- class CodeCatalyst.Paginator.ListWorkflowRuns#
paginator = client.get_paginator('list_workflow_runs')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
CodeCatalyst.Client.list_workflow_runs()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( spaceName='string', workflowId='string', projectName='string', sortBy=[ {} , ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
spaceName (string) –
[REQUIRED]
The name of the space.
workflowId (string) – The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.
projectName (string) –
[REQUIRED]
The name of the project in the space.
sortBy (list) –
Information used to sort the items in the returned list.
(dict) –
Information used to sort workflow runs in the returned list.
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
NextToken
will 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
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'items': [ { 'id': 'string', 'workflowId': 'string', 'workflowName': 'string', 'status': 'SUCCEEDED'|'FAILED'|'STOPPED'|'SUPERSEDED'|'CANCELLED'|'NOT_RUN'|'VALIDATING'|'PROVISIONING'|'IN_PROGRESS'|'STOPPING'|'ABANDONED', 'statusReasons': [ {}, ], 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'lastUpdatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
items (list) –
Information about the runs of a workflow.
(dict) –
Information about a workflow run.
id (string) –
The system-generated unique ID of the workflow run.
workflowId (string) –
The system-generated unique ID of the workflow.
workflowName (string) –
The name of the workflow.
status (string) –
The status of the workflow run.
statusReasons (list) –
The reasons for the workflow run status.
(dict) –
Information about the status of a workflow run.
startTime (datetime) –
The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
endTime (datetime) –
The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
lastUpdatedTime (datetime) –
The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
NextToken (string) –
A token to resume pagination.