String activityArn
The Amazon Resource Name (ARN) that identifies the activity.
String name
The name of the activity.
A name must not contain:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
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.
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.
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:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
String name
The name of the state machine. 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:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
String definition
The Amazon States Language definition of the state machine.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
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:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
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:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
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.
String output
The JSON output data of the execution.
This field is set only if the execution succeeds. If the execution fails, this field is null.
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.
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.
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:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
String status
The current status of the state machine.
String definition
The Amazon States Language definition of the state machine.
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.)
Date creationDate
The date the state machine is created.
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:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
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 output
The JSON data output by the execution.
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.
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 100. 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 a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
The configured maxResults
determines how many results can be returned in a single call.
List<E> events
The list of events that occurred in the execution.
String nextToken
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
The configured maxResults
determines how many results can be returned in a single call.
Date timestamp
The date 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 which failed during an execution.
ActivityScheduledEventDetails activityScheduledEventDetails
ActivityStartedEventDetails activityStartedEventDetails
ActivitySucceededEventDetails activitySucceededEventDetails
ActivityTimedOutEventDetails activityTimedOutEventDetails
ExecutionFailedEventDetails executionFailedEventDetails
ExecutionStartedEventDetails executionStartedEventDetails
ExecutionSucceededEventDetails executionSucceededEventDetails
ExecutionAbortedEventDetails executionAbortedEventDetails
ExecutionTimedOutEventDetails executionTimedOutEventDetails
LambdaFunctionFailedEventDetails lambdaFunctionFailedEventDetails
LambdaFunctionScheduleFailedEventDetails lambdaFunctionScheduleFailedEventDetails
LambdaFunctionScheduledEventDetails lambdaFunctionScheduledEventDetails
LambdaFunctionStartFailedEventDetails lambdaFunctionStartFailedEventDetails
Contains details about a lambda function which failed to start during an execution.
LambdaFunctionSucceededEventDetails lambdaFunctionSucceededEventDetails
Contains details about a lambda function which terminated successfully during an execution.
LambdaFunctionTimedOutEventDetails lambdaFunctionTimedOutEventDetails
StateEnteredEventDetails stateEnteredEventDetails
StateExitedEventDetails stateExitedEventDetails
String output
The JSON data output by the lambda function.
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 100. 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 a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
The configured maxResults
determines how many results can be returned in a single call.
List<E> activities
The list of activities.
String nextToken
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
The configured maxResults
determines how many results can be returned in a single call.
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 100. 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 a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
The configured maxResults
determines how many results can be returned in a single call.
List<E> executions
The list of matching executions.
String nextToken
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
The configured maxResults
determines how many results can be returned in a single call.
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 100. 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 a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
The configured maxResults
determines how many results can be returned in a single call.
List<E> stateMachines
String nextToken
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
The configured maxResults
determines how many results can be returned in a single call.
String taskToken
The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).
String error
An arbitrary error code that identifies the cause 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 the service when the tasks are assigned to a worker (see GetActivityTaskOutput$taskToken).
String taskToken
The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTaskOutput$taskToken).
String output
The JSON output of the task.
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 and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
An execution can't use the name of another execution for 90 days.
When you make multiple StartExecution
calls with the same name, the new execution doesn't run and
the following rules apply:
When the original execution is open and the execution input from the new call is different, the
ExecutionAlreadyExists
message is returned.
When the original execution is open and the execution input from the new call is identical, the
Success
message is returned.
When the original execution is closed, the ExecutionAlreadyExists
message is returned regardless of
input.
A name must not contain:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
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": "{}"
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:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
Date creationDate
The date the state machine is created.
Date stopDate
The date the execution is stopped.
Date updateDate
The date and time the state machine was updated.
Copyright © 2018. All rights reserved.