CodeCatalyst / Client / list_workflow_runs

list_workflow_runs

CodeCatalyst.Client.list_workflow_runs(**kwargs)

Retrieves a list of workflow runs of a specified workflow.

See also: AWS API Documentation

Request Syntax

response = client.list_workflow_runs(
    spaceName='string',
    workflowId='string',
    projectName='string',
    nextToken='string',
    maxResults=123,
    sortBy=[
        {}
        ,
    ]
)

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.

• 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 workflow runs in the returned list.

Return type:

dict

Returns:

Response Syntax

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

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

Exceptions

• CodeCatalyst.Client.exceptions.ThrottlingException

• CodeCatalyst.Client.exceptions.ConflictException

• CodeCatalyst.Client.exceptions.ValidationException

• CodeCatalyst.Client.exceptions.ServiceQuotaExceededException

• CodeCatalyst.Client.exceptions.ResourceNotFoundException

• CodeCatalyst.Client.exceptions.AccessDeniedException