aws_sdk_sfn/client/

describe_state_machine_for_execution.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeStateMachineForExecution`](crate::operation::describe_state_machine_for_execution::builders::DescribeStateMachineForExecutionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`execution_arn(impl Into<String>)`](crate::operation::describe_state_machine_for_execution::builders::DescribeStateMachineForExecutionFluentBuilder::execution_arn) / [`set_execution_arn(Option<String>)`](crate::operation::describe_state_machine_for_execution::builders::DescribeStateMachineForExecutionFluentBuilder::set_execution_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the execution you want state machine information for.</p><br>
    ///   - [`included_data(IncludedData)`](crate::operation::describe_state_machine_for_execution::builders::DescribeStateMachineForExecutionFluentBuilder::included_data) / [`set_included_data(Option<IncludedData>)`](crate::operation::describe_state_machine_for_execution::builders::DescribeStateMachineForExecutionFluentBuilder::set_included_data):<br>required: **false**<br><p>If your state machine definition is encrypted with a KMS key, callers must have <code>kms:Decrypt</code> permission to decrypt the definition. Alternatively, you can call the API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p><br>
    /// - On success, responds with [`DescribeStateMachineForExecutionOutput`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput) with field(s):
    ///   - [`state_machine_arn(String)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::state_machine_arn): <p>The Amazon Resource Name (ARN) of the state machine associated with the execution.</p>
    ///   - [`name(String)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::name): <p>The name of the state machine associated with the execution.</p>
    ///   - [`definition(String)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::definition): <p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>
    ///   - [`role_arn(String)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.</p>
    ///   - [`update_date(DateTime)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::update_date): <p>The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.</p>
    ///   - [`logging_configuration(Option<LoggingConfiguration>)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::logging_configuration): <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs options.</p>
    ///   - [`tracing_configuration(Option<TracingConfiguration>)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::tracing_configuration): <p>Selects whether X-Ray tracing is enabled.</p>
    ///   - [`map_run_arn(Option<String>)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::map_run_arn): <p>The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the <code>executionArn</code> is a child workflow execution that was started by a Distributed Map state.</p>
    ///   - [`label(Option<String>)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::label): <p>A user-defined or an auto-generated string that identifies a <code>Map</code> state. This field is returned only if the <code>executionArn</code> is a child workflow execution that was started by a Distributed Map state.</p>
    ///   - [`revision_id(Option<String>)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::revision_id): <p>The revision identifier for the state machine. The first revision ID when you create the state machine is null.</p> <p>Use the state machine <code>revisionId</code> parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as <code>definition</code> and <code>roleArn</code>.</p>
    ///   - [`encryption_configuration(Option<EncryptionConfiguration>)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::encryption_configuration): <p>Settings to configure server-side encryption.</p>
    ///   - [`variable_references(Option<HashMap::<String, Vec::<String>>>)`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionOutput::variable_references): <p>A map of <b>state name</b> to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.</p>
    /// - On failure, responds with [`SdkError<DescribeStateMachineForExecutionError>`](crate::operation::describe_state_machine_for_execution::DescribeStateMachineForExecutionError)
    pub fn describe_state_machine_for_execution(
        &self,
    ) -> crate::operation::describe_state_machine_for_execution::builders::DescribeStateMachineForExecutionFluentBuilder {
        crate::operation::describe_state_machine_for_execution::builders::DescribeStateMachineForExecutionFluentBuilder::new(self.handle.clone())
    }
}