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 AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
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 AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
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 AWS
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 AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
TracingConfiguration tracingConfiguration
Selects whether AWS X-Ray tracing is enabled.
String activityArn
The Amazon Resource Name (ARN) of the activity to delete.
String stateMachineArn
The Amazon Resource Name (ARN) of the state machine 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 has already 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 AWS X-Ray trace header that was passed to the execution.
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 AWS X-Ray tracing is enabled.
String stateMachineArn
The Amazon Resource Name (ARN) of the state machine to describe.
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 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 AWS resources.)
String type
The type
of the state machine (STANDARD
or EXPRESS
).
Date creationDate
The date the state machine is created.
LoggingConfiguration loggingConfiguration
TracingConfiguration tracingConfiguration
Selects whether AWS X-Ray tracing is enabled.
String executionArn
The Amazon Resource Name (ARN) that identifies the execution.
String stateMachineArn
The Amazon Resource Name (ARN) of the executed state 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 started.
Date stopDate
If the execution already ended, the date the execution stopped.
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 AWS Lambda tasks.
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
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.
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.
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.
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.
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 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 AWS 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
.
Integer length
The size of the array for Map state iterations.
String resourceName
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.
String name
The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
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 AWS 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 AWS 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 AWS 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 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.
Date stopDate
The date the execution is stopped.
String resourceType
The action of the resource called by a task state.
String resource
The service name of the resource in 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.
String resourceType
The action of the resource called by a task state.
String resource
The service name of the resource in 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 action of the resource called by a task state.
String resource
The service name of the resource in 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
, AWS X-Ray tracing is enabled.
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
The LoggingConfiguration
data type is used to set CloudWatch Logs options.
TracingConfiguration tracingConfiguration
Selects whether AWS X-Ray tracing is enabled.
Date updateDate
The date and time the state machine was updated.
Copyright © 2022. All rights reserved.