Skip to content

Starts the specified pipeline

Description

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

Usage

codepipeline_start_pipeline_execution(name, variables,
  clientRequestToken, sourceRevisions)

Arguments

  • name

    [required] The name of the pipeline to start.

  • variables

    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.

  • clientRequestToken

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

  • sourceRevisions

    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.

Value

A list with the following syntax:

list(
  pipelineExecutionId = "string"
)

Request syntax

svc$start_pipeline_execution(
  name = "string",
  variables = list(
    list(
      name = "string",
      value = "string"
    )
  ),
  clientRequestToken = "string",
  sourceRevisions = list(
    list(
      actionName = "string",
      revisionType = "COMMIT_ID"|"IMAGE_DIGEST"|"S3_OBJECT_VERSION_ID"|"S3_OBJECT_KEY",
      revisionValue = "string"
    )
  )
)