Class DescribeExecutionResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeExecutionResponse.Builder,
DescribeExecutionResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
cause()
The cause string if the state machine execution failed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
error()
The error string if the state machine execution failed.final String
The Amazon Resource Name (ARN) that identifies the execution.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
input()
The string that contains the JSON input data of the execution.Returns the value of the InputDetails property for this object.final String
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.final String
name()
The name of the execution.final String
output()
The JSON output data of the execution.Returns the value of the OutputDetails property for this object.final Integer
The number of times you've redriven an execution.final Instant
The date the execution was last redriven.final ExecutionRedriveStatus
Indicates whether or not an execution can be redriven at a given point in time.final String
Indicates whether or not an execution can be redriven at a given point in time.final String
WhenredriveStatus
isNOT_REDRIVABLE
,redriveStatusReason
specifies the reason why an execution cannot be redriven.static Class
<? extends DescribeExecutionResponse.Builder> final Instant
The date the execution is started.final String
The Amazon Resource Name (ARN) of the state machine alias associated with the execution.final String
The Amazon Resource Name (ARN) of the executed stated machine.final String
The Amazon Resource Name (ARN) of the state machine version associated with the execution.final ExecutionStatus
status()
The current status of the execution.final String
The current status of the execution.final Instant
stopDate()
If the execution ended, the date the execution stopped.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The X-Ray trace header that was passed to the execution.Methods inherited from class software.amazon.awssdk.services.sfn.model.SfnResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
executionArn
The Amazon Resource Name (ARN) that identifies the execution.
- Returns:
- The Amazon Resource Name (ARN) that identifies the execution.
-
stateMachineArn
The Amazon Resource Name (ARN) of the executed stated machine.
- Returns:
- The Amazon Resource Name (ARN) of the executed stated machine.
-
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 _.
- Returns:
- 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 _.
-
-
-
status
The current status of the execution.
If the service returns an enum value that is not available in the current SDK version,
status
will returnExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the execution.
- See Also:
-
statusAsString
The current status of the execution.
If the service returns an enum value that is not available in the current SDK version,
status
will returnExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the execution.
- See Also:
-
startDate
The date the execution is started.
- Returns:
- The date the execution is started.
-
stopDate
If the execution ended, the date the execution stopped.
- Returns:
- If the execution ended, the date the execution stopped.
-
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.
- Returns:
- The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
-
inputDetails
Returns the value of the InputDetails property for this object.- Returns:
- The value of the InputDetails property for this object.
-
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.
- Returns:
- The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as
bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
-
outputDetails
Returns the value of the OutputDetails property for this object.- Returns:
- The value of the OutputDetails property for this object.
-
traceHeader
The X-Ray trace header that was passed to the execution.
- Returns:
- The X-Ray trace header that was passed to the execution.
-
mapRunArn
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
- Returns:
- The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
-
error
The error string if the state machine execution failed.
- Returns:
- The error string if the state machine execution failed.
-
cause
The cause string if the state machine execution failed.
- Returns:
- The cause string if the state machine execution failed.
-
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.- Returns:
- 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.
-
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.- Returns:
- 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.
-
redriveCount
The number of times you've redriven an execution. If you have not yet redriven an execution, the
redriveCount
is 0. This count is only updated if you successfully redrive an execution.- Returns:
- The number of times you've redriven an execution. If you have not yet redriven an execution, the
redriveCount
is 0. This count is only updated if you successfully redrive an execution.
-
redriveDate
The date the execution was last redriven. If you have not yet redriven an execution, the
redriveDate
is null.The
redriveDate
is unavailable if you redrive a Map Run that starts child workflow executions of typeEXPRESS
.- Returns:
- The date the execution was last redriven. If you have not yet redriven an execution, the
redriveDate
is null.The
redriveDate
is unavailable if you redrive a Map Run that starts child workflow executions of typeEXPRESS
.
-
redriveStatus
Indicates whether or not an execution can be redriven at a given point in time.
-
For executions of type
STANDARD
,redriveStatus
isNOT_REDRIVABLE
if calling the RedriveExecution API action would return theExecutionNotRedrivable
error. -
For a Distributed Map that includes child workflows of type
STANDARD
,redriveStatus
indicates whether or not the Map Run can redrive child workflow executions. -
For a Distributed Map that includes child workflows of type
EXPRESS
,redriveStatus
indicates whether or not the Map Run can redrive child workflow executions.You can redrive failed or timed out
EXPRESS
workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.
If the service returns an enum value that is not available in the current SDK version,
redriveStatus
will returnExecutionRedriveStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromredriveStatusAsString()
.- Returns:
- Indicates whether or not an execution can be redriven at a given point in time.
-
For executions of type
STANDARD
,redriveStatus
isNOT_REDRIVABLE
if calling the RedriveExecution API action would return theExecutionNotRedrivable
error. -
For a Distributed Map that includes child workflows of type
STANDARD
,redriveStatus
indicates whether or not the Map Run can redrive child workflow executions. -
For a Distributed Map that includes child workflows of type
EXPRESS
,redriveStatus
indicates whether or not the Map Run can redrive child workflow executions.You can redrive failed or timed out
EXPRESS
workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.
-
- See Also:
-
-
redriveStatusAsString
Indicates whether or not an execution can be redriven at a given point in time.
-
For executions of type
STANDARD
,redriveStatus
isNOT_REDRIVABLE
if calling the RedriveExecution API action would return theExecutionNotRedrivable
error. -
For a Distributed Map that includes child workflows of type
STANDARD
,redriveStatus
indicates whether or not the Map Run can redrive child workflow executions. -
For a Distributed Map that includes child workflows of type
EXPRESS
,redriveStatus
indicates whether or not the Map Run can redrive child workflow executions.You can redrive failed or timed out
EXPRESS
workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.
If the service returns an enum value that is not available in the current SDK version,
redriveStatus
will returnExecutionRedriveStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromredriveStatusAsString()
.- Returns:
- Indicates whether or not an execution can be redriven at a given point in time.
-
For executions of type
STANDARD
,redriveStatus
isNOT_REDRIVABLE
if calling the RedriveExecution API action would return theExecutionNotRedrivable
error. -
For a Distributed Map that includes child workflows of type
STANDARD
,redriveStatus
indicates whether or not the Map Run can redrive child workflow executions. -
For a Distributed Map that includes child workflows of type
EXPRESS
,redriveStatus
indicates whether or not the Map Run can redrive child workflow executions.You can redrive failed or timed out
EXPRESS
workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.
-
- See Also:
-
-
redriveStatusReason
When
redriveStatus
isNOT_REDRIVABLE
,redriveStatusReason
specifies the reason why an execution cannot be redriven.-
For executions of type
STANDARD
, or for a Distributed Map that includes child workflows of typeSTANDARD
,redriveStatusReason
can include one of the following reasons:-
State machine is in DELETING status
. -
Execution is RUNNING and cannot be redriven
. -
Execution is SUCCEEDED and cannot be redriven
. -
Execution was started before the launch of RedriveExecution
. -
Execution history event limit exceeded
. -
Execution has exceeded the max execution time
. -
Execution redrivable period exceeded
.
-
-
For a Distributed Map that includes child workflows of type
EXPRESS
,redriveStatusReason
is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.
- Returns:
- When
redriveStatus
isNOT_REDRIVABLE
,redriveStatusReason
specifies the reason why an execution cannot be redriven.-
For executions of type
STANDARD
, or for a Distributed Map that includes child workflows of typeSTANDARD
,redriveStatusReason
can include one of the following reasons:-
State machine is in DELETING status
. -
Execution is RUNNING and cannot be redriven
. -
Execution is SUCCEEDED and cannot be redriven
. -
Execution was started before the launch of RedriveExecution
. -
Execution history event limit exceeded
. -
Execution has exceeded the max execution time
. -
Execution redrivable period exceeded
.
-
-
For a Distributed Map that includes child workflows of type
EXPRESS
,redriveStatusReason
is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeExecutionResponse.Builder,
DescribeExecutionResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-