#[non_exhaustive]pub struct DescribeExecutionOutput {Show 20 fields
pub execution_arn: String,
pub state_machine_arn: String,
pub name: Option<String>,
pub status: ExecutionStatus,
pub start_date: DateTime,
pub stop_date: Option<DateTime>,
pub input: Option<String>,
pub input_details: Option<CloudWatchEventsExecutionDataDetails>,
pub output: Option<String>,
pub output_details: Option<CloudWatchEventsExecutionDataDetails>,
pub trace_header: Option<String>,
pub map_run_arn: Option<String>,
pub error: Option<String>,
pub cause: Option<String>,
pub state_machine_version_arn: Option<String>,
pub state_machine_alias_arn: Option<String>,
pub redrive_count: Option<i32>,
pub redrive_date: Option<DateTime>,
pub redrive_status: Option<ExecutionRedriveStatus>,
pub redrive_status_reason: Option<String>,
/* private fields */
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.execution_arn: String
The Amazon Resource Name (ARN) that identifies the execution.
state_machine_arn: String
The Amazon Resource Name (ARN) of the executed stated machine.
name: Option<String>
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: ExecutionStatus
The current status of the execution.
start_date: DateTime
The date the execution is started.
stop_date: Option<DateTime>
If the execution ended, the date the execution stopped.
input: Option<String>
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_details: Option<CloudWatchEventsExecutionDataDetails>
Provides details about execution input or output.
output: Option<String>
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_details: Option<CloudWatchEventsExecutionDataDetails>
Provides details about execution input or output.
trace_header: Option<String>
The X-Ray trace header that was passed to the execution.
map_run_arn: Option<String>
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
error: Option<String>
The error string if the state machine execution failed.
cause: Option<String>
The cause string if the state machine execution failed.
state_machine_version_arn: Option<String>
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.
state_machine_alias_arn: Option<String>
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.
redrive_count: Option<i32>
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.
redrive_date: Option<DateTime>
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
.
redrive_status: Option<ExecutionRedriveStatus>
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 theRedriveExecution
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 theStartExecution
API action.
redrive_status_reason: Option<String>
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 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.
Implementations§
source§impl DescribeExecutionOutput
impl DescribeExecutionOutput
sourcepub fn execution_arn(&self) -> &str
pub fn execution_arn(&self) -> &str
The Amazon Resource Name (ARN) that identifies the execution.
sourcepub fn state_machine_arn(&self) -> &str
pub fn state_machine_arn(&self) -> &str
The Amazon Resource Name (ARN) of the executed stated machine.
sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
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 _.
sourcepub fn status(&self) -> &ExecutionStatus
pub fn status(&self) -> &ExecutionStatus
The current status of the execution.
sourcepub fn start_date(&self) -> &DateTime
pub fn start_date(&self) -> &DateTime
The date the execution is started.
sourcepub fn stop_date(&self) -> Option<&DateTime>
pub fn stop_date(&self) -> Option<&DateTime>
If the execution ended, the date the execution stopped.
sourcepub fn input(&self) -> Option<&str>
pub fn input(&self) -> Option<&str>
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.
sourcepub fn input_details(&self) -> Option<&CloudWatchEventsExecutionDataDetails>
pub fn input_details(&self) -> Option<&CloudWatchEventsExecutionDataDetails>
Provides details about execution input or output.
sourcepub fn output(&self) -> Option<&str>
pub fn output(&self) -> Option<&str>
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.
sourcepub fn output_details(&self) -> Option<&CloudWatchEventsExecutionDataDetails>
pub fn output_details(&self) -> Option<&CloudWatchEventsExecutionDataDetails>
Provides details about execution input or output.
sourcepub fn trace_header(&self) -> Option<&str>
pub fn trace_header(&self) -> Option<&str>
The X-Ray trace header that was passed to the execution.
sourcepub fn map_run_arn(&self) -> Option<&str>
pub fn map_run_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
sourcepub fn state_machine_version_arn(&self) -> Option<&str>
pub fn state_machine_version_arn(&self) -> Option<&str>
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.
sourcepub fn state_machine_alias_arn(&self) -> Option<&str>
pub fn state_machine_alias_arn(&self) -> Option<&str>
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.
sourcepub fn redrive_count(&self) -> Option<i32>
pub fn redrive_count(&self) -> Option<i32>
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.
sourcepub fn redrive_date(&self) -> Option<&DateTime>
pub fn redrive_date(&self) -> Option<&DateTime>
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
.
sourcepub fn redrive_status(&self) -> Option<&ExecutionRedriveStatus>
pub fn redrive_status(&self) -> Option<&ExecutionRedriveStatus>
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 theRedriveExecution
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 theStartExecution
API action.
sourcepub fn redrive_status_reason(&self) -> Option<&str>
pub fn redrive_status_reason(&self) -> Option<&str>
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 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.
source§impl DescribeExecutionOutput
impl DescribeExecutionOutput
sourcepub fn builder() -> DescribeExecutionOutputBuilder
pub fn builder() -> DescribeExecutionOutputBuilder
Creates a new builder-style object to manufacture DescribeExecutionOutput
.
Trait Implementations§
source§impl Clone for DescribeExecutionOutput
impl Clone for DescribeExecutionOutput
source§fn clone(&self) -> DescribeExecutionOutput
fn clone(&self) -> DescribeExecutionOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DescribeExecutionOutput
impl Debug for DescribeExecutionOutput
source§impl PartialEq for DescribeExecutionOutput
impl PartialEq for DescribeExecutionOutput
source§fn eq(&self, other: &DescribeExecutionOutput) -> bool
fn eq(&self, other: &DescribeExecutionOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for DescribeExecutionOutput
impl RequestId for DescribeExecutionOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for DescribeExecutionOutput
Auto Trait Implementations§
impl Freeze for DescribeExecutionOutput
impl RefUnwindSafe for DescribeExecutionOutput
impl Send for DescribeExecutionOutput
impl Sync for DescribeExecutionOutput
impl Unpin for DescribeExecutionOutput
impl UnwindSafe for DescribeExecutionOutput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more