'2.0', 'service' => '
Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the Step Functions Developer Guide .
', 'operations' => [ 'CreateActivity' => 'Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to 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.
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 Step Functions User Guide.
If you set the publish
parameter of this API action to true
, it publishes version 1
as the first revision of the state machine.
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
. The check is also based on the publish
and versionDescription
parameters. 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.
Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client\'s code.
You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig
object in the routingConfiguration
parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig
objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.
To create an alias that points to a single version, specify a single RoutingConfig
object with a weight
set to 100.
You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.
CreateStateMachineAlias
is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn
, description
, name
, and routingConfiguration
parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.
Related operations:
', 'DeleteActivity' => 'Deletes an activity.
', 'DeleteStateMachine' => 'Deletes a state machine. This is an asynchronous operation: It sets the state machine\'s status to DELETING
and begins the deletion process.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel
in a state machine named myStateMachine
.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException
.
The following unqualified state machine ARN refers to a state machine named myStateMachine
.
arn:partition:states:region:account-id:stateMachine:myStateMachine
This API action also deletes all versions and aliases associated with a state machine.
For EXPRESS
state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine
API is called.
Deletes a state machine alias.
After you delete a state machine alias, you can\'t use it to start executions. When you delete a state machine alias, Step Functions doesn\'t delete the state machine versions that alias references.
Related operations:
', 'DeleteStateMachineVersion' => 'Deletes a state machine version. After you delete a version, you can\'t call StartExecution using that version\'s ARN or use the version with a state machine alias.
Deleting a state machine version won\'t terminate its in-progress executions.
You can\'t delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.
Related operations:
', 'DescribeActivity' => 'Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.
If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution
returns that ARN.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Executions of an EXPRESS
state machinearen\'t supported by DescribeExecution
unless a Map Run dispatched them.
Provides information about a Map Run\'s configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.
', 'DescribeStateMachine' => 'Provides information about a state machine\'s definition, its IAM role Amazon Resource Name (ARN), and configuration.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel
in a state machine named myStateMachine
.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException
.
The following qualified state machine ARN refers to an alias named PROD
.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following unqualified state machine ARN refers to a state machine named myStateMachine
.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
This API action returns the details for a state machine version if the stateMachineArn
you specify is a state machine version ARN.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Returns details about a state machine alias.
Related operations:
', 'DescribeStateMachineForExecution' => 'Provides information about a state machine\'s definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.
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.
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.
This API action isn\'t logged in CloudTrail.
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.
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.
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.
Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.
You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.
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.
Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun
to obtain more information, if needed.
Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.
To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn
parameter.
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.
Related operations:
', 'ListStateMachineVersions' => 'Lists versions for the specified state machine Amazon Resource Name (ARN).
The results are sorted in descending order of the version creation time.
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.
Related operations:
', 'ListStateMachines' => '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.
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.
You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.
PublishStateMachineVersion
is an idempotent API. It doesn\'t create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion
\'s idempotency check on the stateMachineArn
, name
, and revisionId
parameters. Requests with the same parameters return a successful idempotent response. If you don\'t specify a revisionId
, Step Functions checks for a previously published version of the state machine\'s current revision.
Related operations:
', 'SendTaskFailure' => 'Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken
failed.
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.
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken
completed successfully.
Starts a state machine execution.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel
in a state machine named myStateMachine
.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException
.
The following qualified state machine ARN refers to an alias named PROD
.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following unqualified state machine ARN refers to a state machine named myStateMachine
.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.
To start executions of a state machine version, call StartExecution
and provide the version ARN or the ARN of an alias that points to the version.
StartExecution
is idempotent for STANDARD
workflows. For a STANDARD
workflow, if you call StartExecution
with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists
error. You can reuse names after 90 days.
StartExecution
isn\'t idempotent for EXPRESS
workflows.
Starts a Synchronous Express state machine execution. StartSyncExecution
is not available for STANDARD
workflows.
StartSyncExecution
will return a 200 OK
response, even if your execution fails, because the status code in the API response doesn\'t reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.
This API action isn\'t logged in CloudTrail.
Stops an execution.
This API action is not supported by EXPRESS
state machines.
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
Remove a tag from a Step Functions resource
', 'UpdateMapRun' => 'Updates an in-progress Map Run\'s configuration to include changes to the settings that control maximum concurrency and Map Run failure.
', 'UpdateStateMachine' => '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.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel
refers to a Distributed Map state with a label mapStateLabel
in the state machine named stateMachineName
.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel
in a state machine named myStateMachine
.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException
.
The following qualified state machine ARN refers to an alias named PROD
.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following unqualified state machine ARN refers to a state machine named myStateMachine
.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
After you update your state machine, you can set the publish
parameter to true
in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.
Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.
All StartExecution
calls within a few seconds use the updated definition
and roleArn
. Executions started immediately after you call UpdateStateMachine
may use the previous state machine definition
and roleArn
.
Updates the configuration of an existing state machine alias by modifying its description
or routingConfiguration
.
You must specify at least one of the description
or routingConfiguration
parameters to update a state machine alias.
UpdateStateMachineAlias
is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn
, description
, and routingConfiguration
parameters. Requests with the same parameters return an idempotent response.
This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias
may use the previous routing configuration.
Related operations:
', ], 'shapes' => [ 'ActivityDoesNotExist' => [ 'base' => 'The specified activity does not exist.
', 'refs' => [], ], 'ActivityFailedEventDetails' => [ 'base' => 'Contains details about an activity that failed during an execution.
', 'refs' => [ 'HistoryEvent$activityFailedEventDetails' => NULL, ], ], 'ActivityLimitExceeded' => [ 'base' => 'The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
', 'refs' => [], ], 'ActivityList' => [ 'base' => NULL, 'refs' => [ 'ListActivitiesOutput$activities' => 'The list of activities.
', ], ], 'ActivityListItem' => [ 'base' => 'Contains details about an activity.
', 'refs' => [ 'ActivityList$member' => NULL, ], ], 'ActivityScheduleFailedEventDetails' => [ 'base' => 'Contains details about an activity schedule failure that occurred during an execution.
', 'refs' => [ 'HistoryEvent$activityScheduleFailedEventDetails' => 'Contains details about an activity schedule event that failed during an execution.
', ], ], 'ActivityScheduledEventDetails' => [ 'base' => 'Contains details about an activity scheduled during an execution.
', 'refs' => [ 'HistoryEvent$activityScheduledEventDetails' => NULL, ], ], 'ActivityStartedEventDetails' => [ 'base' => 'Contains details about the start of an activity during an execution.
', 'refs' => [ 'HistoryEvent$activityStartedEventDetails' => NULL, ], ], 'ActivitySucceededEventDetails' => [ 'base' => 'Contains details about an activity that successfully terminated during an execution.
', 'refs' => [ 'HistoryEvent$activitySucceededEventDetails' => NULL, ], ], 'ActivityTimedOutEventDetails' => [ 'base' => 'Contains details about an activity timeout that occurred during an execution.
', 'refs' => [ 'HistoryEvent$activityTimedOutEventDetails' => NULL, ], ], 'ActivityWorkerLimitExceeded' => [ 'base' => 'The maximum number of workers concurrently polling for activity tasks has been reached.
', 'refs' => [], ], 'AliasDescription' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineAliasInput$description' => 'A description for the state machine alias.
', 'DescribeStateMachineAliasOutput$description' => 'A description of the alias.
', 'UpdateStateMachineAliasInput$description' => 'A description of the state machine alias.
', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'ActivityListItem$activityArn' => 'The Amazon Resource Name (ARN) that identifies the activity.
', 'ActivityScheduledEventDetails$resource' => 'The Amazon Resource Name (ARN) of the scheduled activity.
', 'CloudWatchLogsLogGroup$logGroupArn' => 'The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
The Amazon Resource Name (ARN) that identifies the created activity.
', 'CreateStateMachineAliasOutput$stateMachineAliasArn' => 'The Amazon Resource Name (ARN) that identifies the created state machine alias.
', 'CreateStateMachineInput$roleArn' => 'The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
', 'CreateStateMachineOutput$stateMachineArn' => 'The Amazon Resource Name (ARN) that identifies the created state machine.
', 'CreateStateMachineOutput$stateMachineVersionArn' => 'The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the publish
parameter to true
, this field returns null value.
The Amazon Resource Name (ARN) of the activity to delete.
', 'DeleteStateMachineAliasInput$stateMachineAliasArn' => 'The Amazon Resource Name (ARN) of the state machine alias to delete.
', 'DeleteStateMachineInput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine to delete.
', 'DescribeActivityInput$activityArn' => 'The Amazon Resource Name (ARN) of the activity to describe.
', 'DescribeActivityOutput$activityArn' => 'The Amazon Resource Name (ARN) that identifies the activity.
', 'DescribeExecutionInput$executionArn' => 'The Amazon Resource Name (ARN) of the execution to describe.
', 'DescribeExecutionOutput$executionArn' => 'The Amazon Resource Name (ARN) that identifies the execution.
', 'DescribeExecutionOutput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the executed stated machine.
', 'DescribeExecutionOutput$stateMachineVersionArn' => 'The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1
.
If you start an execution from a StartExecution
request without specifying a state machine version or alias ARN, Step Functions returns a null value.
The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD
.
If you start an execution from a StartExecution
request with a state machine version ARN, this field will be null.
The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.
', 'DescribeStateMachineAliasInput$stateMachineAliasArn' => 'The Amazon Resource Name (ARN) of the state machine alias.
', 'DescribeStateMachineAliasOutput$stateMachineAliasArn' => 'The Amazon Resource Name (ARN) of the state machine alias.
', 'DescribeStateMachineForExecutionInput$executionArn' => 'The Amazon Resource Name (ARN) of the execution you want state machine information for.
', 'DescribeStateMachineForExecutionOutput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine associated with the execution.
', 'DescribeStateMachineForExecutionOutput$roleArn' => 'The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
', 'DescribeStateMachineInput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine for which you want the information.
If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1
.
The Amazon Resource Name (ARN) that identifies the state machine.
If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1
.
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 Amazon Web Services resources.)
', 'ExecutionListItem$executionArn' => 'The Amazon Resource Name (ARN) that identifies the execution.
', 'ExecutionListItem$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine that ran the execution.
', 'ExecutionListItem$stateMachineVersionArn' => 'The Amazon Resource Name (ARN) of the state machine version associated with the execution.
If the state machine execution was started with an unqualified ARN, it returns null.
If the execution was started using a stateMachineAliasArn
, both the stateMachineAliasArn
and stateMachineVersionArn
parameters contain the respective values.
The Amazon Resource Name (ARN) of the state machine alias used to start an execution.
If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.
', 'ExecutionStartedEventDetails$roleArn' => 'The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.
', 'ExecutionStartedEventDetails$stateMachineAliasArn' => 'The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.
', 'ExecutionStartedEventDetails$stateMachineVersionArn' => 'The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.
', 'GetActivityTaskInput$activityArn' => 'The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)
', 'GetExecutionHistoryInput$executionArn' => 'The Amazon Resource Name (ARN) of the execution.
', 'LambdaFunctionScheduledEventDetails$resource' => 'The Amazon Resource Name (ARN) of the scheduled Lambda function.
', 'ListExecutionsInput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine whose executions is listed.
You can specify either a mapRunArn
or a stateMachineArn
, but not both.
You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn
parameter.
The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.
', 'ListStateMachineAliasesInput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.
If you specify a state machine version ARN, this API returns a list of aliases for that version.
', 'ListStateMachineVersionsInput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine.
', 'ListTagsForResourceInput$resourceArn' => 'The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
', 'MapRunListItem$executionArn' => 'The executionArn
of the execution from which the Map Run was started.
The Amazon Resource Name (ARN) of the executed state machine.
', 'PublishStateMachineVersionInput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine.
', 'PublishStateMachineVersionOutput$stateMachineVersionArn' => 'The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.
', 'ResourceNotFound$resourceName' => NULL, 'RoutingConfigurationListItem$stateMachineVersionArn' => 'The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
If you specify the ARN of a second version, it must belong to the same state machine as the first version.
', 'StartExecutionInput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine to execute.
The stateMachineArn
parameter accepts one of the following inputs:
An unqualified state machine ARN – Refers to a state machine ARN that isn\'t qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
Step Functions doesn\'t associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.
A state machine version ARN – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10
Step Functions doesn\'t associate executions that you start with a version ARN with any aliases that point to that version.
A state machine alias ARN – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named PROD
.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.
The Amazon Resource Name (ARN) that identifies the execution.
', 'StartSyncExecutionInput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine to execute.
', 'StartSyncExecutionOutput$executionArn' => 'The Amazon Resource Name (ARN) that identifies the execution.
', 'StartSyncExecutionOutput$stateMachineArn' => 'The Amazon Resource Name (ARN) that identifies the state machine.
', 'StateMachineListItem$stateMachineArn' => 'The Amazon Resource Name (ARN) that identifies the state machine.
', 'StopExecutionInput$executionArn' => 'The Amazon Resource Name (ARN) of the execution to stop.
', 'TagResourceInput$resourceArn' => 'The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
', 'TooManyTags$resourceName' => NULL, 'UntagResourceInput$resourceArn' => 'The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
', 'UpdateStateMachineAliasInput$stateMachineAliasArn' => 'The Amazon Resource Name (ARN) of the state machine alias.
', 'UpdateStateMachineInput$stateMachineArn' => 'The Amazon Resource Name (ARN) of the state machine.
', 'UpdateStateMachineInput$roleArn' => 'The Amazon Resource Name (ARN) of the IAM role of the state machine.
', 'UpdateStateMachineOutput$stateMachineVersionArn' => 'The Amazon Resource Name (ARN) of the published state machine version.
If the publish
parameter isn\'t set to true
, this field returns null.
Billed duration of your workflow, in milliseconds.
', ], ], 'BilledMemoryUsed' => [ 'base' => NULL, 'refs' => [ 'BillingDetails$billedMemoryUsedInMB' => 'Billed memory consumption of your workflow, in MB.
', ], ], 'BillingDetails' => [ 'base' => 'An object that describes workflow billing details.
', 'refs' => [ 'StartSyncExecutionOutput$billingDetails' => 'An object that describes workflow billing details, including billed duration and memory use.
', ], ], 'CharacterRestrictedName' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineAliasInput$name' => 'The name of the state machine alias.
To avoid conflict with version ARNs, don\'t use an integer in the name of the alias.
', ], ], 'CloudWatchEventsExecutionDataDetails' => [ 'base' => 'Provides details about execution input or output.
', 'refs' => [ 'DescribeExecutionOutput$inputDetails' => NULL, 'DescribeExecutionOutput$outputDetails' => NULL, 'StartSyncExecutionOutput$inputDetails' => NULL, 'StartSyncExecutionOutput$outputDetails' => NULL, ], ], 'CloudWatchLogsLogGroup' => [ 'base' => '', 'refs' => [ 'LogDestination$cloudWatchLogsLogGroup' => 'An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.
', ], ], 'ConflictException' => [ 'base' => 'Updating or deleting a resource can cause an inconsistent state. This error occurs when there\'re concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish
parameter set to true
.
HTTP Status Code: 409
', 'refs' => [], ], 'ConnectorParameters' => [ 'base' => NULL, 'refs' => [ 'TaskScheduledEventDetails$parameters' => '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.
', ], ], 'CreateActivityInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateActivityOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'Definition' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$definition' => 'The Amazon States Language definition of the state machine. See Amazon States Language.
', 'DescribeStateMachineForExecutionOutput$definition' => 'The Amazon States Language definition of the state machine. See Amazon States Language.
', 'DescribeStateMachineOutput$definition' => 'The Amazon States Language definition of the state machine. See Amazon States Language.
', 'UpdateStateMachineInput$definition' => 'The Amazon States Language definition of the state machine. See Amazon States Language.
', ], ], 'DeleteActivityInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteActivityOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineVersionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActivityInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActivityOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMapRunInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMapRunOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineForExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineForExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'Enabled' => [ 'base' => NULL, 'refs' => [ 'TracingConfiguration$enabled' => 'When set to true
, X-Ray tracing is enabled.
The id of the event. Events are numbered sequentially, starting at one.
', 'HistoryEvent$previousEventId' => 'The id of the previous event.
', ], ], 'ExecutionAbortedEventDetails' => [ 'base' => 'Contains details about an abort of an execution.
', 'refs' => [ 'HistoryEvent$executionAbortedEventDetails' => NULL, ], ], 'ExecutionAlreadyExists' => [ 'base' => 'The execution has the same name
as another execution (but a different input
).
Executions with the same name
and input
are considered idempotent.
The specified execution does not exist.
', 'refs' => [], ], 'ExecutionFailedEventDetails' => [ 'base' => 'Contains details about an execution failure event.
', 'refs' => [ 'HistoryEvent$executionFailedEventDetails' => NULL, ], ], 'ExecutionLimitExceeded' => [ 'base' => 'The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
', 'refs' => [], ], 'ExecutionList' => [ 'base' => NULL, 'refs' => [ 'ListExecutionsOutput$executions' => 'The list of matching executions.
', ], ], 'ExecutionListItem' => [ 'base' => 'Contains details about an execution.
', 'refs' => [ 'ExecutionList$member' => NULL, ], ], 'ExecutionStartedEventDetails' => [ 'base' => 'Contains details about the start of the execution.
', 'refs' => [ 'HistoryEvent$executionStartedEventDetails' => NULL, ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionOutput$status' => 'The current status of the execution.
', 'ExecutionListItem$status' => 'The current status of the execution.
', 'ListExecutionsInput$statusFilter' => 'If specified, only list the executions whose current execution status matches the given filter.
', ], ], 'ExecutionSucceededEventDetails' => [ 'base' => 'Contains details about the successful termination of the execution.
', 'refs' => [ 'HistoryEvent$executionSucceededEventDetails' => NULL, ], ], 'ExecutionTimedOutEventDetails' => [ 'base' => 'Contains details about the execution timeout that occurred during the execution.
', 'refs' => [ 'HistoryEvent$executionTimedOutEventDetails' => NULL, ], ], 'GetActivityTaskInput' => [ 'base' => NULL, 'refs' => [], ], 'GetActivityTaskOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetExecutionHistoryInput' => [ 'base' => NULL, 'refs' => [], ], 'GetExecutionHistoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'HistoryEvent' => [ 'base' => 'Contains details about the events of an execution.
', 'refs' => [ 'HistoryEventList$member' => NULL, ], ], 'HistoryEventExecutionDataDetails' => [ 'base' => 'Provides details about input or output in an execution history event.
', 'refs' => [ 'ActivityScheduledEventDetails$inputDetails' => 'Contains details about the input for an execution history event.
', 'ActivitySucceededEventDetails$outputDetails' => 'Contains details about the output of an execution history event.
', 'ExecutionStartedEventDetails$inputDetails' => 'Contains details about the input for an execution history event.
', 'ExecutionSucceededEventDetails$outputDetails' => 'Contains details about the output of an execution history event.
', 'LambdaFunctionScheduledEventDetails$inputDetails' => 'Contains details about input for an execution history event.
', 'LambdaFunctionSucceededEventDetails$outputDetails' => 'Contains details about the output of an execution history event.
', 'StateEnteredEventDetails$inputDetails' => 'Contains details about the input for an execution history event.
', 'StateExitedEventDetails$outputDetails' => 'Contains details about the output of an execution history event.
', 'TaskSubmittedEventDetails$outputDetails' => 'Contains details about the output of an execution history event.
', 'TaskSucceededEventDetails$outputDetails' => 'Contains details about the output of an execution history event.
', ], ], 'HistoryEventList' => [ 'base' => 'Contains details about the events that occurred during an execution.
', 'refs' => [ 'GetExecutionHistoryOutput$events' => 'The list of events that occurred in the execution.
', ], ], 'HistoryEventType' => [ 'base' => NULL, 'refs' => [ 'HistoryEvent$type' => 'The type of the event.
', ], ], 'Identity' => [ 'base' => NULL, 'refs' => [ 'ActivityStartedEventDetails$workerName' => 'The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.
', ], ], 'IncludeExecutionData' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$includeExecutionData' => 'Determines whether execution data is included in your log. When set to false
, data is excluded.
You can select whether execution data (input or output of a history event) is returned. The default is true
.
The provided Amazon Resource Name (ARN) is not valid.
', 'refs' => [], ], 'InvalidDefinition' => [ 'base' => 'The provided Amazon States Language definition is not valid.
', 'refs' => [], ], 'InvalidExecutionInput' => [ 'base' => 'The provided JSON input data is not valid.
', 'refs' => [], ], 'InvalidLoggingConfiguration' => [ 'base' => '', 'refs' => [], ], 'InvalidName' => [ 'base' => 'The provided name is not valid.
', 'refs' => [], ], 'InvalidOutput' => [ 'base' => 'The provided JSON output data is not valid.
', 'refs' => [], ], 'InvalidToken' => [ 'base' => 'The provided token is not valid.
', 'refs' => [], ], 'InvalidTracingConfiguration' => [ 'base' => 'Your tracingConfiguration
key does not match, or enabled
has not been set to true
or false
.
Contains details about a Lambda function that failed during an execution.
', 'refs' => [ 'HistoryEvent$lambdaFunctionFailedEventDetails' => NULL, ], ], 'LambdaFunctionScheduleFailedEventDetails' => [ 'base' => 'Contains details about a failed Lambda function schedule event that occurred during an execution.
', 'refs' => [ 'HistoryEvent$lambdaFunctionScheduleFailedEventDetails' => NULL, ], ], 'LambdaFunctionScheduledEventDetails' => [ 'base' => 'Contains details about a Lambda function scheduled during an execution.
', 'refs' => [ 'HistoryEvent$lambdaFunctionScheduledEventDetails' => NULL, ], ], 'LambdaFunctionStartFailedEventDetails' => [ 'base' => 'Contains details about a lambda function that failed to start during an execution.
', 'refs' => [ 'HistoryEvent$lambdaFunctionStartFailedEventDetails' => 'Contains details about a lambda function that failed to start during an execution.
', ], ], 'LambdaFunctionSucceededEventDetails' => [ 'base' => 'Contains details about a Lambda function that successfully terminated during an execution.
', 'refs' => [ 'HistoryEvent$lambdaFunctionSucceededEventDetails' => 'Contains details about a Lambda function that terminated successfully during an execution.
', ], ], 'LambdaFunctionTimedOutEventDetails' => [ 'base' => 'Contains details about a Lambda function timeout that occurred during an execution.
', 'refs' => [ 'HistoryEvent$lambdaFunctionTimedOutEventDetails' => NULL, ], ], 'ListActivitiesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListActivitiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsPageToken' => [ 'base' => NULL, 'refs' => [ 'ListExecutionsInput$nextToken' => '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.
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.
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
.
Defines which category of execution history events are logged.
', ], ], 'LoggingConfiguration' => [ 'base' => 'The LoggingConfiguration
data type is used to set CloudWatch Logs options.
Defines what execution history events are logged and where they are logged.
By default, the level
is set to OFF
. For more information see Log Levels in the Step Functions User Guide.
Use the LoggingConfiguration
data type to set CloudWatch Logs options.
The Amazon Resource Name (ARN) of the state machine version to delete.
', 'DescribeExecutionOutput$mapRunArn' => 'The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
', 'DescribeMapRunInput$mapRunArn' => 'The Amazon Resource Name (ARN) that identifies a Map Run.
', 'DescribeMapRunOutput$mapRunArn' => 'The Amazon Resource Name (ARN) that identifies a Map Run.
', 'DescribeStateMachineForExecutionOutput$mapRunArn' => 'The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn
is a child workflow execution that was started by a Distributed Map state.
The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn
was specified in the ListExecutions
API action. If stateMachineArn
was specified in ListExecutions
, the mapRunArn
isn\'t returned.
The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn
field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.
You can specify either a mapRunArn
or a stateMachineArn
, but not both.
The Amazon Resource Name (ARN) of the Map Run.
', 'MapRunStartedEventDetails$mapRunArn' => 'The Amazon Resource Name (ARN) of a Map Run that was started.
', 'StateMachineAliasListItem$stateMachineAliasArn' => 'The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD
.
The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1
.
The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.
', 'UpdateMapRunInput$mapRunArn' => 'The Amazon Resource Name (ARN) of a Map Run.
', ], ], 'MapIterationEventDetails' => [ 'base' => 'Contains details about an iteration of a Map state.
', 'refs' => [ 'HistoryEvent$mapIterationStartedEventDetails' => 'Contains details about an iteration of a Map state that was started.
', 'HistoryEvent$mapIterationSucceededEventDetails' => 'Contains details about an iteration of a Map state that succeeded.
', 'HistoryEvent$mapIterationFailedEventDetails' => 'Contains details about an iteration of a Map state that failed.
', 'HistoryEvent$mapIterationAbortedEventDetails' => 'Contains details about an iteration of a Map state that was aborted.
', ], ], 'MapRunExecutionCounts' => [ 'base' => 'Contains details about all of the child workflow executions started by a Map Run.
', 'refs' => [ 'DescribeMapRunOutput$executionCounts' => 'A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed
and succeeded
.
Contains details about a Map Run failure event that occurred during a state machine execution.
', 'refs' => [ 'HistoryEvent$mapRunFailedEventDetails' => 'Contains error and cause details about a Map Run that failed.
', ], ], 'MapRunItemCounts' => [ 'base' => 'Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.
', 'refs' => [ 'DescribeMapRunOutput$itemCounts' => 'A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending
and failed
.
A user-defined or an auto-generated string that identifies a Map
state. This field is returned only if the executionArn
is a child workflow execution that was started by a Distributed Map state.
A user-defined or an auto-generated string that identifies a Map
state. This parameter is present only if the stateMachineArn
specified in input is a qualified state machine ARN.
An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.
', ], ], 'MapRunListItem' => [ 'base' => 'Contains details about a specific Map Run.
', 'refs' => [ 'MapRunList$member' => NULL, ], ], 'MapRunStartedEventDetails' => [ 'base' => 'Contains details about a Map Run that was started during a state machine execution.
', 'refs' => [ 'HistoryEvent$mapRunStartedEventDetails' => 'Contains details, such as mapRunArn
, and the start date and time of a Map Run. mapRunArn
is the Amazon Resource Name (ARN) of the Map Run that was started.
The current status of the Map Run.
', ], ], 'MapStateStartedEventDetails' => [ 'base' => 'Details about a Map state that was started.
', 'refs' => [ 'HistoryEvent$mapStateStartedEventDetails' => 'Contains details about Map state that was started.
', ], ], 'MaxConcurrency' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$maxConcurrency' => 'The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.
', 'UpdateMapRunInput$maxConcurrency' => 'The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.
', ], ], 'MissingRequiredParameter' => [ 'base' => 'Request is missing a required parameter. This error occurs if both definition
and roleArn
are not specified.
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 _.
', 'CreateActivityInput$name' => 'The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information, see Limits Related to State Machine Executions in the 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 _.
', 'CreateStateMachineInput$name' => '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 _.
', 'DescribeActivityOutput$name' => '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 _.
', 'DescribeExecutionOutput$name' => '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 _.
', 'DescribeStateMachineAliasOutput$name' => 'The name of the state machine alias.
', 'DescribeStateMachineForExecutionOutput$name' => 'The name of the state machine associated with the execution.
', 'DescribeStateMachineOutput$name' => '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 _.
', 'ExecutionListItem$name' => '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 _.
', 'GetActivityTaskInput$workerName' => '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.
', 'MapIterationEventDetails$name' => 'The name of the iteration’s parent Map state.
', 'StartExecutionInput$name' => 'Optional name of the execution. This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the 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 _.
', 'StartSyncExecutionInput$name' => 'The name of the execution.
', 'StartSyncExecutionOutput$name' => 'The name of the execution.
', 'StateEnteredEventDetails$name' => 'The name of the state.
', 'StateExitedEventDetails$name' => '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 _.
', 'StateMachineListItem$name' => '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 _.
', 'TaskFailedEventDetails$resourceType' => 'The service name of the resource in a task state.
', 'TaskFailedEventDetails$resource' => 'The action of the resource called by a task state.
', 'TaskScheduledEventDetails$resourceType' => 'The service name of the resource in a task state.
', 'TaskScheduledEventDetails$resource' => 'The action of the resource called by a task state.
', 'TaskScheduledEventDetails$region' => 'The region of the scheduled task
', 'TaskStartFailedEventDetails$resourceType' => 'The service name of the resource in a task state.
', 'TaskStartFailedEventDetails$resource' => 'The action of the resource called by a task state.
', 'TaskStartedEventDetails$resourceType' => 'The service name of the resource in a task state.
', 'TaskStartedEventDetails$resource' => 'The action of the resource called by a task state.
', 'TaskSubmitFailedEventDetails$resourceType' => 'The service name of the resource in a task state.
', 'TaskSubmitFailedEventDetails$resource' => 'The action of the resource called by a task state.
', 'TaskSubmittedEventDetails$resourceType' => 'The service name of the resource in a task state.
', 'TaskSubmittedEventDetails$resource' => 'The action of the resource called by a task state.
', 'TaskSucceededEventDetails$resourceType' => 'The service name of the resource in a task state.
', 'TaskSucceededEventDetails$resource' => 'The action of the resource called by a task state.
', 'TaskTimedOutEventDetails$resourceType' => 'The service name of the resource in a task state.
', 'TaskTimedOutEventDetails$resource' => 'The action of the resource called by a task state.
', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', 'ListActivitiesInput$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', 'ListExecutionsInput$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', 'ListMapRunsInput$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', 'ListStateMachineAliasesInput$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', 'ListStateMachineVersionsInput$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', 'ListStateMachinesInput$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', ], ], 'PageToken' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$nextToken' => '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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Set to true
to publish the first version of the state machine during creation. The default is false
.
Specifies whether the state machine version is published. The default is false
. To publish a version after updating the state machine, set publish
to true
.
Could not find the referenced resource.
', 'refs' => [], ], 'ReverseOrder' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$reverseOrder' => 'Lists events in descending order of their timeStamp
.
The revision identifier for the state machine. The first revision ID when you create the state machine is null.
Use the state machine revisionId
parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition
and roleArn
.
The revision identifier for the state machine.
Use the revisionId
parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition
and roleArn
.
Only publish the state machine version if the current state machine\'s revision ID matches the specified ID.
Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn\'t match the state machine\'s current revision ID, the API returns ConflictException
.
To specify an initial revision ID for a state machine with no revision ID assigned, specify the string INITIAL
for the revisionId
parameter. For example, you can specify a revisionID
of INITIAL
when you create a state machine using the CreateStateMachine API action.
The revision identifier for the updated state machine.
', ], ], 'RoutingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineAliasInput$routingConfiguration' => 'The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. routingConfiguration
contains an array of RoutingConfig
objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig
.
The routing configuration of the alias.
', 'UpdateStateMachineAliasInput$routingConfiguration' => 'The routing configuration of the state machine alias.
An array of RoutingConfig
objects that specifies up to two state machine versions that the alias starts executions for.
Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.
', 'refs' => [ 'RoutingConfigurationList$member' => NULL, ], ], 'SendTaskFailureInput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskFailureOutput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskHeartbeatInput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskHeartbeatOutput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskSuccessInput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskSuccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'SensitiveCause' => [ 'base' => NULL, 'refs' => [ 'ActivityFailedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'ActivityScheduleFailedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'ActivityTimedOutEventDetails$cause' => 'A more detailed explanation of the cause of the timeout.
', 'DescribeExecutionOutput$cause' => 'The cause string if the state machine execution failed.
', 'ExecutionAbortedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'ExecutionFailedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'ExecutionTimedOutEventDetails$cause' => 'A more detailed explanation of the cause of the timeout.
', 'LambdaFunctionFailedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'LambdaFunctionScheduleFailedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'LambdaFunctionStartFailedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'LambdaFunctionTimedOutEventDetails$cause' => 'A more detailed explanation of the cause of the timeout.
', 'MapRunFailedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'SendTaskFailureInput$cause' => 'A more detailed explanation of the cause of the failure.
', 'StartSyncExecutionOutput$cause' => 'A more detailed explanation of the cause of the failure.
', 'StopExecutionInput$cause' => 'A more detailed explanation of the cause of the failure.
', 'TaskFailedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'TaskStartFailedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'TaskSubmitFailedEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', 'TaskTimedOutEventDetails$cause' => 'A more detailed explanation of the cause of the failure.
', ], ], 'SensitiveData' => [ 'base' => NULL, 'refs' => [ 'ActivityScheduledEventDetails$input' => 'The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
', 'ActivitySucceededEventDetails$output' => 'The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
', 'DescribeExecutionOutput$input' => '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.
', 'DescribeExecutionOutput$output' => '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.
The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
', 'ExecutionSucceededEventDetails$output' => 'The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
', 'LambdaFunctionScheduledEventDetails$input' => 'The JSON data input to the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
', 'LambdaFunctionSucceededEventDetails$output' => 'The JSON data output by the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
', 'SendTaskSuccessInput$output' => 'The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
', 'StartExecutionInput$input' => '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.
', 'StartSyncExecutionInput$input' => '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.
', 'StartSyncExecutionOutput$input' => '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.
', 'StartSyncExecutionOutput$output' => '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.
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.
', 'StateExitedEventDetails$output' => 'The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
', 'TaskSubmittedEventDetails$output' => '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.
', 'TaskSucceededEventDetails$output' => '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.
', ], ], 'SensitiveDataJobInput' => [ 'base' => NULL, 'refs' => [ 'GetActivityTaskOutput$input' => '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.
', ], ], 'SensitiveError' => [ 'base' => NULL, 'refs' => [ 'ActivityFailedEventDetails$error' => 'The error code of the failure.
', 'ActivityScheduleFailedEventDetails$error' => 'The error code of the failure.
', 'ActivityTimedOutEventDetails$error' => 'The error code of the failure.
', 'DescribeExecutionOutput$error' => 'The error string if the state machine execution failed.
', 'ExecutionAbortedEventDetails$error' => 'The error code of the failure.
', 'ExecutionFailedEventDetails$error' => 'The error code of the failure.
', 'ExecutionTimedOutEventDetails$error' => 'The error code of the failure.
', 'LambdaFunctionFailedEventDetails$error' => 'The error code of the failure.
', 'LambdaFunctionScheduleFailedEventDetails$error' => 'The error code of the failure.
', 'LambdaFunctionStartFailedEventDetails$error' => 'The error code of the failure.
', 'LambdaFunctionTimedOutEventDetails$error' => 'The error code of the failure.
', 'MapRunFailedEventDetails$error' => 'The error code of the Map Run failure.
', 'SendTaskFailureInput$error' => 'The error code of the failure.
', 'StartSyncExecutionOutput$error' => 'The error code of the failure.
', 'StopExecutionInput$error' => 'The error code of the failure.
', 'TaskFailedEventDetails$error' => 'The error code of the failure.
', 'TaskStartFailedEventDetails$error' => 'The error code of the failure.
', 'TaskSubmitFailedEventDetails$error' => 'The error code of the failure.
', 'TaskTimedOutEventDetails$error' => 'The error code of the failure.
', ], ], 'ServiceQuotaExceededException' => [ 'base' => 'The request would cause a service quota to be exceeded.
HTTP Status Code: 402
', 'refs' => [], ], 'StartExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StartExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'StartSyncExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StartSyncExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'StateEnteredEventDetails' => [ 'base' => 'Contains details about a state entered during an execution.
', 'refs' => [ 'HistoryEvent$stateEnteredEventDetails' => NULL, ], ], 'StateExitedEventDetails' => [ 'base' => 'Contains details about an exit from a state during an execution.
', 'refs' => [ 'HistoryEvent$stateExitedEventDetails' => NULL, ], ], 'StateMachineAliasList' => [ 'base' => NULL, 'refs' => [ 'ListStateMachineAliasesOutput$stateMachineAliases' => 'Aliases for the state machine.
', ], ], 'StateMachineAliasListItem' => [ 'base' => 'Contains details about a specific state machine alias.
', 'refs' => [ 'StateMachineAliasList$member' => NULL, ], ], 'StateMachineAlreadyExists' => [ 'base' => 'A state machine with the same name but a different definition or role ARN already exists.
', 'refs' => [], ], 'StateMachineDeleting' => [ 'base' => 'The specified state machine is being deleted.
', 'refs' => [], ], 'StateMachineDoesNotExist' => [ 'base' => 'The specified state machine does not exist.
', 'refs' => [], ], 'StateMachineLimitExceeded' => [ 'base' => 'The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.
', 'refs' => [], ], 'StateMachineList' => [ 'base' => NULL, 'refs' => [ 'ListStateMachinesOutput$stateMachines' => NULL, ], ], 'StateMachineListItem' => [ 'base' => 'Contains details about the state machine.
', 'refs' => [ 'StateMachineList$member' => NULL, ], ], 'StateMachineStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeStateMachineOutput$status' => 'The current status of the state machine.
', ], ], 'StateMachineType' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$type' => 'Determines whether a Standard or Express state machine is created. The default is STANDARD
. You cannot update the type
of a state machine once it has been created.
The type
of the state machine (STANDARD
or EXPRESS
).
Versions for the state machine.
', ], ], 'StateMachineVersionListItem' => [ 'base' => 'Contains details about a specific state machine version.
', 'refs' => [ 'StateMachineVersionList$member' => NULL, ], ], 'StopExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StopExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'SyncExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'StartSyncExecutionOutput$status' => 'The current status of the execution.
', ], ], 'Tag' => [ 'base' => '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 Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
The key of a tag.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceInput$tagKeys' => 'The list of tags to remove from the resource.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateActivityInput$tags' => '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 Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
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 Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
An array of tags associated with the resource.
', 'TagResourceInput$tags' => 'The list of tags to add to a resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
The value of a tag.
', ], ], 'TaskCredentials' => [ 'base' => 'Contains details about the credentials that Step Functions uses for a task.
', 'refs' => [ 'LambdaFunctionScheduledEventDetails$taskCredentials' => 'The credentials that Step Functions uses for the task.
', 'TaskScheduledEventDetails$taskCredentials' => 'The credentials that Step Functions uses for the task.
', ], ], 'TaskDoesNotExist' => [ 'base' => NULL, 'refs' => [], ], 'TaskFailedEventDetails' => [ 'base' => 'Contains details about a task failure event.
', 'refs' => [ 'HistoryEvent$taskFailedEventDetails' => 'Contains details about the failure of a task.
', ], ], 'TaskScheduledEventDetails' => [ 'base' => 'Contains details about a task scheduled during an execution.
', 'refs' => [ 'HistoryEvent$taskScheduledEventDetails' => 'Contains details about a task that was scheduled.
', ], ], 'TaskStartFailedEventDetails' => [ 'base' => 'Contains details about a task that failed to start during an execution.
', 'refs' => [ 'HistoryEvent$taskStartFailedEventDetails' => 'Contains details about a task that failed to start.
', ], ], 'TaskStartedEventDetails' => [ 'base' => 'Contains details about the start of a task during an execution.
', 'refs' => [ 'HistoryEvent$taskStartedEventDetails' => 'Contains details about a task that was started.
', ], ], 'TaskSubmitFailedEventDetails' => [ 'base' => 'Contains details about a task that failed to submit during an execution.
', 'refs' => [ 'HistoryEvent$taskSubmitFailedEventDetails' => 'Contains details about a task that where the submit failed.
', ], ], 'TaskSubmittedEventDetails' => [ 'base' => 'Contains details about a task submitted to a resource .
', 'refs' => [ 'HistoryEvent$taskSubmittedEventDetails' => 'Contains details about a submitted task.
', ], ], 'TaskSucceededEventDetails' => [ 'base' => 'Contains details about the successful completion of a task state.
', 'refs' => [ 'HistoryEvent$taskSucceededEventDetails' => 'Contains details about a task that succeeded.
', ], ], 'TaskTimedOut' => [ 'base' => NULL, 'refs' => [], ], 'TaskTimedOutEventDetails' => [ 'base' => 'Contains details about a resource timeout that occurred during an execution.
', 'refs' => [ 'HistoryEvent$taskTimedOutEventDetails' => 'Contains details about a task that timed out.
', ], ], 'TaskToken' => [ 'base' => NULL, 'refs' => [ 'GetActivityTaskOutput$taskToken' => '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.
', 'SendTaskFailureInput$taskToken' => '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.
', 'SendTaskHeartbeatInput$taskToken' => '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.
', 'SendTaskSuccessInput$taskToken' => '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.
', ], ], 'TimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ActivityScheduledEventDetails$timeoutInSeconds' => 'The maximum allowed duration of the activity task.
', 'ActivityScheduledEventDetails$heartbeatInSeconds' => 'The maximum allowed duration between two heartbeats for the activity task.
', 'LambdaFunctionScheduledEventDetails$timeoutInSeconds' => 'The maximum allowed duration of the Lambda function.
', 'TaskScheduledEventDetails$timeoutInSeconds' => 'The maximum allowed duration of the task.
', 'TaskScheduledEventDetails$heartbeatInSeconds' => 'The maximum allowed duration between two heartbeats for the task.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ActivityListItem$creationDate' => 'The date the activity is created.
', 'CreateActivityOutput$creationDate' => 'The date the activity is created.
', 'CreateStateMachineAliasOutput$creationDate' => 'The date the state machine alias was created.
', 'CreateStateMachineOutput$creationDate' => 'The date the state machine is created.
', 'DescribeActivityOutput$creationDate' => 'The date the activity is created.
', 'DescribeExecutionOutput$startDate' => 'The date the execution is started.
', 'DescribeExecutionOutput$stopDate' => 'If the execution ended, the date the execution stopped.
', 'DescribeMapRunOutput$startDate' => 'The date when the Map Run was started.
', 'DescribeMapRunOutput$stopDate' => 'The date when the Map Run was stopped.
', 'DescribeStateMachineAliasOutput$creationDate' => 'The date the state machine alias was created.
', 'DescribeStateMachineAliasOutput$updateDate' => 'The date the state machine alias was last updated.
For a newly created state machine, this is the same as the creation date.
', 'DescribeStateMachineForExecutionOutput$updateDate' => 'The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
', 'DescribeStateMachineOutput$creationDate' => 'The date the state machine is created.
For a state machine version, creationDate
is the date the version was created.
The date the execution started.
', 'ExecutionListItem$stopDate' => 'If the execution already ended, the date the execution stopped.
', 'HistoryEvent$timestamp' => 'The date and time the event occurred.
', 'MapRunListItem$startDate' => 'The date on which the Map Run started.
', 'MapRunListItem$stopDate' => 'The date on which the Map Run stopped.
', 'PublishStateMachineVersionOutput$creationDate' => 'The date the version was created.
', 'StartExecutionOutput$startDate' => 'The date the execution is started.
', 'StartSyncExecutionOutput$startDate' => 'The date the execution is started.
', 'StartSyncExecutionOutput$stopDate' => 'If the execution has already ended, the date the execution stopped.
', 'StateMachineAliasListItem$creationDate' => 'The creation date of a state machine alias.
', 'StateMachineListItem$creationDate' => 'The date the state machine is created.
', 'StateMachineVersionListItem$creationDate' => 'The creation date of a state machine version.
', 'StopExecutionOutput$stopDate' => 'The date the execution is stopped.
', 'UpdateStateMachineAliasOutput$updateDate' => 'The date and time the state machine alias was updated.
', 'UpdateStateMachineOutput$updateDate' => 'The date and time the state machine was updated.
', ], ], 'ToleratedFailureCount' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$toleratedFailureCount' => 'The maximum number of failed child workflow executions before the Map Run fails.
', 'UpdateMapRunInput$toleratedFailureCount' => 'The maximum number of failed items before the Map Run fails.
', ], ], 'ToleratedFailurePercentage' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$toleratedFailurePercentage' => 'The maximum percentage of failed child workflow executions before the Map Run fails.
', 'UpdateMapRunInput$toleratedFailurePercentage' => 'The maximum percentage of failed items before the Map Run fails.
', ], ], 'TooManyTags' => [ 'base' => 'You\'ve exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
', 'refs' => [], ], 'TraceHeader' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionOutput$traceHeader' => 'The X-Ray trace header that was passed to the execution.
', 'StartExecutionInput$traceHeader' => 'Passes the X-Ray trace header. The trace header can also be passed in the request payload.
', 'StartSyncExecutionInput$traceHeader' => 'Passes the X-Ray trace header. The trace header can also be passed in the request payload.
', 'StartSyncExecutionOutput$traceHeader' => 'The X-Ray trace header that was passed to the execution.
', ], ], 'TracingConfiguration' => [ 'base' => 'Selects whether or not the state machine\'s X-Ray tracing is enabled. Default is false
Selects whether X-Ray tracing is enabled.
', 'DescribeStateMachineForExecutionOutput$tracingConfiguration' => 'Selects whether X-Ray tracing is enabled.
', 'DescribeStateMachineOutput$tracingConfiguration' => 'Selects whether X-Ray tracing is enabled.
', 'UpdateStateMachineInput$tracingConfiguration' => 'Selects whether X-Ray tracing is enabled.
', ], ], 'UnsignedInteger' => [ 'base' => NULL, 'refs' => [ 'ExecutionListItem$itemCount' => 'The total number of items processed in a child workflow execution. This field is returned only if mapRunArn
was specified in the ListExecutions
API action. If stateMachineArn
was specified in ListExecutions
, the itemCount
field isn\'t returned.
The index of the array belonging to the Map state iteration.
', 'MapStateStartedEventDetails$length' => 'The size of the array for Map state iterations.
', ], ], 'UnsignedLong' => [ 'base' => NULL, 'refs' => [ 'MapRunExecutionCounts$pending' => 'The total number of child workflow executions that were started by a Map Run, but haven\'t started executing yet.
', 'MapRunExecutionCounts$running' => 'The total number of child workflow executions that were started by a Map Run and are currently in-progress.
', 'MapRunExecutionCounts$succeeded' => 'The total number of child workflow executions that were started by a Map Run and have completed successfully.
', 'MapRunExecutionCounts$failed' => 'The total number of child workflow executions that were started by a Map Run, but have failed.
', 'MapRunExecutionCounts$timedOut' => 'The total number of child workflow executions that were started by a Map Run and have timed out.
', 'MapRunExecutionCounts$aborted' => 'The total number of child workflow executions that were started by a Map Run and were running, but were either stopped by the user or by Step Functions because the Map Run failed.
', 'MapRunExecutionCounts$total' => 'The total number of child workflow executions that were started by a Map Run.
', 'MapRunExecutionCounts$resultsWritten' => 'Returns the count of child workflow executions whose results were written by ResultWriter
. For more information, see ResultWriter in the Step Functions Developer Guide.
The total number of items to process in child workflow executions that haven\'t started running yet.
', 'MapRunItemCounts$running' => 'The total number of items being processed in child workflow executions that are currently in-progress.
', 'MapRunItemCounts$succeeded' => 'The total number of items processed in child workflow executions that have completed successfully.
', 'MapRunItemCounts$failed' => 'The total number of items processed in child workflow executions that have failed.
', 'MapRunItemCounts$timedOut' => 'The total number of items processed in child workflow executions that have timed out.
', 'MapRunItemCounts$aborted' => 'The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.
', 'MapRunItemCounts$total' => 'The total number of items processed in all the child workflow executions started by a Map Run.
', 'MapRunItemCounts$resultsWritten' => 'Returns the count of items whose results were written by ResultWriter
. For more information, see ResultWriter in the Step Functions Developer Guide.
The input does not satisfy the constraints specified by an Amazon Web Services service.
', 'refs' => [], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => 'The input does not satisfy the constraints specified by an Amazon Web Services service.
', ], ], 'VersionDescription' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$versionDescription' => 'Sets description about the state machine version. You can only set the description if the publish
parameter is set to true
. Otherwise, if you set versionDescription
, but publish
to false
, this API action throws ValidationException
.
The description of the state machine version.
', 'PublishStateMachineVersionInput$description' => 'An optional description of the state machine version.
', 'UpdateStateMachineInput$versionDescription' => 'An optional description of the state machine version to publish.
You can only specify the versionDescription
parameter if you\'ve set publish
to true
.
The percentage of traffic you want to route to the second state machine version. The sum of the weights in the routing configuration must be equal to 100.
', ], ], 'includedDetails' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEventsExecutionDataDetails$included' => 'Indicates whether input or output was included in the response. Always true
for API calls.
Indicates whether input or output was truncated in the response. Always false
for API calls.