CodeCatalyst / Client / get_workflow_run

get_workflow_run#

CodeCatalyst.Client.get_workflow_run(**kwargs)#

Returns information about a specified run of a workflow.

See also: AWS API Documentation

Request Syntax

response = client.get_workflow_run(
    spaceName='string',
    id='string',
    projectName='string'
)
Parameters:

  • spaceName (string) –

    [REQUIRED]

    The name of the space.

  • id (string) –

    [REQUIRED]

    The ID of the workflow run. To retrieve a list of workflow run IDs, use ListWorkflowRuns.

  • projectName (string) –

    [REQUIRED]

    The name of the project in the space.

Return type:

dict

Returns:

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string',
    'workflowId': '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) –

    • spaceName (string) –

      The name of the space.

    • projectName (string) –

      The name of the project in the space.

    • id (string) –

      The ID of the workflow run.

    • workflowId (string) –

      The ID of the workflow.

    • status (string) –

      The status of the workflow run.

    • statusReasons (list) –

      Information about the reasons for the status of the workflow run.

      • (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 run status was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

Exceptions