@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeExecutionResult() |
Modifier and Type | Method and Description |
---|---|
DescribeExecutionResult |
clone() |
boolean |
equals(Object obj) |
String |
getCause()
The cause string if the state machine execution failed.
|
String |
getError()
The error string if the state machine execution failed.
|
String |
getExecutionArn()
The Amazon Resource Name (ARN) that identifies the execution.
|
String |
getInput()
The string that contains the JSON input data of the execution.
|
CloudWatchEventsExecutionDataDetails |
getInputDetails() |
String |
getMapRunArn()
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
|
String |
getName()
The name of the execution.
|
String |
getOutput()
The JSON output data of the execution.
|
CloudWatchEventsExecutionDataDetails |
getOutputDetails() |
Integer |
getRedriveCount()
The number of times you've redriven an execution.
|
Date |
getRedriveDate()
The date the execution was last redriven.
|
String |
getRedriveStatus()
Indicates whether or not an execution can be redriven at a given point in time.
|
String |
getRedriveStatusReason()
When
redriveStatus is NOT_REDRIVABLE , redriveStatusReason specifies the
reason why an execution cannot be redriven. |
Date |
getStartDate()
The date the execution is started.
|
String |
getStateMachineAliasArn()
The Amazon Resource Name (ARN) of the state machine alias associated with the execution.
|
String |
getStateMachineArn()
The Amazon Resource Name (ARN) of the executed stated machine.
|
String |
getStateMachineVersionArn()
The Amazon Resource Name (ARN) of the state machine version associated with the execution.
|
String |
getStatus()
The current status of the execution.
|
Date |
getStopDate()
If the execution ended, the date the execution stopped.
|
String |
getTraceHeader()
The X-Ray trace header that was passed to the execution.
|
int |
hashCode() |
void |
setCause(String cause)
The cause string if the state machine execution failed.
|
void |
setError(String error)
The error string if the state machine execution failed.
|
void |
setExecutionArn(String executionArn)
The Amazon Resource Name (ARN) that identifies the execution.
|
void |
setInput(String input)
The string that contains the JSON input data of the execution.
|
void |
setInputDetails(CloudWatchEventsExecutionDataDetails inputDetails) |
void |
setMapRunArn(String mapRunArn)
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
|
void |
setName(String name)
The name of the execution.
|
void |
setOutput(String output)
The JSON output data of the execution.
|
void |
setOutputDetails(CloudWatchEventsExecutionDataDetails outputDetails) |
void |
setRedriveCount(Integer redriveCount)
The number of times you've redriven an execution.
|
void |
setRedriveDate(Date redriveDate)
The date the execution was last redriven.
|
void |
setRedriveStatus(ExecutionRedriveStatus redriveStatus)
Indicates whether or not an execution can be redriven at a given point in time.
|
void |
setRedriveStatus(String redriveStatus)
Indicates whether or not an execution can be redriven at a given point in time.
|
void |
setRedriveStatusReason(String redriveStatusReason)
When
redriveStatus is NOT_REDRIVABLE , redriveStatusReason specifies the
reason why an execution cannot be redriven. |
void |
setStartDate(Date startDate)
The date the execution is started.
|
void |
setStateMachineAliasArn(String stateMachineAliasArn)
The Amazon Resource Name (ARN) of the state machine alias associated with the execution.
|
void |
setStateMachineArn(String stateMachineArn)
The Amazon Resource Name (ARN) of the executed stated machine.
|
void |
setStateMachineVersionArn(String stateMachineVersionArn)
The Amazon Resource Name (ARN) of the state machine version associated with the execution.
|
void |
setStatus(ExecutionStatus status)
The current status of the execution.
|
void |
setStatus(String status)
The current status of the execution.
|
void |
setStopDate(Date stopDate)
If the execution ended, the date the execution stopped.
|
void |
setTraceHeader(String traceHeader)
The X-Ray trace header that was passed to the execution.
|
String |
toString()
Returns a string representation of this object.
|
DescribeExecutionResult |
withCause(String cause)
The cause string if the state machine execution failed.
|
DescribeExecutionResult |
withError(String error)
The error string if the state machine execution failed.
|
DescribeExecutionResult |
withExecutionArn(String executionArn)
The Amazon Resource Name (ARN) that identifies the execution.
|
DescribeExecutionResult |
withInput(String input)
The string that contains the JSON input data of the execution.
|
DescribeExecutionResult |
withInputDetails(CloudWatchEventsExecutionDataDetails inputDetails) |
DescribeExecutionResult |
withMapRunArn(String mapRunArn)
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
|
DescribeExecutionResult |
withName(String name)
The name of the execution.
|
DescribeExecutionResult |
withOutput(String output)
The JSON output data of the execution.
|
DescribeExecutionResult |
withOutputDetails(CloudWatchEventsExecutionDataDetails outputDetails) |
DescribeExecutionResult |
withRedriveCount(Integer redriveCount)
The number of times you've redriven an execution.
|
DescribeExecutionResult |
withRedriveDate(Date redriveDate)
The date the execution was last redriven.
|
DescribeExecutionResult |
withRedriveStatus(ExecutionRedriveStatus redriveStatus)
Indicates whether or not an execution can be redriven at a given point in time.
|
DescribeExecutionResult |
withRedriveStatus(String redriveStatus)
Indicates whether or not an execution can be redriven at a given point in time.
|
DescribeExecutionResult |
withRedriveStatusReason(String redriveStatusReason)
When
redriveStatus is NOT_REDRIVABLE , redriveStatusReason specifies the
reason why an execution cannot be redriven. |
DescribeExecutionResult |
withStartDate(Date startDate)
The date the execution is started.
|
DescribeExecutionResult |
withStateMachineAliasArn(String stateMachineAliasArn)
The Amazon Resource Name (ARN) of the state machine alias associated with the execution.
|
DescribeExecutionResult |
withStateMachineArn(String stateMachineArn)
The Amazon Resource Name (ARN) of the executed stated machine.
|
DescribeExecutionResult |
withStateMachineVersionArn(String stateMachineVersionArn)
The Amazon Resource Name (ARN) of the state machine version associated with the execution.
|
DescribeExecutionResult |
withStatus(ExecutionStatus status)
The current status of the execution.
|
DescribeExecutionResult |
withStatus(String status)
The current status of the execution.
|
DescribeExecutionResult |
withStopDate(Date stopDate)
If the execution ended, the date the execution stopped.
|
DescribeExecutionResult |
withTraceHeader(String traceHeader)
The X-Ray trace header that was passed to the execution.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setExecutionArn(String executionArn)
The Amazon Resource Name (ARN) that identifies the execution.
executionArn
- The Amazon Resource Name (ARN) that identifies the execution.public String getExecutionArn()
The Amazon Resource Name (ARN) that identifies the execution.
public DescribeExecutionResult withExecutionArn(String executionArn)
The Amazon Resource Name (ARN) that identifies the execution.
executionArn
- The Amazon Resource Name (ARN) that identifies the execution.public void setStateMachineArn(String stateMachineArn)
The Amazon Resource Name (ARN) of the executed stated machine.
stateMachineArn
- The Amazon Resource Name (ARN) of the executed stated machine.public String getStateMachineArn()
The Amazon Resource Name (ARN) of the executed stated machine.
public DescribeExecutionResult withStateMachineArn(String stateMachineArn)
The Amazon Resource Name (ARN) of the executed stated machine.
stateMachineArn
- The Amazon Resource Name (ARN) of the executed stated machine.public void setName(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 _.
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 _.
public String getName()
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 _.
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 _.
public DescribeExecutionResult withName(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 _.
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 _.
public void setStatus(String status)
The current status of the execution.
status
- The current status of the execution.ExecutionStatus
public String getStatus()
The current status of the execution.
ExecutionStatus
public DescribeExecutionResult withStatus(String status)
The current status of the execution.
status
- The current status of the execution.ExecutionStatus
public void setStatus(ExecutionStatus status)
The current status of the execution.
status
- The current status of the execution.ExecutionStatus
public DescribeExecutionResult withStatus(ExecutionStatus status)
The current status of the execution.
status
- The current status of the execution.ExecutionStatus
public void setStartDate(Date startDate)
The date the execution is started.
startDate
- The date the execution is started.public Date getStartDate()
The date the execution is started.
public DescribeExecutionResult withStartDate(Date startDate)
The date the execution is started.
startDate
- The date the execution is started.public void setStopDate(Date stopDate)
If the execution ended, the date the execution stopped.
stopDate
- If the execution ended, the date the execution stopped.public Date getStopDate()
If the execution ended, the date the execution stopped.
public DescribeExecutionResult withStopDate(Date stopDate)
If the execution ended, the date the execution stopped.
stopDate
- If the execution ended, the date the execution stopped.public void setInput(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.
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.public String getInput()
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.
public DescribeExecutionResult withInput(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.
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.public void setInputDetails(CloudWatchEventsExecutionDataDetails inputDetails)
inputDetails
- public CloudWatchEventsExecutionDataDetails getInputDetails()
public DescribeExecutionResult withInputDetails(CloudWatchEventsExecutionDataDetails inputDetails)
inputDetails
- public void setOutput(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.
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.
public String getOutput()
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.
This field is set only if the execution succeeds. If the execution fails, this field is null.
public DescribeExecutionResult withOutput(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.
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.
public void setOutputDetails(CloudWatchEventsExecutionDataDetails outputDetails)
outputDetails
- public CloudWatchEventsExecutionDataDetails getOutputDetails()
public DescribeExecutionResult withOutputDetails(CloudWatchEventsExecutionDataDetails outputDetails)
outputDetails
- public void setTraceHeader(String traceHeader)
The X-Ray trace header that was passed to the execution.
traceHeader
- The X-Ray trace header that was passed to the execution.public String getTraceHeader()
The X-Ray trace header that was passed to the execution.
public DescribeExecutionResult withTraceHeader(String traceHeader)
The X-Ray trace header that was passed to the execution.
traceHeader
- The X-Ray trace header that was passed to the execution.public void setMapRunArn(String mapRunArn)
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
mapRunArn
- The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.public String getMapRunArn()
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
public DescribeExecutionResult withMapRunArn(String mapRunArn)
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
mapRunArn
- The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.public void setError(String error)
The error string if the state machine execution failed.
error
- The error string if the state machine execution failed.public String getError()
The error string if the state machine execution failed.
public DescribeExecutionResult withError(String error)
The error string if the state machine execution failed.
error
- The error string if the state machine execution failed.public void setCause(String cause)
The cause string if the state machine execution failed.
cause
- The cause string if the state machine execution failed.public String getCause()
The cause string if the state machine execution failed.
public DescribeExecutionResult withCause(String cause)
The cause string if the state machine execution failed.
cause
- The cause string if the state machine execution failed.public void setStateMachineVersionArn(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.
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.
public String getStateMachineVersionArn()
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.
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.
public DescribeExecutionResult withStateMachineVersionArn(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.
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.
public void setStateMachineAliasArn(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.
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.
public String getStateMachineAliasArn()
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.
stateMachineARN:PROD
.
If you start an execution from a StartExecution
request with a state machine version ARN,
this field will be null.
public DescribeExecutionResult withStateMachineAliasArn(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.
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.
public void setRedriveCount(Integer 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 not updated for redrives that failed to start or are pending to be
redriven.
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 not updated for redrives that failed to start or are pending
to be redriven.public Integer getRedriveCount()
The number of times you've redriven an execution. If you have not yet redriven an execution, the
redriveCount
is 0. This count is not updated for redrives that failed to start or are pending to be
redriven.
redriveCount
is 0. This count is not updated for redrives that failed to start or are
pending to be redriven.public DescribeExecutionResult withRedriveCount(Integer 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 not updated for redrives that failed to start or are pending to be
redriven.
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 not updated for redrives that failed to start or are pending
to be redriven.public void setRedriveDate(Date 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
type EXPRESS
.
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 type EXPRESS
.
public Date getRedriveDate()
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
type EXPRESS
.
redriveDate
is null.
The redriveDate
is unavailable if you redrive a Map Run that starts child workflow
executions of type EXPRESS
.
public DescribeExecutionResult withRedriveDate(Date 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
type EXPRESS
.
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 type EXPRESS
.
public void setRedriveStatus(String redriveStatus)
Indicates whether or not an execution can be redriven at a given point in time.
For executions of type STANDARD
, redriveStatus
is NOT_REDRIVABLE
if
calling the RedriveExecution API action would return the ExecutionNotRedrivable
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.
redriveStatus
- Indicates whether or not an execution can be redriven at a given point in time.
For executions of type STANDARD
, redriveStatus
is NOT_REDRIVABLE
if
calling the RedriveExecution API action would return the ExecutionNotRedrivable
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.
ExecutionRedriveStatus
public String getRedriveStatus()
Indicates whether or not an execution can be redriven at a given point in time.
For executions of type STANDARD
, redriveStatus
is NOT_REDRIVABLE
if
calling the RedriveExecution API action would return the ExecutionNotRedrivable
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.
For executions of type STANDARD
, redriveStatus
is NOT_REDRIVABLE
if calling the RedriveExecution API action would return the ExecutionNotRedrivable
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.
ExecutionRedriveStatus
public DescribeExecutionResult withRedriveStatus(String redriveStatus)
Indicates whether or not an execution can be redriven at a given point in time.
For executions of type STANDARD
, redriveStatus
is NOT_REDRIVABLE
if
calling the RedriveExecution API action would return the ExecutionNotRedrivable
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.
redriveStatus
- Indicates whether or not an execution can be redriven at a given point in time.
For executions of type STANDARD
, redriveStatus
is NOT_REDRIVABLE
if
calling the RedriveExecution API action would return the ExecutionNotRedrivable
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.
ExecutionRedriveStatus
public void setRedriveStatus(ExecutionRedriveStatus redriveStatus)
Indicates whether or not an execution can be redriven at a given point in time.
For executions of type STANDARD
, redriveStatus
is NOT_REDRIVABLE
if
calling the RedriveExecution API action would return the ExecutionNotRedrivable
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.
redriveStatus
- Indicates whether or not an execution can be redriven at a given point in time.
For executions of type STANDARD
, redriveStatus
is NOT_REDRIVABLE
if
calling the RedriveExecution API action would return the ExecutionNotRedrivable
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.
ExecutionRedriveStatus
public DescribeExecutionResult withRedriveStatus(ExecutionRedriveStatus redriveStatus)
Indicates whether or not an execution can be redriven at a given point in time.
For executions of type STANDARD
, redriveStatus
is NOT_REDRIVABLE
if
calling the RedriveExecution API action would return the ExecutionNotRedrivable
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.
redriveStatus
- Indicates whether or not an execution can be redriven at a given point in time.
For executions of type STANDARD
, redriveStatus
is NOT_REDRIVABLE
if
calling the RedriveExecution API action would return the ExecutionNotRedrivable
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.
ExecutionRedriveStatus
public void setRedriveStatusReason(String redriveStatusReason)
When redriveStatus
is NOT_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 type
STANDARD
, 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.
redriveStatusReason
- When redriveStatus
is NOT_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
type STANDARD
, 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.
public String getRedriveStatusReason()
When redriveStatus
is NOT_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 type
STANDARD
, 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.
redriveStatus
is NOT_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
type STANDARD
, 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.
public DescribeExecutionResult withRedriveStatusReason(String redriveStatusReason)
When redriveStatus
is NOT_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 type
STANDARD
, 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.
redriveStatusReason
- When redriveStatus
is NOT_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
type STANDARD
, 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.
public String toString()
toString
in class Object
Object.toString()
public DescribeExecutionResult clone()
Copyright © 2023. All rights reserved.