Get Pipeline

codepipeline_get_pipeline

R Documentation

Returns the metadata, structure, stages, and actions of a pipeline

Description

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with update_pipeline.

Usage

codepipeline_get_pipeline(name, version)

Arguments

name

[required] The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.

version

The version number of the pipeline. If you do not specify a version, defaults to the current version.

Value

A list with the following syntax:

list(
  pipeline = list(
    name = "string",
    roleArn = "string",
    artifactStore = list(
      type = "S3",
      location = "string",
      encryptionKey = list(
        id = "string",
        type = "KMS"
      )
    ),
    artifactStores = list(
      list(
        type = "S3",
        location = "string",
        encryptionKey = list(
          id = "string",
          type = "KMS"
        )
      )
    ),
    stages = list(
      list(
        name = "string",
        blockers = list(
          list(
            name = "string",
            type = "Schedule"
          )
        ),
        actions = list(
          list(
            name = "string",
            actionTypeId = list(
              category = "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval",
              owner = "AWS"|"ThirdParty"|"Custom",
              provider = "string",
              version = "string"
            ),
            runOrder = 123,
            configuration = list(
              "string"
            ),
            outputArtifacts = list(
              list(
                name = "string"
              )
            ),
            inputArtifacts = list(
              list(
                name = "string"
              )
            ),
            roleArn = "string",
            region = "string",
            namespace = "string",
            timeoutInMinutes = 123
          )
        ),
        onFailure = list(
          result = "ROLLBACK"|"FAIL",
          conditions = list(
            list(
              result = "ROLLBACK"|"FAIL",
              rules = list(
                list(
                  name = "string",
                  ruleTypeId = list(
                    category = "Rule",
                    owner = "AWS",
                    provider = "string",
                    version = "string"
                  ),
                  configuration = list(
                    "string"
                  ),
                  inputArtifacts = list(
                    list(
                      name = "string"
                    )
                  ),
                  roleArn = "string",
                  region = "string",
                  timeoutInMinutes = 123
                )
              )
            )
          )
        ),
        onSuccess = list(
          conditions = list(
            list(
              result = "ROLLBACK"|"FAIL",
              rules = list(
                list(
                  name = "string",
                  ruleTypeId = list(
                    category = "Rule",
                    owner = "AWS",
                    provider = "string",
                    version = "string"
                  ),
                  configuration = list(
                    "string"
                  ),
                  inputArtifacts = list(
                    list(
                      name = "string"
                    )
                  ),
                  roleArn = "string",
                  region = "string",
                  timeoutInMinutes = 123
                )
              )
            )
          )
        ),
        beforeEntry = list(
          conditions = list(
            list(
              result = "ROLLBACK"|"FAIL",
              rules = list(
                list(
                  name = "string",
                  ruleTypeId = list(
                    category = "Rule",
                    owner = "AWS",
                    provider = "string",
                    version = "string"
                  ),
                  configuration = list(
                    "string"
                  ),
                  inputArtifacts = list(
                    list(
                      name = "string"
                    )
                  ),
                  roleArn = "string",
                  region = "string",
                  timeoutInMinutes = 123
                )
              )
            )
          )
        )
      )
    ),
    version = 123,
    executionMode = "QUEUED"|"SUPERSEDED"|"PARALLEL",
    pipelineType = "V1"|"V2",
    variables = list(
      list(
        name = "string",
        defaultValue = "string",
        description = "string"
      )
    ),
    triggers = list(
      list(
        providerType = "CodeStarSourceConnection",
        gitConfiguration = list(
          sourceActionName = "string",
          push = list(
            list(
              tags = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              ),
              branches = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              ),
              filePaths = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              )
            )
          ),
          pullRequest = list(
            list(
              events = list(
                "OPEN"|"UPDATED"|"CLOSED"
              ),
              branches = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              ),
              filePaths = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              )
            )
          )
        )
      )
    )
  ),
  metadata = list(
    pipelineArn = "string",
    created = as.POSIXct(
      "2015-01-01"
    ),
    updated = as.POSIXct(
      "2015-01-01"
    ),
    pollingDisabledAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$get_pipeline(
  name = "string",
  version = 123
)