DescribeAutomationExecutions
Provides details about all active and terminated Automation executions.
Request Syntax
{ "Filters": [ { "Key": "
string
", "Values": [ "string
" ] } ], "MaxResults":number
, "NextToken": "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.
- Filters
-
Filters used to limit the scope of executions that are requested.
Type: Array of AutomationExecutionFilter objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- MaxResults
-
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- NextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Required: No
Response Syntax
{ "AutomationExecutionMetadataList": [ { "AutomationExecutionId": "string", "AutomationExecutionStatus": "string", "AutomationType": "string", "CurrentAction": "string", "CurrentStepName": "string", "DocumentName": "string", "DocumentVersion": "string", "ExecutedBy": "string", "ExecutionEndTime": number, "ExecutionStartTime": number, "FailureMessage": "string", "LogFile": "string", "MaxConcurrency": "string", "MaxErrors": "string", "Mode": "string", "Outputs": { "string" : [ "string" ] }, "ParentAutomationExecutionId": "string", "ResolvedTargets": { "ParameterValues": [ "string" ], "Truncated": boolean }, "Target": "string", "TargetMaps": [ { "string" : [ "string" ] } ], "TargetParameterName": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ] } ], "NextToken": "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.
- AutomationExecutionMetadataList
-
The list of details about each automation execution which has occurred which matches the filter specification, if any.
Type: Array of AutomationExecutionMetadata objects
- NextToken
-
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidFilterKey
-
The specified key is not valid.
HTTP Status Code: 400
- InvalidFilterValue
-
The filter value is not valid. Verify the value and try again.
HTTP Status Code: 400
- InvalidNextToken
-
The specified token is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: