aws_sdk_sfn/client/

describe_state_machine.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeStateMachine`](crate::operation::describe_state_machine::builders::DescribeStateMachineFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`state_machine_arn(impl Into<String>)`](crate::operation::describe_state_machine::builders::DescribeStateMachineFluentBuilder::state_machine_arn) / [`set_state_machine_arn(Option<String>)`](crate::operation::describe_state_machine::builders::DescribeStateMachineFluentBuilder::set_state_machine_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the state machine for which you want the information.</p> <p>If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p><br>
    ///   - [`included_data(IncludedData)`](crate::operation::describe_state_machine::builders::DescribeStateMachineFluentBuilder::included_data) / [`set_included_data(Option<IncludedData>)`](crate::operation::describe_state_machine::builders::DescribeStateMachineFluentBuilder::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><note>  <p>When calling a labelled ARN for an encrypted state machine, the <code>includedData = METADATA_ONLY</code> parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have <code>kms:Decrypt</code> permission.</p> </note><br>
    /// - On success, responds with [`DescribeStateMachineOutput`](crate::operation::describe_state_machine::DescribeStateMachineOutput) with field(s):
    ///   - [`state_machine_arn(String)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::state_machine_arn): <p>The Amazon Resource Name (ARN) that identifies the state machine.</p> <p>If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p>
    ///   - [`name(String)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::name): <p>The name of the state machine.</p> <p>A name must <i>not</i> contain:</p> <ul>  <li>   <p>white space</p></li>  <li>   <p>brackets <code>&lt; &gt; { } \[ \]</code></p></li>  <li>   <p>wildcard characters <code>? *</code></p></li>  <li>   <p>special characters <code>" # % \ ^ | ~ ` $ &amp; , ; : /</code></p></li>  <li>   <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p></li>  <li>   <p>surrogates (<code>U+D800-DFFF</code>)</p></li>  <li>   <p>invalid characters (<code> U+10FFFF</code>)</p></li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
    ///   - [`status(Option<StateMachineStatus>)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::status): <p>The current status of the state machine.</p>
    ///   - [`definition(String)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::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> <p>If called with <code>includedData = METADATA_ONLY</code>, the returned definition will be <code>{}</code>.</p>
    ///   - [`role_arn(String)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)</p>
    ///   - [`r#type(StateMachineType)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::type): <p>The <code>type</code> of the state machine (<code>STANDARD</code> or <code>EXPRESS</code>).</p>
    ///   - [`creation_date(DateTime)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::creation_date): <p>The date the state machine is created.</p> <p>For a state machine version, <code>creationDate</code> is the date the version was created.</p>
    ///   - [`logging_configuration(Option<LoggingConfiguration>)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::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::DescribeStateMachineOutput::tracing_configuration): <p>Selects whether X-Ray tracing is enabled.</p>
    ///   - [`label(Option<String>)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::label): <p>A user-defined or an auto-generated string that identifies a <code>Map</code> state. This parameter is present only if the <code>stateMachineArn</code> specified in input is a qualified state machine ARN.</p>
    ///   - [`revision_id(Option<String>)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::revision_id): <p>The revision identifier for the state machine.</p> <p>Use the <code>revisionId</code> parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as <code>definition</code> and <code>roleArn</code>.</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::description): <p>The description of the state machine version.</p>
    ///   - [`encryption_configuration(Option<EncryptionConfiguration>)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::encryption_configuration): <p>Settings to configure server-side encryption.</p>
    ///   - [`variable_references(Option<HashMap::<String, Vec::<String>>>)`](crate::operation::describe_state_machine::DescribeStateMachineOutput::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<DescribeStateMachineError>`](crate::operation::describe_state_machine::DescribeStateMachineError)
    pub fn describe_state_machine(&self) -> crate::operation::describe_state_machine::builders::DescribeStateMachineFluentBuilder {
        crate::operation::describe_state_machine::builders::DescribeStateMachineFluentBuilder::new(self.handle.clone())
    }
}