ListRuleExecutionsOutput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-codepipeline/json-schema/amazon-codepipeline-list-rule-executions-output-schema.json",
  "title": "ListRuleExecutionsOutput",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-codepipeline-operations-api-openapi.yml#/components/schemas/ListRuleExecutionsOutput",
  "type": "object",
  "properties": {
    "ruleExecutionDetails": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/RuleExecutionDetail"
      },
      "description": "Details about the output for listing rule executions."
    },
    "nextToken": {
      "type": "string",
      "description": "A token that can be used in the next ListRuleExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned."
    }
  },
  "$defs": {
    "ArtifactDetail": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The artifact object name for the action execution."
        },
        "s3location": {
          "$ref": "#/$defs/S3Location"
        }
      }
    },
    "ErrorDetails": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The system ID or number code of the error."
        },
        "message": {
          "type": "string",
          "description": "The text of the error message."
        }
      }
    },
    "RuleExecutionDetail": {
      "type": "object",
      "properties": {
        "pipelineExecutionId": {
          "type": "string",
          "description": "The ID of the pipeline execution in the stage where the rule was run. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the stage."
        },
        "ruleExecutionId": {
          "type": "string",
          "description": "The ID of the run for the rule."
        },
        "pipelineVersion": {
          "type": "integer",
          "description": "The version number of the pipeline with the stage where the rule was run."
        },
        "stageName": {
          "type": "string",
          "description": "The name of the stage where the rule was run."
        },
        "ruleName": {
          "type": "string",
          "description": "The name of the rule that was run in the stage."
        },
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "The start time of the rule execution."
        },
        "lastUpdateTime": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time of the last change to the rule execution, in timestamp format."
        },
        "updatedBy": {
          "type": "string",
          "description": "The ARN of the user who changed the rule execution details."
        },
        "status": {
          "type": "string",
          "enum": [
            "InProgress",
            "Abandoned",
            "Succeeded",
            "Failed"
          ],
          "description": "The status of the rule execution. Status categories are InProgress, Succeeded, and Failed."
        },
        "input": {
          "$ref": "#/$defs/RuleExecutionInput"
        },
        "output": {
          "$ref": "#/$defs/RuleExecutionOutput"
        }
      }
    },
    "RuleExecutionInput": {
      "type": "object",
      "properties": {
        "ruleTypeId": {
          "$ref": "#/$defs/RuleTypeId"
        },
        "configuration": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Configuration data for a rule execution, such as the resolved values for that run."
        },
        "resolvedConfiguration": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Configuration data for a rule execution with all variable references replaced with their real values for the execution."
        },
        "roleArn": {
          "type": "string",
          "description": "The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline."
        },
        "region": {
          "type": "string",
          "description": "The Amazon Web Services Region for the rule, such as us-east-1."
        },
        "inputArtifacts": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ArtifactDetail"
          },
          "description": "Details of input artifacts of the rule that correspond to the rule execution."
        }
      }
    },
    "RuleExecutionOutput": {
      "type": "object",
      "properties": {
        "executionResult": {
          "$ref": "#/$defs/RuleExecutionResult"
        }
      }
    },
    "RuleExecutionResult": {
      "type": "object",
      "properties": {
        "externalExecutionId": {
          "type": "string",
          "description": "The external ID for the rule execution."
        },
        "externalExecutionSummary": {
          "type": "string",
          "description": "The external provider summary for the rule execution."
        },
        "externalExecutionUrl": {
          "type": "string",
          "description": "The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the rule."
        },
        "errorDetails": {
          "$ref": "#/$defs/ErrorDetails"
        }
      }
    },
    "RuleTypeId": {
      "type": "object",
      "properties": {
        "category": {
          "type": "string",
          "enum": [
            "Rule"
          ],
          "description": "A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. The valid category is Rule."
        },
        "owner": {
          "type": "string",
          "enum": [
            "AWS"
          ],
          "description": "The creator of the rule being called. The valid value for the Owner field in the rule category is AWS."
        },
        "provider": {
          "type": "string",
          "description": "The rule provider, such as the DeploymentWindow rule. For a list of rule provider names, see the rules listed in the CodePipeline rule reference."
        },
        "version": {
          "type": "string",
          "description": "A string that describes the rule version."
        }
      },
      "required": [
        "category",
        "provider"
      ]
    },
    "S3Location": {
      "type": "object",
      "properties": {
        "bucket": {
          "type": "string",
          "description": "The Amazon S3 artifact bucket for an action's artifacts."
        },
        "key": {
          "type": "string",
          "description": "The artifact name."
        }
      }
    }
  }
}