String activityArn
The Amazon Resource Name (ARN) that identifies the activity.
String 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 _.
Date creationDate
The date the activity is created.
String resource
The Amazon Resource Name (ARN) of the scheduled activity.
String 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.
HistoryEventExecutionDataDetails inputDetails
Contains details about the input for an execution history event.
Long timeoutInSeconds
The maximum allowed duration of the activity task.
Long heartbeatInSeconds
The maximum allowed duration between two heartbeats for the activity task.
String workerName
The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.
String 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.
HistoryEventExecutionDataDetails outputDetails
Contains details about the output of an execution history event.
Boolean included
Indicates whether input or output was included in the response. Always true
for API calls.
String logGroupArn
The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with
:*
String 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 _.
List<E> 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: _ . : / = + - @
.
String description
A description for the state machine alias.
String 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.
List<E> 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
.
String 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 _.
String definition
The Amazon States Language definition of the state machine. See Amazon States Language.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
String 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.
LoggingConfiguration loggingConfiguration
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.
List<E> tags
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: _ . : / = + - @
.
TracingConfiguration tracingConfiguration
Selects whether X-Ray tracing is enabled.
Boolean publish
Set to true
to publish the first version of the state machine during creation. The default is
false
.
String 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
.
String stateMachineArn
The Amazon Resource Name (ARN) that identifies the created state machine.
Date creationDate
The date the state machine is created.
String 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.
String activityArn
The Amazon Resource Name (ARN) of the activity to delete.
String stateMachineAliasArn
The Amazon Resource Name (ARN) of the state machine alias to delete.
String stateMachineArn
The Amazon Resource Name (ARN) of the state machine to delete.
String stateMachineVersionArn
The Amazon Resource Name (ARN) of the state machine version to delete.
String activityArn
The Amazon Resource Name (ARN) of the activity to describe.
String activityArn
The Amazon Resource Name (ARN) that identifies the activity.
String 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 _.
Date creationDate
The date the activity is created.
String executionArn
The Amazon Resource Name (ARN) of the execution to describe.
String executionArn
The Amazon Resource Name (ARN) that identifies the execution.
String stateMachineArn
The Amazon Resource Name (ARN) of the executed stated machine.
String 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 _.
String status
The current status of the execution.
Date startDate
The date the execution is started.
Date stopDate
If the execution ended, the date the execution stopped.
String 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.
CloudWatchEventsExecutionDataDetails inputDetails
String 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.
CloudWatchEventsExecutionDataDetails outputDetails
String traceHeader
The X-Ray trace header that was passed to the execution.
String mapRunArn
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
String error
The error string if the state machine execution failed.
String cause
The cause string if the state machine execution failed.
String 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.
String stateMachineAliasArn
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.
String mapRunArn
The Amazon Resource Name (ARN) that identifies a Map Run.
String mapRunArn
The Amazon Resource Name (ARN) that identifies a Map Run.
String executionArn
The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.
String status
The current status of the Map Run.
Date startDate
The date when the Map Run was started.
Date stopDate
The date when the Map Run was stopped.
Integer maxConcurrency
The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.
Float toleratedFailurePercentage
The maximum percentage of failed child workflow executions before the Map Run fails.
Long toleratedFailureCount
The maximum number of failed child workflow executions before the Map Run fails.
MapRunItemCounts 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
.
MapRunExecutionCounts 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
.
String stateMachineAliasArn
The Amazon Resource Name (ARN) of the state machine alias.
String stateMachineAliasArn
The Amazon Resource Name (ARN) of the state machine alias.
String name
The name of the state machine alias.
String description
A description of the alias.
List<E> routingConfiguration
The routing configuration of the alias.
Date creationDate
The date the state machine alias was created.
Date updateDate
The date the state machine alias was last updated.
For a newly created state machine, this is the same as the creation date.
String executionArn
The Amazon Resource Name (ARN) of the execution you want state machine information for.
String stateMachineArn
The Amazon Resource Name (ARN) of the state machine associated with the execution.
String name
The name of the state machine associated with the execution.
String definition
The Amazon States Language definition of the state machine. See Amazon States Language.
String roleArn
The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
Date 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.
LoggingConfiguration loggingConfiguration
TracingConfiguration tracingConfiguration
Selects whether X-Ray tracing is enabled.
String 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.
String label
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.
String revisionId
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
.
String 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
.
String stateMachineArn
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
.
String 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 _.
String status
The current status of the state machine.
String definition
The Amazon States Language definition of the state machine. See Amazon States Language.
String roleArn
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.)
String type
The type
of the state machine (STANDARD
or EXPRESS
).
Date creationDate
The date the state machine is created.
For a state machine version, creationDate
is the date the version was created.
LoggingConfiguration loggingConfiguration
TracingConfiguration tracingConfiguration
Selects whether X-Ray tracing is enabled.
String label
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.
String revisionId
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
.
String description
The description of the state machine version.
String executionArn
The Amazon Resource Name (ARN) that identifies the execution.
String stateMachineArn
The Amazon Resource Name (ARN) of the state machine that ran the execution.
String 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 _.
String status
The current status of the execution.
Date startDate
The date the execution started.
Date stopDate
If the execution already ended, the date the execution stopped.
String mapRunArn
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.
Integer 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.
String 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.
String stateMachineAliasArn
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.
String input
The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
HistoryEventExecutionDataDetails inputDetails
Contains details about the input for an execution history event.
String roleArn
The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.
String stateMachineAliasArn
The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.
String stateMachineVersionArn
The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.
String output
The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
HistoryEventExecutionDataDetails outputDetails
Contains details about the output of an execution history event.
String activityArn
The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)
String 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.
String 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.
String 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.
String executionArn
The Amazon Resource Name (ARN) of the execution.
Integer 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.
Boolean reverseOrder
Lists events in descending order of their timeStamp
.
String 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.
Boolean includeExecutionData
You can select whether execution data (input or output of a history event) is returned. The default is
true
.
List<E> events
The list of events that occurred in the execution.
String 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.
Date timestamp
The date and time the event occurred.
String type
The type of the event.
Long id
The id of the event. Events are numbered sequentially, starting at one.
Long previousEventId
The id of the previous event.
ActivityFailedEventDetails activityFailedEventDetails
ActivityScheduleFailedEventDetails activityScheduleFailedEventDetails
Contains details about an activity schedule event that failed during an execution.
ActivityScheduledEventDetails activityScheduledEventDetails
ActivityStartedEventDetails activityStartedEventDetails
ActivitySucceededEventDetails activitySucceededEventDetails
ActivityTimedOutEventDetails activityTimedOutEventDetails
TaskFailedEventDetails taskFailedEventDetails
Contains details about the failure of a task.
TaskScheduledEventDetails taskScheduledEventDetails
Contains details about a task that was scheduled.
TaskStartFailedEventDetails taskStartFailedEventDetails
Contains details about a task that failed to start.
TaskStartedEventDetails taskStartedEventDetails
Contains details about a task that was started.
TaskSubmitFailedEventDetails taskSubmitFailedEventDetails
Contains details about a task that where the submit failed.
TaskSubmittedEventDetails taskSubmittedEventDetails
Contains details about a submitted task.
TaskSucceededEventDetails taskSucceededEventDetails
Contains details about a task that succeeded.
TaskTimedOutEventDetails taskTimedOutEventDetails
Contains details about a task that timed out.
ExecutionFailedEventDetails executionFailedEventDetails
ExecutionStartedEventDetails executionStartedEventDetails
ExecutionSucceededEventDetails executionSucceededEventDetails
ExecutionAbortedEventDetails executionAbortedEventDetails
ExecutionTimedOutEventDetails executionTimedOutEventDetails
MapStateStartedEventDetails mapStateStartedEventDetails
Contains details about Map state that was started.
MapIterationEventDetails mapIterationStartedEventDetails
Contains details about an iteration of a Map state that was started.
MapIterationEventDetails mapIterationSucceededEventDetails
Contains details about an iteration of a Map state that succeeded.
MapIterationEventDetails mapIterationFailedEventDetails
Contains details about an iteration of a Map state that failed.
MapIterationEventDetails mapIterationAbortedEventDetails
Contains details about an iteration of a Map state that was aborted.
LambdaFunctionFailedEventDetails lambdaFunctionFailedEventDetails
LambdaFunctionScheduleFailedEventDetails lambdaFunctionScheduleFailedEventDetails
LambdaFunctionScheduledEventDetails lambdaFunctionScheduledEventDetails
LambdaFunctionStartFailedEventDetails lambdaFunctionStartFailedEventDetails
Contains details about a lambda function that failed to start during an execution.
LambdaFunctionSucceededEventDetails lambdaFunctionSucceededEventDetails
Contains details about a Lambda function that terminated successfully during an execution.
LambdaFunctionTimedOutEventDetails lambdaFunctionTimedOutEventDetails
StateEnteredEventDetails stateEnteredEventDetails
StateExitedEventDetails stateExitedEventDetails
MapRunStartedEventDetails 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.
MapRunFailedEventDetails mapRunFailedEventDetails
Contains error and cause details about a Map Run that failed.
Boolean truncated
Indicates whether input or output was truncated in the response. Always false
for API calls.
String resource
The Amazon Resource Name (ARN) of the scheduled Lambda function.
String 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.
HistoryEventExecutionDataDetails inputDetails
Contains details about input for an execution history event.
Long timeoutInSeconds
The maximum allowed duration of the Lambda function.
TaskCredentials taskCredentials
The credentials that Step Functions uses for the task.
String 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.
HistoryEventExecutionDataDetails outputDetails
Contains details about the output of an execution history event.
Integer 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.
String 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.
List<E> activities
The list of activities.
String 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.
String 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.
String statusFilter
If specified, only list the executions whose current execution status matches the given filter.
Integer 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.
String 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.
String mapRunArn
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.
List<E> executions
The list of matching executions.
String 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.
String executionArn
The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.
Integer 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.
String 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.
List<E> mapRuns
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.
String 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.
String 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.
String 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.
Integer 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.
List<E> stateMachineAliases
Aliases for the state machine.
String 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.
Integer 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.
String 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.
List<E> stateMachines
String 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.
String stateMachineArn
The Amazon Resource Name (ARN) of the state machine.
String 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.
Integer 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.
List<E> stateMachineVersions
Versions for the state machine.
String 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.
String resourceArn
The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
CloudWatchLogsLogGroup cloudWatchLogsLogGroup
An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.
String level
Defines which category of execution history events are logged.
Boolean includeExecutionData
Determines whether execution data is included in your log. When set to false
, data is excluded.
List<E> destinations
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
.
Long pending
The total number of child workflow executions that were started by a Map Run, but haven't started executing yet.
Long running
The total number of child workflow executions that were started by a Map Run and are currently in-progress.
Long succeeded
The total number of child workflow executions that were started by a Map Run and have completed successfully.
Long failed
The total number of child workflow executions that were started by a Map Run, but have failed.
Long timedOut
The total number of child workflow executions that were started by a Map Run and have timed out.
Long 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.
Long total
The total number of child workflow executions that were started by a Map Run.
Long 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.
Long pending
The total number of items to process in child workflow executions that haven't started running yet.
Long running
The total number of items being processed in child workflow executions that are currently in-progress.
Long succeeded
The total number of items processed in child workflow executions that have completed successfully.
Long failed
The total number of items processed in child workflow executions that have failed.
Long timedOut
The total number of items processed in child workflow executions that have timed out.
Long 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.
Long total
The total number of items processed in all the child workflow executions started by a Map Run.
Long resultsWritten
Returns the count of items whose results were written by ResultWriter
. For more information, see ResultWriter in
the Step Functions Developer Guide.
String executionArn
The executionArn
of the execution from which the Map Run was started.
String mapRunArn
The Amazon Resource Name (ARN) of the Map Run.
String stateMachineArn
The Amazon Resource Name (ARN) of the executed state machine.
Date startDate
The date on which the Map Run started.
Date stopDate
The date on which the Map Run stopped.
String mapRunArn
The Amazon Resource Name (ARN) of a Map Run that was started.
Integer length
The size of the array for Map state iterations.
String stateMachineArn
The Amazon Resource Name (ARN) of the state machine.
String revisionId
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.
String description
An optional description of the state machine version.
String resourceName
String 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.
Integer weight
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.
String 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.
String error
The error code of the failure.
String cause
A more detailed explanation of the cause of the failure.
String 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.
String 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.
String output
The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
String 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.
String 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 _.
String 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.
String traceHeader
Passes the X-Ray trace header. The trace header can also be passed in the request payload.
String stateMachineArn
The Amazon Resource Name (ARN) of the state machine to execute.
String name
The name of the execution.
String 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.
String traceHeader
Passes the X-Ray trace header. The trace header can also be passed in the request payload.
String executionArn
The Amazon Resource Name (ARN) that identifies the execution.
String stateMachineArn
The Amazon Resource Name (ARN) that identifies the state machine.
String name
The name of the execution.
Date startDate
The date the execution is started.
Date stopDate
If the execution has already ended, the date the execution stopped.
String status
The current status of the execution.
String error
The error code of the failure.
String cause
A more detailed explanation of the cause of the failure.
String 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.
CloudWatchEventsExecutionDataDetails inputDetails
String 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.
CloudWatchEventsExecutionDataDetails outputDetails
String traceHeader
The X-Ray trace header that was passed to the execution.
BillingDetails billingDetails
An object that describes workflow billing details, including billed duration and memory use.
String name
The name of the state.
String input
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.
HistoryEventExecutionDataDetails inputDetails
Contains details about the input for an execution history event.
String 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 _.
String output
The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
HistoryEventExecutionDataDetails outputDetails
Contains details about the output of an execution history event.
String 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
.
Date creationDate
The creation date of a state machine alias.
String stateMachineArn
The Amazon Resource Name (ARN) that identifies the state machine.
String 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 _.
String type
Date creationDate
The date the state machine is created.
String stateMachineVersionArn
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
.
Date creationDate
The creation date of a state machine version.
Date stopDate
The date the execution is stopped.
String roleArn
The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.
String resourceType
The service name of the resource in a task state.
String resource
The action of the resource called by a task state.
String region
The region of the scheduled task
String 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.
Long timeoutInSeconds
The maximum allowed duration of the task.
Long heartbeatInSeconds
The maximum allowed duration between two heartbeats for the task.
TaskCredentials taskCredentials
The credentials that Step Functions uses for the task.
String resourceType
The service name of the resource in a task state.
String resource
The action of the resource called by a task state.
String 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.
HistoryEventExecutionDataDetails outputDetails
Contains details about the output of an execution history event.
String resourceType
The service name of the resource in a task state.
String resource
The action of the resource called by a task state.
String 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.
HistoryEventExecutionDataDetails outputDetails
Contains details about the output of an execution history event.
String resourceName
Boolean enabled
When set to true
, X-Ray tracing is enabled.
String mapRunArn
The Amazon Resource Name (ARN) of a Map Run.
Integer maxConcurrency
The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.
Float toleratedFailurePercentage
The maximum percentage of failed items before the Map Run fails.
Long toleratedFailureCount
The maximum number of failed items before the Map Run fails.
String stateMachineAliasArn
The Amazon Resource Name (ARN) of the state machine alias.
String description
A description of the state machine alias.
List<E> 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.
Date updateDate
The date and time the state machine alias was updated.
String stateMachineArn
The Amazon Resource Name (ARN) of the state machine.
String definition
The Amazon States Language definition of the state machine. See Amazon States Language.
String roleArn
The Amazon Resource Name (ARN) of the IAM role of the state machine.
LoggingConfiguration loggingConfiguration
Use the LoggingConfiguration
data type to set CloudWatch Logs options.
TracingConfiguration tracingConfiguration
Selects whether X-Ray tracing is enabled.
Boolean publish
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
.
String 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
.
Date updateDate
The date and time the state machine was updated.
String revisionId
The revision identifier for the updated state machine.
String 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.
String reason
The input does not satisfy the constraints specified by an Amazon Web Services service.
Copyright © 2023. All rights reserved.