2016/12/01 - AWS Step Functions - 17 new api methods
Describes a state machine.
See also: AWS API Documentation
Request Syntax
client.describe_state_machine(
stateMachineArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the state machine to describe.
dict
Response Syntax
{
'stateMachineArn': 'string',
'name': 'string',
'status': 'ACTIVE'|'DELETING',
'definition': 'string',
'roleArn': 'string',
'creationDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
stateMachineArn (string) --
The Amazon Resource Name (ARN) that identifies the state machine.
name (string) --
The name of the state machine.
status (string) --
The current status of the state machine.
definition (string) --
The Amazon States Language definition of the state machine.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used for executing this state machine.
creationDate (datetime) --
The date the state machine was created.
Used by workers to report that the task identified by the taskToken failed.
See also: AWS API Documentation
Request Syntax
client.send_task_failure(
taskToken='string',
error='string',
cause='string'
)
string
[REQUIRED]
The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).
string
An arbitrary error code that identifies the cause of the failure.
string
A more detailed explanation of the cause of the failure.
dict
Response Syntax
{}
Response Structure
(dict) --
Starts a state machine execution.
See also: AWS API Documentation
Request Syntax
client.start_execution(
stateMachineArn='string',
name='string',
input='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the state machine to execute.
string
The name of the execution. This name must be unique for your AWS account and region.
string
The JSON input data for the execution.
dict
Response Syntax
{
'executionArn': 'string',
'startDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
executionArn (string) --
The Amazon Resource Name (ARN) that identifies the execution.
startDate (datetime) --
The date the execution was started.
Deletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process.
See also: AWS API Documentation
Request Syntax
client.delete_state_machine(
stateMachineArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the state machine to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Stops an execution.
See also: AWS API Documentation
Request Syntax
client.stop_execution(
executionArn='string',
error='string',
cause='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the execution to stop.
string
An arbitrary error code that identifies the cause of the termination.
string
A more detailed explanation of the cause of the termination.
dict
Response Syntax
{
'stopDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
stopDate (datetime) --
The date the execution was stopped.
Describes an execution.
See also: AWS API Documentation
Request Syntax
client.describe_execution(
executionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the execution to describe.
dict
Response Syntax
{
'executionArn': 'string',
'stateMachineArn': 'string',
'name': 'string',
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
'startDate': datetime(2015, 1, 1),
'stopDate': datetime(2015, 1, 1),
'input': 'string',
'output': 'string'
}
Response Structure
(dict) --
executionArn (string) --
The Amazon Resource Name (ARN) that identifies the execution.
stateMachineArn (string) --
The Amazon Resource Name (ARN) of the executed stated machine.
name (string) --
The name of the execution.
status (string) --
The current status of the execution.
startDate (datetime) --
The date the execution was started.
stopDate (datetime) --
If the execution has already ended, the date the execution stopped.
input (string) --
The JSON input data of the execution.
output (string) --
The JSON output data of the execution.
Deletes an activity.
See also: AWS API Documentation
Request Syntax
client.delete_activity(
activityArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the activity to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates an activity.
See also: AWS API Documentation
Request Syntax
client.create_activity(
name='string'
)
string
[REQUIRED]
The name of the activity to create. This name must be unique for your AWS account and region.
dict
Response Syntax
{
'activityArn': 'string',
'creationDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
activityArn (string) --
The Amazon Resource Name (ARN) that identifies the created activity.
creationDate (datetime) --
The date the activity was created.
Describes an activity.
See also: AWS API Documentation
Request Syntax
client.describe_activity(
activityArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the activity to describe.
dict
Response Syntax
{
'activityArn': 'string',
'name': 'string',
'creationDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
activityArn (string) --
The Amazon Resource Name (ARN) that identifies the activity.
name (string) --
The name of the activity.
creationDate (datetime) --
The date the activity was created.
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. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.
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 will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
boolean
Lists events in descending order of their timeStamp .
string
If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
dict
Response Syntax
{
'events': [
{
'timestamp': datetime(2015, 1, 1),
'type': 'ActivityFailed'|'ActivityScheduleFailed'|'ActivityScheduled'|'ActivityStarted'|'ActivitySucceeded'|'ActivityTimedOut'|'ChoiceStateEntered'|'ChoiceStateExited'|'ExecutionFailed'|'ExecutionStarted'|'ExecutionSucceeded'|'ExecutionAborted'|'ExecutionTimedOut'|'FailStateEntered'|'LambdaFunctionFailed'|'LambdaFunctionScheduleFailed'|'LambdaFunctionScheduled'|'LambdaFunctionStartFailed'|'LambdaFunctionStarted'|'LambdaFunctionSucceeded'|'LambdaFunctionTimedOut'|'SucceedStateEntered'|'SucceedStateExited'|'TaskStateEntered'|'TaskStateExited'|'PassStateEntered'|'PassStateExited'|'ParallelStateEntered'|'ParallelStateExited'|'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'
},
'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) --
timestamp (datetime) --
The date the event occured.
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) --
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
activityScheduleFailedEventDetails (dict) --
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
activityScheduledEventDetails (dict) --
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) --
workerName (string) --
The name of the worker that the task was assigned to. These names are provided by the workers when calling GetActivityTask .
activitySucceededEventDetails (dict) --
output (string) --
The JSON data output by the activity task.
activityTimedOutEventDetails (dict) --
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
executionFailedEventDetails (dict) --
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionStartedEventDetails (dict) --
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) --
output (string) --
The JSON data output by the execution.
executionAbortedEventDetails (dict) --
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionTimedOutEventDetails (dict) --
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
lambdaFunctionFailedEventDetails (dict) --
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionScheduleFailedEventDetails (dict) --
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionScheduledEventDetails (dict) --
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) --
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionSucceededEventDetails (dict) --
output (string) --
The JSON data output by the lambda function.
lambdaFunctionTimedOutEventDetails (dict) --
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
stateEnteredEventDetails (dict) --
name (string) --
The name of the state.
input (string) --
The JSON input data to the state.
stateExitedEventDetails (dict) --
name (string) --
The name of the state.
output (string) --
The JSON output data of the state.
nextToken (string) --
If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.
See also: AWS API Documentation
Request Syntax
client.list_executions(
stateMachineArn='string',
statusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the state machine whose executions will be listed.
string
If specified, only list the executions whose current execution status matches the given filter.
integer
The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
string
If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
dict
Response Syntax
{
'executions': [
{
'executionArn': 'string',
'stateMachineArn': 'string',
'name': 'string',
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
'startDate': datetime(2015, 1, 1),
'stopDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
executions (list) --
The list of matching executions.
(dict) --
executionArn (string) --
The Amazon Resource Name (ARN) that identifies the execution.
stateMachineArn (string) --
The Amazon Resource Name (ARN) of the executed state machine.
name (string) --
The name of the execution.
status (string) --
The current status of the execution.
startDate (datetime) --
The date the execution started.
stopDate (datetime) --
If the execution already ended, the date the execution stopped.
nextToken (string) --
If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
Used by workers to report that the task identified by the taskToken completed successfully.
See also: AWS API Documentation
Request Syntax
client.send_task_success(
taskToken='string',
output='string'
)
string
[REQUIRED]
The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).
string
[REQUIRED]
The JSON output of the task.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.
See also: AWS API Documentation
Request Syntax
client.list_activities(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
string
If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
dict
Response Syntax
{
'activities': [
{
'activityArn': 'string',
'name': 'string',
'creationDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
activities (list) --
The list of activities.
(dict) --
activityArn (string) --
The Amazon Resource Name (ARN) that identifies the activity.
name (string) --
The name of the activity.
creationDate (datetime) --
The date the activity was created.
nextToken (string) --
If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
Lists the existing state machines. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.
See also: AWS API Documentation
Request Syntax
client.list_state_machines(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
string
If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
dict
Response Syntax
{
'stateMachines': [
{
'stateMachineArn': 'string',
'name': 'string',
'creationDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
stateMachines (list) --
(dict) --
stateMachineArn (string) --
The Amazon Resource Name (ARN) that identifies the state machine.
name (string) --
The name of the state machine.
creationDate (datetime) --
The date the state machine was created.
nextToken (string) --
If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
Used by workers to retrieve a task (with the specified activity ARN) scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result, that is, the taskToken returned is an empty string.
Warning
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
See also: AWS API Documentation
Request Syntax
client.get_activity_task(
activityArn='string',
workerName='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the activity to retrieve tasks from.
string
An arbitrary name may be provided in order to identify the worker that the task is assigned to. This name will be used when it is logged in the execution history.
dict
Response Syntax
{
'taskToken': 'string',
'input': 'string'
}
Response Structure
(dict) --
taskToken (string) --
A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat , SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.
input (string) --
The JSON input data for the task.
Creates a state machine.
See also: AWS API Documentation
Request Syntax
client.create_state_machine(
name='string',
definition='string',
roleArn='string'
)
string
[REQUIRED]
The name of the state machine. This name must be unique for your AWS account and region.
string
[REQUIRED]
The Amazon States Language definition of the state machine.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
dict
Response Syntax
{
'stateMachineArn': 'string',
'creationDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
stateMachineArn (string) --
The Amazon Resource Name (ARN) that identifies the created state machine.
creationDate (datetime) --
The date the state machine was created.
Used by workers to report to the service that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition. This action does not in itself create an event in the execution history. However, if the task times out, the execution history will contain an ActivityTimedOut event.
Note
The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.
Note
This operation is only useful for long-lived tasks to report the liveliness of the task.
See also: AWS API Documentation
Request Syntax
client.send_task_heartbeat(
taskToken='string'
)
string
[REQUIRED]
The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).
dict
Response Syntax
{}
Response Structure
(dict) --