CodeCatalyst / Paginator / ListWorkflows
ListWorkflows#
- class CodeCatalyst.Paginator.ListWorkflows#
paginator = client.get_paginator('list_workflows')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
CodeCatalyst.Client.list_workflows()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( spaceName='string', projectName='string', sortBy=[ {} , ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
spaceName (string) –
[REQUIRED]
The name of the space.
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 workflows 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', 'name': 'string', 'sourceRepositoryName': 'string', 'sourceBranchName': 'string', 'definition': { 'path': 'string' }, 'createdTime': datetime(2015, 1, 1), 'lastUpdatedTime': datetime(2015, 1, 1), 'runMode': 'QUEUED'|'PARALLEL'|'SUPERSEDED', 'status': 'INVALID'|'ACTIVE' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
items (list) –
Information about the workflows in a project.
(dict) –
Information about a workflow.
id (string) –
The system-generated unique ID of a workflow.
name (string) –
The name of the workflow.
sourceRepositoryName (string) –
The name of the source repository where the workflow definition file is stored.
sourceBranchName (string) –
The name of the branch of the source repository where the workflow definition file is stored.
definition (dict) –
Information about the workflow definition file.
path (string) –
The path to the workflow definition file stored in the source repository for the project, including the file name.
createdTime (datetime) –
The date and time the workflow was created, 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
runMode (string) –
The run mode of the workflow.
status (string) –
The status of the workflow.
NextToken (string) –
A token to resume pagination.