2018/11/29 - AWS Step Functions - 1 updated api methods
Changes AWS Step Functions is now integrated with eight additional AWS services: Amazon ECS, AWS Fargate, Amazon DynamoDB, Amazon SNS, Amazon SQS, AWS Batch, AWS Glue, and Amazon SageMaker. To learn more, please see https://docs.aws.amazon.com/step-functions/index.html
{'events': {'taskFailedEventDetails': {'cause': 'string',
'error': 'string',
'resource': 'string',
'resourceType': 'string'},
'taskScheduledEventDetails': {'parameters': 'string',
'region': 'string',
'resource': 'string',
'resourceType': 'string',
'timeoutInSeconds': 'long'},
'taskStartFailedEventDetails': {'cause': 'string',
'error': 'string',
'resource': 'string',
'resourceType': 'string'},
'taskStartedEventDetails': {'resource': 'string',
'resourceType': 'string'},
'taskSubmitFailedEventDetails': {'cause': 'string',
'error': 'string',
'resource': 'string',
'resourceType': 'string'},
'taskSubmittedEventDetails': {'output': 'string',
'resource': 'string',
'resourceType': 'string'},
'taskSucceededEventDetails': {'output': 'string',
'resource': 'string',
'resourceType': 'string'},
'taskTimedOutEventDetails': {'cause': 'string',
'error': 'string',
'resource': 'string',
'resourceType': 'string'},
'type': {'TaskFailed',
'TaskScheduled',
'TaskStartFailed',
'TaskStarted',
'TaskSubmitFailed',
'TaskSubmitted',
'TaskSucceeded',
'TaskTimedOut'}}}
Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
See also: AWS API Documentation
Request Syntax
client.get_execution_history(
executionArn='string',
maxResults=123,
reverseOrder=True|False,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the execution.
integer
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
boolean
Lists events in descending order of their timeStamp .
string
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
dict
Response Syntax
{
'events': [
{
'timestamp': datetime(2015, 1, 1),
'type': 'ActivityFailed'|'ActivityScheduleFailed'|'ActivityScheduled'|'ActivityStarted'|'ActivitySucceeded'|'ActivityTimedOut'|'ChoiceStateEntered'|'ChoiceStateExited'|'TaskFailed'|'TaskScheduled'|'TaskStartFailed'|'TaskStarted'|'TaskSubmitFailed'|'TaskSubmitted'|'TaskSucceeded'|'TaskTimedOut'|'ExecutionFailed'|'ExecutionStarted'|'ExecutionSucceeded'|'ExecutionAborted'|'ExecutionTimedOut'|'FailStateEntered'|'LambdaFunctionFailed'|'LambdaFunctionScheduleFailed'|'LambdaFunctionScheduled'|'LambdaFunctionStartFailed'|'LambdaFunctionStarted'|'LambdaFunctionSucceeded'|'LambdaFunctionTimedOut'|'SucceedStateEntered'|'SucceedStateExited'|'TaskStateAborted'|'TaskStateEntered'|'TaskStateExited'|'PassStateEntered'|'PassStateExited'|'ParallelStateAborted'|'ParallelStateEntered'|'ParallelStateExited'|'ParallelStateFailed'|'ParallelStateStarted'|'ParallelStateSucceeded'|'WaitStateAborted'|'WaitStateEntered'|'WaitStateExited',
'id': 123,
'previousEventId': 123,
'activityFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'activityScheduleFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'activityScheduledEventDetails': {
'resource': 'string',
'input': 'string',
'timeoutInSeconds': 123,
'heartbeatInSeconds': 123
},
'activityStartedEventDetails': {
'workerName': 'string'
},
'activitySucceededEventDetails': {
'output': 'string'
},
'activityTimedOutEventDetails': {
'error': 'string',
'cause': 'string'
},
'taskFailedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'taskScheduledEventDetails': {
'resourceType': 'string',
'resource': 'string',
'region': 'string',
'parameters': 'string',
'timeoutInSeconds': 123
},
'taskStartFailedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'taskStartedEventDetails': {
'resourceType': 'string',
'resource': 'string'
},
'taskSubmitFailedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'taskSubmittedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'output': 'string'
},
'taskSucceededEventDetails': {
'resourceType': 'string',
'resource': 'string',
'output': 'string'
},
'taskTimedOutEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'executionFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'executionStartedEventDetails': {
'input': 'string',
'roleArn': 'string'
},
'executionSucceededEventDetails': {
'output': 'string'
},
'executionAbortedEventDetails': {
'error': 'string',
'cause': 'string'
},
'executionTimedOutEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionScheduleFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionScheduledEventDetails': {
'resource': 'string',
'input': 'string',
'timeoutInSeconds': 123
},
'lambdaFunctionStartFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionSucceededEventDetails': {
'output': 'string'
},
'lambdaFunctionTimedOutEventDetails': {
'error': 'string',
'cause': 'string'
},
'stateEnteredEventDetails': {
'name': 'string',
'input': 'string'
},
'stateExitedEventDetails': {
'name': 'string',
'output': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
events (list) --
The list of events that occurred in the execution.
(dict) --
Contains details about the events of an execution.
timestamp (datetime) --
The date and time the event occurred.
type (string) --
The type of the event.
id (integer) --
The id of the event. Events are numbered sequentially, starting at one.
previousEventId (integer) --
The id of the previous event.
activityFailedEventDetails (dict) --
Contains details about an activity that failed during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
activityScheduleFailedEventDetails (dict) --
Contains details about an activity schedule event that failed during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
activityScheduledEventDetails (dict) --
Contains details about an activity scheduled during an execution.
resource (string) --
The Amazon Resource Name (ARN) of the scheduled activity.
input (string) --
The JSON data input to the activity task.
timeoutInSeconds (integer) --
The maximum allowed duration of the activity task.
heartbeatInSeconds (integer) --
The maximum allowed duration between two heartbeats for the activity task.
activityStartedEventDetails (dict) --
Contains details about the start of an activity during an execution.
workerName (string) --
The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.
activitySucceededEventDetails (dict) --
Contains details about an activity that successfully terminated during an execution.
output (string) --
The JSON data output by the activity task.
activityTimedOutEventDetails (dict) --
Contains details about an activity timeout that occurred during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
taskFailedEventDetails (dict) --
Contains details about a task failure event.
resourceType (string) --
The action of the connected service called by a task state.
resource (string) --
The service name of the connected service in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
taskScheduledEventDetails (dict) --
Contains details about a task scheduled during an execution.
resourceType (string) --
The action of the connected service called by a task state.
resource (string) --
The service name of the connected service in a task state.
region (string) --
parameters (string) --
The JSON data passed to the connected service referenced in a task state.
timeoutInSeconds (integer) --
The maximum allowed duration of the task.
taskStartFailedEventDetails (dict) --
Contains details about a task that failed to start during an execution.
resourceType (string) --
The action of the connected service called by a task state.
resource (string) --
The service name of the connected service in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
taskStartedEventDetails (dict) --
Contains details about the start of a task during an execution.
resourceType (string) --
The action of the connected service called by a task state.
resource (string) --
The service name of the connected service in a task state.
taskSubmitFailedEventDetails (dict) --
resourceType (string) --
The action of the connected service called by a task state.
resource (string) --
The service name of the connected service in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
taskSubmittedEventDetails (dict) --
resourceType (string) --
The action of the connected service called by a task state.
resource (string) --
The service name of the connected service in a task state.
output (string) --
The response from a connected service when a task has started.
taskSucceededEventDetails (dict) --
Contains details about the start of connected service by a task state.
resourceType (string) --
The action of the connected service called by a task state.
resource (string) --
The service name of the connected service in a task state.
output (string) --
The full JSON response from a connected service when a task has succeeded. This response becomes the output of the related task.
taskTimedOutEventDetails (dict) --
Contains details about a connected service timeout that occured during an execution.
resourceType (string) --
The action of the connected service called by a task state.
resource (string) --
The service name of the connected service in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionFailedEventDetails (dict) --
Contains details about an execution failure event.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionStartedEventDetails (dict) --
Contains details about the start of the execution.
input (string) --
The JSON data input to the execution.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.
executionSucceededEventDetails (dict) --
Contains details about the successful termination of the execution.
output (string) --
The JSON data output by the execution.
executionAbortedEventDetails (dict) --
Contains details about an abort of an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionTimedOutEventDetails (dict) --
Contains details about the execution timeout that occurred during the execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
lambdaFunctionFailedEventDetails (dict) --
Contains details about a lambda function that failed during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionScheduleFailedEventDetails (dict) --
Contains details about a failed lambda function schedule event that occurred during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionScheduledEventDetails (dict) --
Contains details about a lambda function scheduled during an execution.
resource (string) --
The Amazon Resource Name (ARN) of the scheduled lambda function.
input (string) --
The JSON data input to the lambda function.
timeoutInSeconds (integer) --
The maximum allowed duration of the lambda function.
lambdaFunctionStartFailedEventDetails (dict) --
Contains details about a lambda function that failed to start during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionSucceededEventDetails (dict) --
Contains details about a lambda function that terminated successfully during an execution.
output (string) --
The JSON data output by the lambda function.
lambdaFunctionTimedOutEventDetails (dict) --
Contains details about a lambda function timeout that occurred during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
stateEnteredEventDetails (dict) --
Contains details about a state entered during an execution.
name (string) --
The name of the state.
input (string) --
The string that contains the JSON input data for the state.
stateExitedEventDetails (dict) --
Contains details about an exit from a state during an execution.
name (string) --
The name of the state.
A name must not contain:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters ( U+0000-001F , U+007F-009F )
output (string) --
The JSON output data of the state.
nextToken (string) --
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.