Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
Request Syntax
{
"filter": {
"latestInPipelineExecution": {
"pipelineExecutionId": "string",
"startTimeRange": "string"
},
"pipelineExecutionId": "string"
},
"maxResults": number,
"nextToken": "string",
"pipelineName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- filter
-
Input information used to filter rule execution history.
Type: RuleExecutionFilter object
Required: No
- 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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
The token that was returned from the previous
ListRuleExecutionscall, which can be used to return the next set of rule executions in the list.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- pipelineName
-
The name of the pipeline for which you want to get execution summary information.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9.@\-_]+Required: Yes
Response Syntax
{
"nextToken": "string",
"ruleExecutionDetails": [
{
"input": {
"configuration": {
"string" : "string"
},
"inputArtifacts": [
{
"name": "string",
"s3location": {
"bucket": "string",
"key": "string"
}
}
],
"region": "string",
"resolvedConfiguration": {
"string" : "string"
},
"roleArn": "string",
"ruleTypeId": {
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
}
},
"lastUpdateTime": number,
"output": {
"executionResult": {
"errorDetails": {
"code": "string",
"message": "string"
},
"externalExecutionId": "string",
"externalExecutionSummary": "string",
"externalExecutionUrl": "string"
}
},
"pipelineExecutionId": "string",
"pipelineVersion": number,
"ruleExecutionId": "string",
"ruleName": "string",
"stageName": "string",
"startTime": number,
"status": "string",
"updatedBy": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
A token that can be used in the next
ListRuleExecutionscall. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- ruleExecutionDetails
-
Details about the output for listing rule executions.
Type: Array of RuleExecutionDetail objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextTokenException
-
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
HTTP Status Code: 400
- PipelineExecutionNotFoundException
-
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
HTTP Status Code: 400
- PipelineNotFoundException
-
The pipeline was specified in an invalid format or cannot be found.
HTTP Status Code: 400
- ValidationException
-
The validation was specified in an invalid format.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
