CodeCatalyst / Client / get_workflow

get_workflow

CodeCatalyst.Client.get_workflow(**kwargs)

Returns information about a workflow.

See also: AWS API Documentation

Request Syntax

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

  • spaceName (string) –

    [REQUIRED]

    The name of the space.

  • id (string) –

    [REQUIRED]

    The ID of the workflow. To rerieve a list of workflow IDs, use ListWorkflows.

  • projectName (string) –

    [REQUIRED]

    The name of the project in the space.

Return type:

dict

Returns:

Response Syntax

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

    • spaceName (string) –

      The name of the space.

    • projectName (string) –

      The name of the project in the space.

    • id (string) –

      The ID of the workflow.

    • name (string) –

      The name of the workflow.

    • sourceRepositoryName (string) –

      The name of the source repository where the workflow YAML is stored.

    • sourceBranchName (string) –

      The name of the branch that contains the workflow YAML.

    • definition (dict) –

      Information about the workflow definition file for the workflow.

      • 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 behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.

    • status (string) –

      The status of the workflow.

Exceptions