Skip to content

List Rule Executions

codepipeline_list_rule_executions R Documentation

Lists the rule executions that have occurred in a pipeline configured for conditions with rules

Description

Lists the rule executions that have occurred in a pipeline configured for conditions with rules.

Usage

codepipeline_list_rule_executions(pipelineName, filter, maxResults,
  nextToken)

Arguments

pipelineName

[required] The name of the pipeline for which you want to get execution summary information.

filter

Input information used to filter rule execution history.

maxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.

nextToken

The token that was returned from the previous list_rule_executions call, which can be used to return the next set of rule executions in the list.

Value

A list with the following syntax:

list(
  ruleExecutionDetails = list(
    list(
      pipelineExecutionId = "string",
      ruleExecutionId = "string",
      pipelineVersion = 123,
      stageName = "string",
      ruleName = "string",
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdateTime = as.POSIXct(
        "2015-01-01"
      ),
      updatedBy = "string",
      status = "InProgress"|"Abandoned"|"Succeeded"|"Failed",
      input = list(
        ruleTypeId = list(
          category = "Rule",
          owner = "AWS",
          provider = "string",
          version = "string"
        ),
        configuration = list(
          "string"
        ),
        resolvedConfiguration = list(
          "string"
        ),
        roleArn = "string",
        region = "string",
        inputArtifacts = list(
          list(
            name = "string",
            s3location = list(
              bucket = "string",
              key = "string"
            )
          )
        )
      ),
      output = list(
        executionResult = list(
          externalExecutionId = "string",
          externalExecutionSummary = "string",
          externalExecutionUrl = "string",
          errorDetails = list(
            code = "string",
            message = "string"
          )
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_rule_executions(
  pipelineName = "string",
  filter = list(
    pipelineExecutionId = "string",
    latestInPipelineExecution = list(
      pipelineExecutionId = "string",
      startTimeRange = "Latest"|"All"
    )
  ),
  maxResults = 123,
  nextToken = "string"
)