CodeCatalyst / Client / start_workflow_run

start_workflow_run#

CodeCatalyst.Client.start_workflow_run(**kwargs)#

Begins a run of a specified workflow.

See also: AWS API Documentation

Request Syntax

response = client.start_workflow_run(
    spaceName='string',
    projectName='string',
    workflowId='string',
    clientToken='string'
)
Parameters:

  • spaceName (string) –

    [REQUIRED]

    The name of the space.

  • projectName (string) –

    [REQUIRED]

    The name of the project in the space.

  • workflowId (string) –

    [REQUIRED]

    The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

  • clientToken (string) –

    A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string',
    'workflowId': 'string'
}

Response Structure

  • (dict) –

    • spaceName (string) –

      The name of the space.

    • projectName (string) –

      The name of the project in the space.

    • id (string) –

      The system-generated unique ID of the workflow run.

    • workflowId (string) –

      The system-generated unique ID of the workflow.

Exceptions