aws_sdk_sfn/operation/describe_execution/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_execution::_describe_execution_output::DescribeExecutionOutputBuilder;
3
4pub use crate::operation::describe_execution::_describe_execution_input::DescribeExecutionInputBuilder;
5
6impl crate::operation::describe_execution::builders::DescribeExecutionInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::describe_execution::DescribeExecutionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_execution::DescribeExecutionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_execution();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeExecution`.
24///
25/// <p>Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html">redriven</a> an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.</p>
26/// <p>If you specify a version or alias ARN when you call the <code>StartExecution</code> API action, <code>DescribeExecution</code> returns that ARN.</p><note>
27/// <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
28/// </note>
29/// <p>Executions of an <code>EXPRESS</code> state machine aren't supported by <code>DescribeExecution</code> unless a Map Run dispatched them.</p>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct DescribeExecutionFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::describe_execution::builders::DescribeExecutionInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::describe_execution::DescribeExecutionOutput,
39        crate::operation::describe_execution::DescribeExecutionError,
40    > for DescribeExecutionFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::describe_execution::DescribeExecutionOutput,
48            crate::operation::describe_execution::DescribeExecutionError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl DescribeExecutionFluentBuilder {
55    /// Creates a new `DescribeExecutionFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the DescribeExecution as a reference.
64    pub fn as_input(&self) -> &crate::operation::describe_execution::builders::DescribeExecutionInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::describe_execution::DescribeExecutionOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::describe_execution::DescribeExecutionError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::describe_execution::DescribeExecution::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::describe_execution::DescribeExecution::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::describe_execution::DescribeExecutionOutput,
101        crate::operation::describe_execution::DescribeExecutionError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
116    pub fn execution_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.execution_arn(input.into());
118        self
119    }
120    /// <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
121    pub fn set_execution_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_execution_arn(input);
123        self
124    }
125    /// <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
126    pub fn get_execution_arn(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_execution_arn()
128    }
129    /// <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 DescribeStateMachine API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>
130    pub fn included_data(mut self, input: crate::types::IncludedData) -> Self {
131        self.inner = self.inner.included_data(input);
132        self
133    }
134    /// <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 DescribeStateMachine API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>
135    pub fn set_included_data(mut self, input: ::std::option::Option<crate::types::IncludedData>) -> Self {
136        self.inner = self.inner.set_included_data(input);
137        self
138    }
139    /// <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 DescribeStateMachine API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>
140    pub fn get_included_data(&self) -> &::std::option::Option<crate::types::IncludedData> {
141        self.inner.get_included_data()
142    }
143}
aws_sdk_sfn/operation/describe_execution/builders.rs

aws_sdk_sfn/operation/describe_execution/
builders.rs
