CodeCatalyst / Client / list_workflows

list_workflows#

CodeCatalyst.Client.list_workflows(**kwargs)#

Retrieves a list of workflows in a specified project.

See also: AWS API Documentation

Request Syntax

response = client.list_workflows(
    spaceName='string',
    projectName='string',
    nextToken='string',
    maxResults=123,
    sortBy=[
        {}
        ,
    ]
)
Parameters:

  • spaceName (string) –

    [REQUIRED]

    The name of the space.

  • projectName (string) –

    [REQUIRED]

    The name of the project in the space.

  • nextToken (string) – A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults (integer) – The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

  • sortBy (list) –

    Information used to sort the items in the returned list.

    • (dict) –

      Information used to sort workflows in the returned list.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      A token returned from a call to this API to indicate the next batch of results to return, if any.

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

Exceptions