CodePipeline / Client / start_pipeline_execution

start_pipeline_execution#

CodePipeline.Client.start_pipeline_execution(**kwargs)#

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

See also: AWS API Documentation

Request Syntax

response = client.start_pipeline_execution(
    name='string',
    clientRequestToken='string'
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the pipeline to start.

  • clientRequestToken (string) –

    The system-generated unique ID used to identify a unique execution request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'pipelineExecutionId': 'string'
}

Response Structure

  • (dict) –

    Represents the output of a StartPipelineExecution action.

    • pipelineExecutionId (string) –

      The unique system-generated ID of the pipeline execution that was started.

Exceptions

  • CodePipeline.Client.exceptions.ValidationException

  • CodePipeline.Client.exceptions.ConflictException

  • CodePipeline.Client.exceptions.PipelineNotFoundException