Get Pipeline State

codepipeline_get_pipeline_state

R Documentation

Returns information about the state of a pipeline, including the stages and actions

Description

Returns information about the state of a pipeline, including the stages and actions.

Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

Usage

codepipeline_get_pipeline_state(name)

Arguments

name

[required] The name of the pipeline about which you want to get information.

Value

A list with the following syntax:

list(
  pipelineName = "string",
  pipelineVersion = 123,
  stageStates = list(
    list(
      stageName = "string",
      inboundExecution = list(
        pipelineExecutionId = "string",
        status = "Cancelled"|"InProgress"|"Failed"|"Stopped"|"Stopping"|"Succeeded",
        type = "STANDARD"|"ROLLBACK"
      ),
      inboundExecutions = list(
        list(
          pipelineExecutionId = "string",
          status = "Cancelled"|"InProgress"|"Failed"|"Stopped"|"Stopping"|"Succeeded",
          type = "STANDARD"|"ROLLBACK"
        )
      ),
      inboundTransitionState = list(
        enabled = TRUE|FALSE,
        lastChangedBy = "string",
        lastChangedAt = as.POSIXct(
          "2015-01-01"
        ),
        disabledReason = "string"
      ),
      actionStates = list(
        list(
          actionName = "string",
          currentRevision = list(
            revisionId = "string",
            revisionChangeId = "string",
            created = as.POSIXct(
              "2015-01-01"
            )
          ),
          latestExecution = list(
            actionExecutionId = "string",
            status = "InProgress"|"Abandoned"|"Succeeded"|"Failed",
            summary = "string",
            lastStatusChange = as.POSIXct(
              "2015-01-01"
            ),
            token = "string",
            lastUpdatedBy = "string",
            externalExecutionId = "string",
            externalExecutionUrl = "string",
            percentComplete = 123,
            errorDetails = list(
              code = "string",
              message = "string"
            )
          ),
          entityUrl = "string",
          revisionUrl = "string"
        )
      ),
      latestExecution = list(
        pipelineExecutionId = "string",
        status = "Cancelled"|"InProgress"|"Failed"|"Stopped"|"Stopping"|"Succeeded",
        type = "STANDARD"|"ROLLBACK"
      ),
      beforeEntryConditionState = list(
        latestExecution = list(
          status = "InProgress"|"Failed"|"Errored"|"Succeeded"|"Cancelled"|"Abandoned"|"Overridden",
          summary = "string"
        ),
        conditionStates = list(
          list(
            latestExecution = list(
              status = "InProgress"|"Failed"|"Errored"|"Succeeded"|"Cancelled"|"Abandoned"|"Overridden",
              summary = "string",
              lastStatusChange = as.POSIXct(
                "2015-01-01"
              )
            ),
            ruleStates = list(
              list(
                ruleName = "string",
                currentRevision = list(
                  revisionId = "string",
                  revisionChangeId = "string",
                  created = as.POSIXct(
                    "2015-01-01"
                  )
                ),
                latestExecution = list(
                  ruleExecutionId = "string",
                  status = "InProgress"|"Abandoned"|"Succeeded"|"Failed",
                  summary = "string",
                  lastStatusChange = as.POSIXct(
                    "2015-01-01"
                  ),
                  token = "string",
                  lastUpdatedBy = "string",
                  externalExecutionId = "string",
                  externalExecutionUrl = "string",
                  errorDetails = list(
                    code = "string",
                    message = "string"
                  )
                ),
                entityUrl = "string",
                revisionUrl = "string"
              )
            )
          )
        )
      ),
      onSuccessConditionState = list(
        latestExecution = list(
          status = "InProgress"|"Failed"|"Errored"|"Succeeded"|"Cancelled"|"Abandoned"|"Overridden",
          summary = "string"
        ),
        conditionStates = list(
          list(
            latestExecution = list(
              status = "InProgress"|"Failed"|"Errored"|"Succeeded"|"Cancelled"|"Abandoned"|"Overridden",
              summary = "string",
              lastStatusChange = as.POSIXct(
                "2015-01-01"
              )
            ),
            ruleStates = list(
              list(
                ruleName = "string",
                currentRevision = list(
                  revisionId = "string",
                  revisionChangeId = "string",
                  created = as.POSIXct(
                    "2015-01-01"
                  )
                ),
                latestExecution = list(
                  ruleExecutionId = "string",
                  status = "InProgress"|"Abandoned"|"Succeeded"|"Failed",
                  summary = "string",
                  lastStatusChange = as.POSIXct(
                    "2015-01-01"
                  ),
                  token = "string",
                  lastUpdatedBy = "string",
                  externalExecutionId = "string",
                  externalExecutionUrl = "string",
                  errorDetails = list(
                    code = "string",
                    message = "string"
                  )
                ),
                entityUrl = "string",
                revisionUrl = "string"
              )
            )
          )
        )
      ),
      onFailureConditionState = list(
        latestExecution = list(
          status = "InProgress"|"Failed"|"Errored"|"Succeeded"|"Cancelled"|"Abandoned"|"Overridden",
          summary = "string"
        ),
        conditionStates = list(
          list(
            latestExecution = list(
              status = "InProgress"|"Failed"|"Errored"|"Succeeded"|"Cancelled"|"Abandoned"|"Overridden",
              summary = "string",
              lastStatusChange = as.POSIXct(
                "2015-01-01"
              )
            ),
            ruleStates = list(
              list(
                ruleName = "string",
                currentRevision = list(
                  revisionId = "string",
                  revisionChangeId = "string",
                  created = as.POSIXct(
                    "2015-01-01"
                  )
                ),
                latestExecution = list(
                  ruleExecutionId = "string",
                  status = "InProgress"|"Abandoned"|"Succeeded"|"Failed",
                  summary = "string",
                  lastStatusChange = as.POSIXct(
                    "2015-01-01"
                  ),
                  token = "string",
                  lastUpdatedBy = "string",
                  externalExecutionId = "string",
                  externalExecutionUrl = "string",
                  errorDetails = list(
                    code = "string",
                    message = "string"
                  )
                ),
                entityUrl = "string",
                revisionUrl = "string"
              )
            )
          )
        )
      )
    )
  ),
  created = as.POSIXct(
    "2015-01-01"
  ),
  updated = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_pipeline_state(
  name = "string"
)