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', variables=[ { 'name': 'string', 'value': 'string' }, ], clientRequestToken='string', sourceRevisions=[ { 'actionName': 'string', 'revisionType': 'COMMIT_ID'|'IMAGE_DIGEST'|'S3_OBJECT_VERSION_ID', 'revisionValue': 'string' }, ] )
- Parameters:
name (string) –
[REQUIRED]
The name of the pipeline to start.
variables (list) –
A list that overrides pipeline variables for a pipeline execution that’s being started. Variable names must match
[A-Za-z0-9@\-_]+
, and the values can be anything except an empty string.(dict) –
A pipeline-level variable used for a pipeline execution.
Note
V2 type pipelines, along with triggers on Git tags and pipeline-level variables, are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types in the CodePipeline User Guide.
name (string) – [REQUIRED]
The name of a pipeline-level variable.
value (string) – [REQUIRED]
The value of a pipeline-level variable.
clientRequestToken (string) –
The system-generated unique ID used to identify a unique execution request.
This field is autopopulated if not provided.
sourceRevisions (list) –
A list that allows you to specify, or override, the source revision for a pipeline execution that’s being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.
(dict) –
A list that allows you to specify, or override, the source revision for a pipeline execution that’s being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.
actionName (string) – [REQUIRED]
The name of the action where the override will be applied.
revisionType (string) – [REQUIRED]
The type of source revision, based on the source provider. For example, the revision type for the CodeCommit action provider is the commit ID.
revisionValue (string) – [REQUIRED]
The source revision, or version of your source artifact, with the changes that you want to run in the pipeline execution.
- 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