AWS Step Functions 2016-11-23
- Client: Aws\Sfn\SfnClient
- Service ID: states
- Version: 2016-11-23
This page describes the parameters and results for the operations of the AWS Step Functions (2016-11-23), and shows how to use the Aws\Sfn\SfnClient object to call the described operations. This documentation is specific to the 2016-11-23 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateActivity ( array $params = [] )
Creates an activity.
- CreateStateMachine ( array $params = [] )
Creates a state machine.
- DeleteActivity ( array $params = [] )
Deletes an activity.
- DeleteStateMachine ( array $params = [] )
Deletes a state machine.
- DescribeActivity ( array $params = [] )
Describes an activity.
- DescribeExecution ( array $params = [] )
Describes an execution.
- DescribeStateMachine ( array $params = [] )
Describes a state machine.
- DescribeStateMachineForExecution ( array $params = [] )
Describes the state machine associated with a specific execution.
- GetActivityTask ( array $params = [] )
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine.
- GetExecutionHistory ( array $params = [] )
Returns the history of the specified execution as a list of events.
- ListActivities ( array $params = [] )
Lists the existing activities.
- ListExecutions ( array $params = [] )
Lists the executions of a state machine that meet the filtering criteria.
- ListStateMachines ( array $params = [] )
Lists the existing state machines.
- ListTagsForResource ( array $params = [] )
List tags for a given resource.
- SendTaskFailure ( array $params = [] )
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
- SendTaskHeartbeat ( array $params = [] )
Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress.
- SendTaskSuccess ( array $params = [] )
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
- StartExecution ( array $params = [] )
Starts a state machine execution.
- StartSyncExecution ( array $params = [] )
Starts a Synchronous Express state machine execution.
- StopExecution ( array $params = [] )
Stops an execution.
- TagResource ( array $params = [] )
Add a tag to a Step Functions resource.
- UntagResource ( array $params = [] )
Remove a tag from a Step Functions resource
- UpdateStateMachine ( array $params = [] )
Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateActivity
$result = $client->createActivity([/* ... */]); $promise = $client->createActivityAsync([/* ... */]);
Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.
Parameter Syntax
$result = $client->createActivity([
'name' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
A name must not contain:
-
white space
-
brackets
< > { } [ ] -
wildcard characters
? * -
special characters
" # % \ ^ | ~ ` $ & , ; : / -
control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
- tags
-
- Type: Array of Tag structures
The list of tags to add to a resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols:
_ . : / = + - @.
Result Syntax
[
'activityArn' => '<string>',
'creationDate' => <DateTime>,
]
Result Details
Members
Errors
-
The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
-
The provided name is invalid.
-
You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS Step Functions Developer Guide.
CreateStateMachine
$result = $client->createStateMachine([/* ... */]); $promise = $client->createStateMachineAsync([/* ... */]);
Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the AWS Step Functions User Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration and TracingConfiguration. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
Parameter Syntax
$result = $client->createStateMachine([
'definition' => '<string>', // REQUIRED
'loggingConfiguration' => [
'destinations' => [
[
'cloudWatchLogsLogGroup' => [
'logGroupArn' => '<string>',
],
],
// ...
],
'includeExecutionData' => true || false,
'level' => 'ALL|ERROR|FATAL|OFF',
],
'name' => '<string>', // REQUIRED
'roleArn' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
'tracingConfiguration' => [
'enabled' => true || false,
],
'type' => 'STANDARD|EXPRESS',
]);
Parameter Details
Members
- definition
-
- Required: Yes
- Type: string
The Amazon States Language definition of the state machine. See Amazon States Language.
- loggingConfiguration
-
- Type: LoggingConfiguration structure
Defines what execution history events are logged and where they are logged.
By default, the
levelis set toOFF. For more information see Log Levels in the AWS Step Functions User Guide. - name
-
- Required: Yes
- Type: string
The name of the state machine.
A name must not contain:
-
white space
-
brackets
< > { } [ ] -
wildcard characters
? * -
special characters
" # % \ ^ | ~ ` $ & , ; : / -
control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
- tags
-
- Type: Array of Tag structures
Tags to be added when creating a state machine.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols:
_ . : / = + - @. - tracingConfiguration
-
- Type: TracingConfiguration structure
Selects whether AWS X-Ray tracing is enabled.
- type
-
- Type: string
Determines whether a Standard or Express state machine is created. The default is
STANDARD. You cannot update thetypeof a state machine once it has been created.
Result Syntax
[
'creationDate' => <DateTime>,
'stateMachineArn' => '<string>',
]
Result Details
Members
Errors
-
The provided Amazon Resource Name (ARN) is invalid.
-
The provided Amazon States Language definition is invalid.
-
The provided name is invalid.
-
Your
tracingConfigurationkey does not match, orenabledhas not been set totrueorfalse. -
A state machine with the same name but a different definition or role ARN already exists.
-
The specified state machine is being deleted.
-
The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.
-
You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS Step Functions Developer Guide.
DeleteActivity
$result = $client->deleteActivity([/* ... */]); $promise = $client->deleteActivityAsync([/* ... */]);
Deletes an activity.
Parameter Syntax
$result = $client->deleteActivity([
'activityArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The provided Amazon Resource Name (ARN) is invalid.
DeleteStateMachine
$result = $client->deleteStateMachine([/* ... */]); $promise = $client->deleteStateMachineAsync([/* ... */]);
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
For EXPRESSstate machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
Parameter Syntax
$result = $client->deleteStateMachine([
'stateMachineArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The provided Amazon Resource Name (ARN) is invalid.
DescribeActivity
$result = $client->describeActivity([/* ... */]); $promise = $client->describeActivityAsync([/* ... */]);
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Parameter Syntax
$result = $client->describeActivity([
'activityArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'activityArn' => '<string>',
'creationDate' => <DateTime>,
'name' => '<string>',
]
Result Details
Members
- activityArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the activity.
- creationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the activity is created.
- name
-
- Required: Yes
- Type: string
The name of the activity.
A name must not contain:
-
white space
-
brackets
< > { } [ ] -
wildcard characters
? * -
special characters
" # % \ ^ | ~ ` $ & , ; : / -
control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
Errors
-
The specified activity does not exist.
-
The provided Amazon Resource Name (ARN) is invalid.
DescribeExecution
$result = $client->describeExecution([/* ... */]); $promise = $client->describeExecutionAsync([/* ... */]);
Describes an execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Parameter Syntax
$result = $client->describeExecution([
'executionArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'executionArn' => '<string>',
'input' => '<string>',
'inputDetails' => [
'included' => true || false,
],
'name' => '<string>',
'output' => '<string>',
'outputDetails' => [
'included' => true || false,
],
'startDate' => <DateTime>,
'stateMachineArn' => '<string>',
'status' => 'RUNNING|SUCCEEDED|FAILED|TIMED_OUT|ABORTED',
'stopDate' => <DateTime>,
'traceHeader' => '<string>',
]
Result Details
Members
- executionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the execution.
- input
-
- Type: string
The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- inputDetails
-
- Type: CloudWatchEventsExecutionDataDetails structure
Provides details about execution input or output.
- name
-
- Type: string
The name of the execution.
A name must not contain:
-
white space
-
brackets
< > { } [ ] -
wildcard characters
? * -
special characters
" # % \ ^ | ~ ` $ & , ; : / -
control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
- output
-
- Type: string
The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
- outputDetails
-
- Type: CloudWatchEventsExecutionDataDetails structure
Provides details about execution input or output.
- startDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the execution is started.
- stateMachineArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the executed stated machine.
- status
-
- Required: Yes
- Type: string
The current status of the execution.
- stopDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
If the execution has already ended, the date the execution stopped.
- traceHeader
-
- Type: string
The AWS X-Ray trace header that was passed to the execution.
Errors
-
The specified execution does not exist.
-
The provided Amazon Resource Name (ARN) is invalid.
DescribeStateMachine
$result = $client->describeStateMachine([/* ... */]); $promise = $client->describeStateMachineAsync([/* ... */]);
Describes a state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Parameter Syntax
$result = $client->describeStateMachine([
'stateMachineArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'creationDate' => <DateTime>,
'definition' => '<string>',
'loggingConfiguration' => [
'destinations' => [
[
'cloudWatchLogsLogGroup' => [
'logGroupArn' => '<string>',
],
],
// ...
],
'includeExecutionData' => true || false,
'level' => 'ALL|ERROR|FATAL|OFF',
],
'name' => '<string>',
'roleArn' => '<string>',
'stateMachineArn' => '<string>',
'status' => 'ACTIVE|DELETING',
'tracingConfiguration' => [
'enabled' => true || false,
],
'type' => 'STANDARD|EXPRESS',
]
Result Details
Members
- creationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the state machine is created.
- definition
-
- Required: Yes
- Type: string
The Amazon States Language definition of the state machine. See Amazon States Language.
- loggingConfiguration
-
- Type: LoggingConfiguration structure
The
LoggingConfigurationdata type is used to set CloudWatch Logs options. - name
-
- Required: Yes
- Type: string
The name of the state machine.
A name must not contain:
-
white space
-
brackets
< > { } [ ] -
wildcard characters
? * -
special characters
" # % \ ^ | ~ ` $ & , ; : / -
control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)
- stateMachineArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the state machine.
- status
-
- Type: string
The current status of the state machine.
- tracingConfiguration
-
- Type: TracingConfiguration structure
Selects whether AWS X-Ray tracing is enabled.
- type
-
- Required: Yes
- Type: string
The
typeof the state machine (STANDARDorEXPRESS).
Errors
-
The provided Amazon Resource Name (ARN) is invalid.
-
The specified state machine does not exist.
DescribeStateMachineForExecution
$result = $client->describeStateMachineForExecution([/* ... */]); $promise = $client->describeStateMachineForExecutionAsync([/* ... */]);
Describes the state machine associated with a specific execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Parameter Syntax
$result = $client->describeStateMachineForExecution([
'executionArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'definition' => '<string>',
'loggingConfiguration' => [
'destinations' => [
[
'cloudWatchLogsLogGroup' => [
'logGroupArn' => '<string>',
],
],
// ...
],
'includeExecutionData' => true || false,
'level' => 'ALL|ERROR|FATAL|OFF',
],
'name' => '<string>',
'roleArn' => '<string>',
'stateMachineArn' => '<string>',
'tracingConfiguration' => [
'enabled' => true || false,
],
'updateDate' => <DateTime>,
]
Result Details
Members
- definition
-
- Required: Yes
- Type: string
The Amazon States Language definition of the state machine. See Amazon States Language.
- loggingConfiguration
-
- Type: LoggingConfiguration structure
The
LoggingConfigurationdata type is used to set CloudWatch Logs options. - name
-
- Required: Yes
- Type: string
The name of the state machine associated with the execution.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
- stateMachineArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the state machine associated with the execution.
- tracingConfiguration
-
- Type: TracingConfiguration structure
Selects whether AWS X-Ray tracing is enabled.
- updateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
Errors
-
The specified execution does not exist.
-
The provided Amazon Resource Name (ARN) is invalid.
GetActivityTask
$result = $client->getActivityTask([/* ... */]); $promise = $client->getActivityTaskAsync([/* ... */]);
Used by workers to retrieve a task (with the specified activity ARN) which has been 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 returns a taskToken with a null string.
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).
Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.
Parameter Syntax
$result = $client->getActivityTask([
'activityArn' => '<string>', // REQUIRED
'workerName' => '<string>',
]);
Parameter Details
Members
- activityArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)
- workerName
-
- Type: string
You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.
Result Syntax
[
'input' => '<string>',
'taskToken' => '<string>',
]
Result Details
Members
- input
-
- Type: string
The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- taskToken
-
- Type: 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.
Errors
-
The specified activity does not exist.
-
The maximum number of workers concurrently polling for activity tasks has been reached.
-
The provided Amazon Resource Name (ARN) is invalid.
GetExecutionHistory
$result = $client->getExecutionHistory([/* ... */]); $promise = $client->getExecutionHistoryAsync([/* ... */]);
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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This API action is not supported by EXPRESS state machines.
Parameter Syntax
$result = $client->getExecutionHistory([
'executionArn' => '<string>', // REQUIRED
'includeExecutionData' => true || false,
'maxResults' => <integer>,
'nextToken' => '<string>',
'reverseOrder' => true || false,
]);
Parameter Details
Members
- executionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the execution.
- includeExecutionData
-
- Type: boolean
You can select whether execution data (input or output of a history event) is returned. The default is
true. - maxResults
-
- Type: int
The maximum number of results that are returned per call. You can use
nextTokento 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.
- nextToken
-
- Type: string
If
nextTokenis returned, there are more results available. The value ofnextTokenis 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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. - reverseOrder
-
- Type: boolean
Lists events in descending order of their
timeStamp.
Result Syntax
[
'events' => [
[
'activityFailedEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
],
'activityScheduleFailedEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
],
'activityScheduledEventDetails' => [
'heartbeatInSeconds' => <integer>,
'input' => '<string>',
'inputDetails' => [
'truncated' => true || false,
],
'resource' => '<string>',
'timeoutInSeconds' => <integer>,
],
'activityStartedEventDetails' => [
'workerName' => '<string>',
],
'activitySucceededEventDetails' => [
'output' => '<string>',
'outputDetails' => [
'truncated' => true || false,
],
],
'activityTimedOutEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
],
'executionAbortedEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
],
'executionFailedEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
],
'executionStartedEventDetails' => [
'input' => '<string>',
'inputDetails' => [
'truncated' => true || false,
],
'roleArn' => '<string>',
],
'executionSucceededEventDetails' => [
'output' => '<string>',
'outputDetails' => [
'truncated' => true || false,
],
],
'executionTimedOutEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
],
'id' => <integer>,
'lambdaFunctionFailedEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
],
'lambdaFunctionScheduleFailedEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
],
'lambdaFunctionScheduledEventDetails' => [
'input' => '<string>',
'inputDetails' => [
'truncated' => true || false,
],
'resource' => '<string>',
'timeoutInSeconds' => <integer>,
],
'lambdaFunctionStartFailedEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
],
'lambdaFunctionSucceededEventDetails' => [
'output' => '<string>',
'outputDetails' => [
'truncated' => true || false,
],
],
'lambdaFunctionTimedOutEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
],
'mapIterationAbortedEventDetails' => [
'index' => <integer>,
'name' => '<string>',
],
'mapIterationFailedEventDetails' => [
'index' => <integer>,
'name' => '<string>',
],
'mapIterationStartedEventDetails' => [
'index' => <integer>,
'name' => '<string>',
],
'mapIterationSucceededEventDetails' => [
'index' => <integer>,
'name' => '<string>',
],
'mapStateStartedEventDetails' => [
'length' => <integer>,
],
'previousEventId' => <integer>,
'stateEnteredEventDetails' => [
'input' => '<string>',
'inputDetails' => [
'truncated' => true || false,
],
'name' => '<string>',
],
'stateExitedEventDetails' => [
'name' => '<string>',
'output' => '<string>',
'outputDetails' => [
'truncated' => true || false,
],
],
'taskFailedEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
'resource' => '<string>',
'resourceType' => '<string>',
],
'taskScheduledEventDetails' => [
'heartbeatInSeconds' => <integer>,
'parameters' => '<string>',
'region' => '<string>',
'resource' => '<string>',
'resourceType' => '<string>',
'timeoutInSeconds' => <integer>,
],
'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>',
'outputDetails' => [
'truncated' => true || false,
],
'resource' => '<string>',
'resourceType' => '<string>',
],
'taskSucceededEventDetails' => [
'output' => '<string>',
'outputDetails' => [
'truncated' => true || false,
],
'resource' => '<string>',
'resourceType' => '<string>',
],
'taskTimedOutEventDetails' => [
'cause' => '<string>',
'error' => '<string>',
'resource' => '<string>',
'resourceType' => '<string>',
],
'timestamp' => <DateTime>,
'type' => 'ActivityFailed|ActivityScheduled|ActivityScheduleFailed|ActivityStarted|ActivitySucceeded|ActivityTimedOut|ChoiceStateEntered|ChoiceStateExited|ExecutionAborted|ExecutionFailed|ExecutionStarted|ExecutionSucceeded|ExecutionTimedOut|FailStateEntered|LambdaFunctionFailed|LambdaFunctionScheduled|LambdaFunctionScheduleFailed|LambdaFunctionStarted|LambdaFunctionStartFailed|LambdaFunctionSucceeded|LambdaFunctionTimedOut|MapIterationAborted|MapIterationFailed|MapIterationStarted|MapIterationSucceeded|MapStateAborted|MapStateEntered|MapStateExited|MapStateFailed|MapStateStarted|MapStateSucceeded|ParallelStateAborted|ParallelStateEntered|ParallelStateExited|ParallelStateFailed|ParallelStateStarted|ParallelStateSucceeded|PassStateEntered|PassStateExited|SucceedStateEntered|SucceedStateExited|TaskFailed|TaskScheduled|TaskStarted|TaskStartFailed|TaskStateAborted|TaskStateEntered|TaskStateExited|TaskSubmitFailed|TaskSubmitted|TaskSucceeded|TaskTimedOut|WaitStateAborted|WaitStateEntered|WaitStateExited',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- events
-
- Required: Yes
- Type: Array of HistoryEvent structures
The list of events that occurred in the execution.
- nextToken
-
- Type: string
If
nextTokenis returned, there are more results available. The value ofnextTokenis 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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Errors
-
The specified execution does not exist.
-
The provided Amazon Resource Name (ARN) is invalid.
-
The provided token is invalid.
ListActivities
$result = $client->listActivities([/* ... */]); $promise = $client->listActivitiesAsync([/* ... */]);
Lists the existing activities.
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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Parameter Syntax
$result = $client->listActivities([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results that are returned per call. You can use
nextTokento 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.
- nextToken
-
- Type: string
If
nextTokenis returned, there are more results available. The value ofnextTokenis 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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Result Syntax
[
'activities' => [
[
'activityArn' => '<string>',
'creationDate' => <DateTime>,
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- activities
-
- Required: Yes
- Type: Array of ActivityListItem structures
The list of activities.
- nextToken
-
- Type: string
If
nextTokenis returned, there are more results available. The value ofnextTokenis 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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Errors
-
The provided token is invalid.
ListExecutions
$result = $client->listExecutions([/* ... */]); $promise = $client->listExecutionsAsync([/* ... */]);
Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution 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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Parameter Syntax
$result = $client->listExecutions([
'maxResults' => <integer>,
'nextToken' => '<string>',
'stateMachineArn' => '<string>', // REQUIRED
'statusFilter' => 'RUNNING|SUCCEEDED|FAILED|TIMED_OUT|ABORTED',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results that are returned per call. You can use
nextTokento 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.
- nextToken
-
- Type: string
If
nextTokenis returned, there are more results available. The value ofnextTokenis 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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. - stateMachineArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the state machine whose executions is listed.
- statusFilter
-
- Type: string
If specified, only list the executions whose current execution status matches the given filter.
Result Syntax
[
'executions' => [
[
'executionArn' => '<string>',
'name' => '<string>',
'startDate' => <DateTime>,
'stateMachineArn' => '<string>',
'status' => 'RUNNING|SUCCEEDED|FAILED|TIMED_OUT|ABORTED',
'stopDate' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- executions
-
- Required: Yes
- Type: Array of ExecutionListItem structures
The list of matching executions.
- nextToken
-
- Type: string
If
nextTokenis returned, there are more results available. The value ofnextTokenis 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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Errors
-
The provided Amazon Resource Name (ARN) is invalid.
-
The provided token is invalid.
-
The specified state machine does not exist.
ListStateMachines
$result = $client->listStateMachines([/* ... */]); $promise = $client->listStateMachinesAsync([/* ... */]);
Lists the existing state machines.
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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Parameter Syntax
$result = $client->listStateMachines([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results that are returned per call. You can use
nextTokento 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.
- nextToken
-
- Type: string
If
nextTokenis returned, there are more results available. The value ofnextTokenis 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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Result Syntax
[
'nextToken' => '<string>',
'stateMachines' => [
[
'creationDate' => <DateTime>,
'name' => '<string>',
'stateMachineArn' => '<string>',
'type' => 'STANDARD|EXPRESS',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
If
nextTokenis returned, there are more results available. The value ofnextTokenis 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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. - stateMachines
-
- Required: Yes
- Type: Array of StateMachineListItem structures
Errors
-
The provided token is invalid.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'tags' => [
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
]
Result Details
Members
- tags
-
- Type: Array of Tag structures
An array of tags associated with the resource.
Errors
-
The provided Amazon Resource Name (ARN) is invalid.
-
Could not find the referenced resource. Only state machine and activity ARNs are supported.
SendTaskFailure
$result = $client->sendTaskFailure([/* ... */]); $promise = $client->sendTaskFailureAsync([/* ... */]);
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
Parameter Syntax
$result = $client->sendTaskFailure([
'cause' => '<string>',
'error' => '<string>',
'taskToken' => '<string>', // REQUIRED
]);
Parameter Details
Members
- cause
-
- Type: string
A more detailed explanation of the cause of the failure.
- error
-
- Type: string
The error code of the failure.
- taskToken
-
- Required: Yes
- Type: string
The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
Result Syntax
[]
Result Details
Errors
-
This error does not currently have a description.
-
The provided token is invalid.
-
This error does not currently have a description.
SendTaskHeartbeat
$result = $client->sendTaskHeartbeat([/* ... */]); $promise = $client->sendTaskHeartbeatAsync([/* ... */]);
Used by activity workers and task states using the callback pattern to report to Step Functions 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 (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern.
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. Use HeartbeatSeconds to configure the timeout interval for heartbeats.
Parameter Syntax
$result = $client->sendTaskHeartbeat([
'taskToken' => '<string>', // REQUIRED
]);
Parameter Details
Members
- taskToken
-
- Required: Yes
- Type: string
The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
Result Syntax
[]
Result Details
Errors
-
This error does not currently have a description.
-
The provided token is invalid.
-
This error does not currently have a description.
SendTaskSuccess
$result = $client->sendTaskSuccess([/* ... */]); $promise = $client->sendTaskSuccessAsync([/* ... */]);
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
Parameter Syntax
$result = $client->sendTaskSuccess([
'output' => '<string>', // REQUIRED
'taskToken' => '<string>', // REQUIRED
]);
Parameter Details
Members
- output
-
- Required: Yes
- Type: string
The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- taskToken
-
- Required: Yes
- Type: string
The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
Result Syntax
[]
Result Details
Errors
-
This error does not currently have a description.
-
The provided JSON output data is invalid.
-
The provided token is invalid.
-
This error does not currently have a description.
StartExecution
$result = $client->startExecution([/* ... */]); $promise = $client->startExecutionAsync([/* ... */]);
Starts a state machine execution.
StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
Parameter Syntax
$result = $client->startExecution([
'input' => '<string>',
'name' => '<string>',
'stateMachineArn' => '<string>', // REQUIRED
'traceHeader' => '<string>',
]);
Parameter Details
Members
- input
-
- Type: string
The string that contains the JSON input data for the execution, for example:
"input": "{\"first_name\" : \"test\"}"If you don't include any JSON input data, you still must include the two braces, for example:
"input": "{}"Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- name
-
- Type: string
The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
A name must not contain:
-
white space
-
brackets
< > { } [ ] -
wildcard characters
? * -
special characters
" # % \ ^ | ~ ` $ & , ; : / -
control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
- stateMachineArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the state machine to execute.
- traceHeader
-
- Type: string
Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.
Result Syntax
[
'executionArn' => '<string>',
'startDate' => <DateTime>,
]
Result Details
Members
Errors
-
The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
-
The execution has the same
nameas another execution (but a differentinput).Executions with the same
nameandinputare considered idempotent. -
The provided Amazon Resource Name (ARN) is invalid.
-
The provided JSON input data is invalid.
-
The provided name is invalid.
-
The specified state machine does not exist.
-
The specified state machine is being deleted.
StartSyncExecution
$result = $client->startSyncExecution([/* ... */]); $promise = $client->startSyncExecutionAsync([/* ... */]);
Starts a Synchronous Express state machine execution.
Parameter Syntax
$result = $client->startSyncExecution([
'input' => '<string>',
'name' => '<string>',
'stateMachineArn' => '<string>', // REQUIRED
'traceHeader' => '<string>',
]);
Parameter Details
Members
- input
-
- Type: string
The string that contains the JSON input data for the execution, for example:
"input": "{\"first_name\" : \"test\"}"If you don't include any JSON input data, you still must include the two braces, for example:
"input": "{}"Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- name
-
- Type: string
The name of the execution.
- stateMachineArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the state machine to execute.
- traceHeader
-
- Type: string
Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.
Result Syntax
[
'billingDetails' => [
'billedDurationInMilliseconds' => <integer>,
'billedMemoryUsedInMB' => <integer>,
],
'cause' => '<string>',
'error' => '<string>',
'executionArn' => '<string>',
'input' => '<string>',
'inputDetails' => [
'included' => true || false,
],
'name' => '<string>',
'output' => '<string>',
'outputDetails' => [
'included' => true || false,
],
'startDate' => <DateTime>,
'stateMachineArn' => '<string>',
'status' => 'SUCCEEDED|FAILED|TIMED_OUT',
'stopDate' => <DateTime>,
'traceHeader' => '<string>',
]
Result Details
Members
- billingDetails
-
- Type: BillingDetails structure
An object that describes workflow billing details, including billed duration and memory use.
- cause
-
- Type: string
A more detailed explanation of the cause of the failure.
- error
-
- Type: string
The error code of the failure.
- executionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the execution.
- input
-
- Type: string
The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- inputDetails
-
- Type: CloudWatchEventsExecutionDataDetails structure
Provides details about execution input or output.
- name
-
- Type: string
The name of the execution.
- output
-
- Type: string
The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
- outputDetails
-
- Type: CloudWatchEventsExecutionDataDetails structure
Provides details about execution input or output.
- startDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the execution is started.
- stateMachineArn
-
- Type: string
The Amazon Resource Name (ARN) that identifies the state machine.
- status
-
- Required: Yes
- Type: string
The current status of the execution.
- stopDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
If the execution has already ended, the date the execution stopped.
- traceHeader
-
- Type: string
The AWS X-Ray trace header that was passed to the execution.
Errors
-
The provided Amazon Resource Name (ARN) is invalid.
-
The provided JSON input data is invalid.
-
The provided name is invalid.
-
The specified state machine does not exist.
-
The specified state machine is being deleted.
StopExecution
$result = $client->stopExecution([/* ... */]); $promise = $client->stopExecutionAsync([/* ... */]);
Stops an execution.
This API action is not supported by EXPRESS state machines.
Parameter Syntax
$result = $client->stopExecution([
'cause' => '<string>',
'error' => '<string>',
'executionArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'stopDate' => <DateTime>,
]
Result Details
Members
Errors
-
The specified execution does not exist.
-
The provided Amazon Resource Name (ARN) is invalid.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => [ // REQUIRED
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
- tags
-
- Required: Yes
- Type: Array of Tag structures
The list of tags to add to a resource.
Tags may only contain Unicode letters, digits, white space, or these symbols:
_ . : / = + - @.
Result Syntax
[]
Result Details
Errors
-
The provided Amazon Resource Name (ARN) is invalid.
-
Could not find the referenced resource. Only state machine and activity ARNs are supported.
-
You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS Step Functions Developer Guide.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Remove a tag from a Step Functions resource
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The provided Amazon Resource Name (ARN) is invalid.
-
Could not find the referenced resource. Only state machine and activity ARNs are supported.
UpdateStateMachine
$result = $client->updateStateMachine([/* ... */]); $promise = $client->updateStateMachineAsync([/* ... */]);
Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.
Parameter Syntax
$result = $client->updateStateMachine([
'definition' => '<string>',
'loggingConfiguration' => [
'destinations' => [
[
'cloudWatchLogsLogGroup' => [
'logGroupArn' => '<string>',
],
],
// ...
],
'includeExecutionData' => true || false,
'level' => 'ALL|ERROR|FATAL|OFF',
],
'roleArn' => '<string>',
'stateMachineArn' => '<string>', // REQUIRED
'tracingConfiguration' => [
'enabled' => true || false,
],
]);
Parameter Details
Members
- definition
-
- Type: string
The Amazon States Language definition of the state machine. See Amazon States Language.
- loggingConfiguration
-
- Type: LoggingConfiguration structure
The
LoggingConfigurationdata type is used to set CloudWatch Logs options. - roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role of the state machine.
- stateMachineArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the state machine.
- tracingConfiguration
-
- Type: TracingConfiguration structure
Selects whether AWS X-Ray tracing is enabled.
Result Syntax
[
'updateDate' => <DateTime>,
]
Result Details
Members
Errors
-
The provided Amazon Resource Name (ARN) is invalid.
-
The provided Amazon States Language definition is invalid.
-
Your
tracingConfigurationkey does not match, orenabledhas not been set totrueorfalse. -
Request is missing a required parameter. This error occurs if both
definitionandroleArnare not specified. -
The specified state machine is being deleted.
-
The specified state machine does not exist.
Shapes
ActivityDoesNotExist
ActivityFailedEventDetails
Description
Contains details about an activity that failed during an execution.
Members
ActivityLimitExceeded
Description
The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
Members
ActivityListItem
Description
Contains details about an activity.
Members
- activityArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the activity.
- creationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the activity is created.
- name
-
- Required: Yes
- Type: string
The name of the activity.
A name must not contain:
-
white space
-
brackets
< > { } [ ] -
wildcard characters
? * -
special characters
" # % \ ^ | ~ ` $ & , ; : / -
control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
ActivityScheduleFailedEventDetails
Description
Contains details about an activity schedule failure that occurred during an execution.
Members
ActivityScheduledEventDetails
Description
Contains details about an activity scheduled during an execution.
Members
- heartbeatInSeconds
-
- Type: long (int|float)
The maximum allowed duration between two heartbeats for the activity task.
- input
-
- Type: string
The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- inputDetails
-
- Type: HistoryEventExecutionDataDetails structure
Contains details about the input for an execution history event.
- resource
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the scheduled activity.
- timeoutInSeconds
-
- Type: long (int|float)
The maximum allowed duration of the activity task.
ActivityStartedEventDetails
Description
Contains details about the start of an activity during an execution.
Members
- workerName
-
- Type: string
The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.
ActivitySucceededEventDetails
Description
Contains details about an activity that successfully terminated during an execution.
Members
- output
-
- Type: string
The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- outputDetails
-
- Type: HistoryEventExecutionDataDetails structure
Contains details about the output of an execution history event.
ActivityTimedOutEventDetails
Description
Contains details about an activity timeout that occurred during an execution.
Members
ActivityWorkerLimitExceeded
Description
The maximum number of workers concurrently polling for activity tasks has been reached.
Members
BillingDetails
Description
An object that describes workflow billing details.
Members
CloudWatchEventsExecutionDataDetails
Description
Provides details about execution input or output.
Members
CloudWatchLogsLogGroup
Description
Members
ExecutionAbortedEventDetails
Description
Contains details about an abort of an execution.
Members
ExecutionAlreadyExists
Description
The execution has the same name as another execution (but a different input).
Executions with the same name and input are considered idempotent.
Members
ExecutionDoesNotExist
ExecutionFailedEventDetails
Description
Contains details about an execution failure event.
Members
ExecutionLimitExceeded
Description
The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
Members
ExecutionListItem
Description
Contains details about an execution.
Members
- executionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the execution.
- name
-
- Required: Yes
- Type: string
The name of the execution.
A name must not contain:
-
white space
-
brackets
< > { } [ ] -
wildcard characters
? * -
special characters
" # % \ ^ | ~ ` $ & , ; : / -
control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
- startDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the execution started.
- stateMachineArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the executed state machine.
- status
-
- Required: Yes
- Type: string
The current status of the execution.
- stopDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
If the execution already ended, the date the execution stopped.
ExecutionStartedEventDetails
Description
Contains details about the start of the execution.
Members
- input
-
- Type: string
The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- inputDetails
-
- Type: HistoryEventExecutionDataDetails structure
Contains details about the input for an execution history event.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.
ExecutionSucceededEventDetails
Description
Contains details about the successful termination of the execution.
Members
- output
-
- Type: string
The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- outputDetails
-
- Type: HistoryEventExecutionDataDetails structure
Contains details about the output of an execution history event.
ExecutionTimedOutEventDetails
Description
Contains details about the execution timeout that occurred during the execution.
Members
HistoryEvent
Description
Contains details about the events of an execution.
Members
- activityFailedEventDetails
-
- Type: ActivityFailedEventDetails structure
Contains details about an activity that failed during an execution.
- activityScheduleFailedEventDetails
-
- Type: ActivityScheduleFailedEventDetails structure
Contains details about an activity schedule event that failed during an execution.
- activityScheduledEventDetails
-
- Type: ActivityScheduledEventDetails structure
Contains details about an activity scheduled during an execution.
- activityStartedEventDetails
-
- Type: ActivityStartedEventDetails structure
Contains details about the start of an activity during an execution.
- activitySucceededEventDetails
-
- Type: ActivitySucceededEventDetails structure
Contains details about an activity that successfully terminated during an execution.
- activityTimedOutEventDetails
-
- Type: ActivityTimedOutEventDetails structure
Contains details about an activity timeout that occurred during an execution.
- executionAbortedEventDetails
-
- Type: ExecutionAbortedEventDetails structure
Contains details about an abort of an execution.
- executionFailedEventDetails
-
- Type: ExecutionFailedEventDetails structure
Contains details about an execution failure event.
- executionStartedEventDetails
-
- Type: ExecutionStartedEventDetails structure
Contains details about the start of the execution.
- executionSucceededEventDetails
-
- Type: ExecutionSucceededEventDetails structure
Contains details about the successful termination of the execution.
- executionTimedOutEventDetails
-
- Type: ExecutionTimedOutEventDetails structure
Contains details about the execution timeout that occurred during the execution.
- id
-
- Required: Yes
- Type: long (int|float)
The id of the event. Events are numbered sequentially, starting at one.
- lambdaFunctionFailedEventDetails
-
- Type: LambdaFunctionFailedEventDetails structure
Contains details about a lambda function that failed during an execution.
- lambdaFunctionScheduleFailedEventDetails
-
- Type: LambdaFunctionScheduleFailedEventDetails structure
Contains details about a failed lambda function schedule event that occurred during an execution.
- lambdaFunctionScheduledEventDetails
-
- Type: LambdaFunctionScheduledEventDetails structure
Contains details about a lambda function scheduled during an execution.
- lambdaFunctionStartFailedEventDetails
-
- Type: LambdaFunctionStartFailedEventDetails structure
Contains details about a lambda function that failed to start during an execution.
- lambdaFunctionSucceededEventDetails
-
- Type: LambdaFunctionSucceededEventDetails structure
Contains details about a lambda function that terminated successfully during an execution.
- lambdaFunctionTimedOutEventDetails
-
- Type: LambdaFunctionTimedOutEventDetails structure
Contains details about a lambda function timeout that occurred during an execution.
- mapIterationAbortedEventDetails
-
- Type: MapIterationEventDetails structure
Contains details about an iteration of a Map state that was aborted.
- mapIterationFailedEventDetails
-
- Type: MapIterationEventDetails structure
Contains details about an iteration of a Map state that failed.
- mapIterationStartedEventDetails
-
- Type: MapIterationEventDetails structure
Contains details about an iteration of a Map state that was started.
- mapIterationSucceededEventDetails
-
- Type: MapIterationEventDetails structure
Contains details about an iteration of a Map state that succeeded.
- mapStateStartedEventDetails
-
- Type: MapStateStartedEventDetails structure
Contains details about Map state that was started.
- previousEventId
-
- Type: long (int|float)
The id of the previous event.
- stateEnteredEventDetails
-
- Type: StateEnteredEventDetails structure
Contains details about a state entered during an execution.
- stateExitedEventDetails
-
- Type: StateExitedEventDetails structure
Contains details about an exit from a state during an execution.
- taskFailedEventDetails
-
- Type: TaskFailedEventDetails structure
Contains details about the failure of a task.
- taskScheduledEventDetails
-
- Type: TaskScheduledEventDetails structure
Contains details about a task that was scheduled.
- taskStartFailedEventDetails
-
- Type: TaskStartFailedEventDetails structure
Contains details about a task that failed to start.
- taskStartedEventDetails
-
- Type: TaskStartedEventDetails structure
Contains details about a task that was started.
- taskSubmitFailedEventDetails
-
- Type: TaskSubmitFailedEventDetails structure
Contains details about a task that where the submit failed.
- taskSubmittedEventDetails
-
- Type: TaskSubmittedEventDetails structure
Contains details about a submitted task.
- taskSucceededEventDetails
-
- Type: TaskSucceededEventDetails structure
Contains details about a task that succeeded.
- taskTimedOutEventDetails
-
- Type: TaskTimedOutEventDetails structure
Contains details about a task that timed out.
- timestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the event occurred.
- type
-
- Required: Yes
- Type: string
The type of the event.
HistoryEventExecutionDataDetails
Description
Provides details about input or output in an execution history event.
Members
InvalidArn
InvalidDefinition
InvalidExecutionInput
InvalidLoggingConfiguration
InvalidName
InvalidOutput
InvalidToken
InvalidTracingConfiguration
Description
Your tracingConfiguration key does not match, or enabled has not been set to true or false.
Members
LambdaFunctionFailedEventDetails
Description
Contains details about a lambda function that failed during an execution.
Members
LambdaFunctionScheduleFailedEventDetails
Description
Contains details about a failed lambda function schedule event that occurred during an execution.
Members
LambdaFunctionScheduledEventDetails
Description
Contains details about a lambda function scheduled during an execution.
Members
- input
-
- Type: string
The JSON data input to the lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- inputDetails
-
- Type: HistoryEventExecutionDataDetails structure
Contains details about input for an execution history event.
- resource
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the scheduled lambda function.
- timeoutInSeconds
-
- Type: long (int|float)
The maximum allowed duration of the lambda function.
LambdaFunctionStartFailedEventDetails
Description
Contains details about a lambda function that failed to start during an execution.
Members
LambdaFunctionSucceededEventDetails
Description
Contains details about a lambda function that successfully terminated during an execution.
Members
- output
-
- Type: string
The JSON data output by the lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- outputDetails
-
- Type: HistoryEventExecutionDataDetails structure
Contains details about the output of an execution history event.
LambdaFunctionTimedOutEventDetails
Description
Contains details about a lambda function timeout that occurred during an execution.
Members
LogDestination
Description
Members
- cloudWatchLogsLogGroup
-
- Type: CloudWatchLogsLogGroup structure
An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.
LoggingConfiguration
Description
The LoggingConfiguration data type is used to set CloudWatch Logs options.
Members
- destinations
-
- Type: Array of LogDestination structures
An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to
OFF. - includeExecutionData
-
- Type: boolean
Determines whether execution data is included in your log. When set to
false, data is excluded. - level
-
- Type: string
Defines which category of execution history events are logged.
MapIterationEventDetails
Description
Contains details about an iteration of a Map state.
Members
MapStateStartedEventDetails
Description
Details about a Map state that was started.
Members
MissingRequiredParameter
Description
Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.
Members
ResourceNotFound
Description
Could not find the referenced resource. Only state machine and activity ARNs are supported.
Members
StateEnteredEventDetails
Description
Contains details about a state entered during an execution.
Members
- input
-
- Type: string
The string that contains the JSON input data for the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- inputDetails
-
- Type: HistoryEventExecutionDataDetails structure
Contains details about the input for an execution history event.
- name
-
- Required: Yes
- Type: string
The name of the state.
StateExitedEventDetails
Description
Contains details about an exit from a state during an execution.
Members
- name
-
- Required: Yes
- Type: string
The name of the state.
A name must not contain:
-
white space
-
brackets
< > { } [ ] -
wildcard characters
? * -
special characters
" # % \ ^ | ~ ` $ & , ; : / -
control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
- output
-
- Type: string
The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- outputDetails
-
- Type: HistoryEventExecutionDataDetails structure
Contains details about the output of an execution history event.
StateMachineAlreadyExists
Description
A state machine with the same name but a different definition or role ARN already exists.
Members
StateMachineDeleting
StateMachineDoesNotExist
StateMachineLimitExceeded
Description
The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.
Members
StateMachineListItem
Description
Contains details about the state machine.
Members
- creationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the state machine is created.
- name
-
- Required: Yes
- Type: string
The name of the state machine.
A name must not contain:
-
white space
-
brackets
< > { } [ ] -
wildcard characters
? * -
special characters
" # % \ ^ | ~ ` $ & , ; : / -
control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
- stateMachineArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the state machine.
- type
-
- Required: Yes
- Type: string
StateMachineTypeNotSupported
Tag
Description
Tags are key-value pairs that can be associated with Step Functions state machines and activities.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
Members
TaskDoesNotExist
TaskFailedEventDetails
Description
Contains details about a task failure event.
Members
- cause
-
- Type: string
A more detailed explanation of the cause of the failure.
- error
-
- Type: string
The error code of the failure.
- resource
-
- Required: Yes
- Type: string
The service name of the resource in a task state.
- resourceType
-
- Required: Yes
- Type: string
The action of the resource called by a task state.
TaskScheduledEventDetails
Description
Contains details about a task scheduled during an execution.
Members
- heartbeatInSeconds
-
- Type: long (int|float)
The maximum allowed duration between two heartbeats for the task.
- parameters
-
- Required: Yes
- Type: string
The JSON data passed to the resource referenced in a task state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- region
-
- Required: Yes
- Type: string
The region of the scheduled task
- resource
-
- Required: Yes
- Type: string
The service name of the resource in a task state.
- resourceType
-
- Required: Yes
- Type: string
The action of the resource called by a task state.
- timeoutInSeconds
-
- Type: long (int|float)
The maximum allowed duration of the task.
TaskStartFailedEventDetails
Description
Contains details about a task that failed to start during an execution.
Members
- cause
-
- Type: string
A more detailed explanation of the cause of the failure.
- error
-
- Type: string
The error code of the failure.
- resource
-
- Required: Yes
- Type: string
The service name of the resource in a task state.
- resourceType
-
- Required: Yes
- Type: string
The action of the resource called by a task state.
TaskStartedEventDetails
Description
Contains details about the start of a task during an execution.
Members
TaskSubmitFailedEventDetails
Description
Contains details about a task that failed to submit during an execution.
Members
- cause
-
- Type: string
A more detailed explanation of the cause of the failure.
- error
-
- Type: string
The error code of the failure.
- resource
-
- Required: Yes
- Type: string
The service name of the resource in a task state.
- resourceType
-
- Required: Yes
- Type: string
The action of the resource called by a task state.
TaskSubmittedEventDetails
Description
Contains details about a task submitted to a resource .
Members
- output
-
- Type: string
The response from a resource when a task has started. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- outputDetails
-
- Type: HistoryEventExecutionDataDetails structure
Contains details about the output of an execution history event.
- resource
-
- Required: Yes
- Type: string
The service name of the resource in a task state.
- resourceType
-
- Required: Yes
- Type: string
The action of the resource called by a task state.
TaskSucceededEventDetails
Description
Contains details about the successful completion of a task state.
Members
- output
-
- Type: string
The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- outputDetails
-
- Type: HistoryEventExecutionDataDetails structure
Contains details about the output of an execution history event.
- resource
-
- Required: Yes
- Type: string
The service name of the resource in a task state.
- resourceType
-
- Required: Yes
- Type: string
The action of the resource called by a task state.
TaskTimedOut
TaskTimedOutEventDetails
Description
Contains details about a resource timeout that occurred during an execution.
Members
- cause
-
- Type: string
A more detailed explanation of the cause of the failure.
- error
-
- Type: string
The error code of the failure.
- resource
-
- Required: Yes
- Type: string
The service name of the resource in a task state.
- resourceType
-
- Required: Yes
- Type: string
The action of the resource called by a task state.
TooManyTags
Description
You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS Step Functions Developer Guide.