Struct aws_sdk_sfn::operation::describe_execution::DescribeExecutionOutput

#[non_exhaustive]
pub struct DescribeExecutionOutput {

    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)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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 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.

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 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.

Implementations

impl DescribeExecutionOutput

pub fn execution_arn(&self) -> &str

The Amazon Resource Name (ARN) that identifies the execution.

pub fn state_machine_arn(&self) -> &str

The Amazon Resource Name (ARN) of the executed stated machine.

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 _.

pub fn status(&self) -> &ExecutionStatus

The current status of the execution.

pub fn start_date(&self) -> &DateTime

The date the execution is started.

pub fn stop_date(&self) -> Option<&DateTime>

If the execution ended, the date the execution stopped.

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.

pub fn input_details(&self) -> Option<&CloudWatchEventsExecutionDataDetails>

Provides details about execution input or output.

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.

pub fn output_details(&self) -> Option<&CloudWatchEventsExecutionDataDetails>

Provides details about execution input or output.

pub fn trace_header(&self) -> Option<&str>

The X-Ray trace header that was passed to the execution.

pub fn map_run_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

pub fn error(&self) -> Option<&str>

The error string if the state machine execution failed.

pub fn cause(&self) -> Option<&str>

The cause string if the state machine execution failed.

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.

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.

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.

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.

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 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.

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 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.

impl DescribeExecutionOutput

pub fn builder() -> DescribeExecutionOutputBuilder

Creates a new builder-style object to manufacture DescribeExecutionOutput.

Trait Implementations

impl Clone for DescribeExecutionOutput

fn clone(&self) -> DescribeExecutionOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeExecutionOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeExecutionOutput

fn eq(&self, other: &DescribeExecutionOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeExecutionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeExecutionOutput