aws_sdk_sfn/client/
describe_activity.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeActivity`](crate::operation::describe_activity::builders::DescribeActivityFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`activity_arn(impl Into<String>)`](crate::operation::describe_activity::builders::DescribeActivityFluentBuilder::activity_arn) / [`set_activity_arn(Option<String>)`](crate::operation::describe_activity::builders::DescribeActivityFluentBuilder::set_activity_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the activity to describe.</p><br>
7    /// - On success, responds with [`DescribeActivityOutput`](crate::operation::describe_activity::DescribeActivityOutput) with field(s):
8    ///   - [`activity_arn(String)`](crate::operation::describe_activity::DescribeActivityOutput::activity_arn): <p>The Amazon Resource Name (ARN) that identifies the activity.</p>
9    ///   - [`name(String)`](crate::operation::describe_activity::DescribeActivityOutput::name): <p>The name of the activity.</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>
10    ///   - [`creation_date(DateTime)`](crate::operation::describe_activity::DescribeActivityOutput::creation_date): <p>The date the activity is created.</p>
11    ///   - [`encryption_configuration(Option<EncryptionConfiguration>)`](crate::operation::describe_activity::DescribeActivityOutput::encryption_configuration): <p>Settings for configured server-side encryption.</p>
12    /// - On failure, responds with [`SdkError<DescribeActivityError>`](crate::operation::describe_activity::DescribeActivityError)
13    pub fn describe_activity(&self) -> crate::operation::describe_activity::builders::DescribeActivityFluentBuilder {
14        crate::operation::describe_activity::builders::DescribeActivityFluentBuilder::new(self.handle.clone())
15    }
16}