aws_sdk_sfn/operation/describe_execution/
_describe_execution_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct DescribeExecutionInput {
6    /// <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
7    pub execution_arn: ::std::option::Option<::std::string::String>,
8    /// <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>
9    pub included_data: ::std::option::Option<crate::types::IncludedData>,
10}
11impl DescribeExecutionInput {
12    /// <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
13    pub fn execution_arn(&self) -> ::std::option::Option<&str> {
14        self.execution_arn.as_deref()
15    }
16    /// <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>
17    pub fn included_data(&self) -> ::std::option::Option<&crate::types::IncludedData> {
18        self.included_data.as_ref()
19    }
20}
21impl DescribeExecutionInput {
22    /// Creates a new builder-style object to manufacture [`DescribeExecutionInput`](crate::operation::describe_execution::DescribeExecutionInput).
23    pub fn builder() -> crate::operation::describe_execution::builders::DescribeExecutionInputBuilder {
24        crate::operation::describe_execution::builders::DescribeExecutionInputBuilder::default()
25    }
26}
27
28/// A builder for [`DescribeExecutionInput`](crate::operation::describe_execution::DescribeExecutionInput).
29#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
30#[non_exhaustive]
31pub struct DescribeExecutionInputBuilder {
32    pub(crate) execution_arn: ::std::option::Option<::std::string::String>,
33    pub(crate) included_data: ::std::option::Option<crate::types::IncludedData>,
34}
35impl DescribeExecutionInputBuilder {
36    /// <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
37    /// This field is required.
38    pub fn execution_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
39        self.execution_arn = ::std::option::Option::Some(input.into());
40        self
41    }
42    /// <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
43    pub fn set_execution_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
44        self.execution_arn = input;
45        self
46    }
47    /// <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
48    pub fn get_execution_arn(&self) -> &::std::option::Option<::std::string::String> {
49        &self.execution_arn
50    }
51    /// <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>
52    pub fn included_data(mut self, input: crate::types::IncludedData) -> Self {
53        self.included_data = ::std::option::Option::Some(input);
54        self
55    }
56    /// <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>
57    pub fn set_included_data(mut self, input: ::std::option::Option<crate::types::IncludedData>) -> Self {
58        self.included_data = input;
59        self
60    }
61    /// <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>
62    pub fn get_included_data(&self) -> &::std::option::Option<crate::types::IncludedData> {
63        &self.included_data
64    }
65    /// Consumes the builder and constructs a [`DescribeExecutionInput`](crate::operation::describe_execution::DescribeExecutionInput).
66    pub fn build(
67        self,
68    ) -> ::std::result::Result<crate::operation::describe_execution::DescribeExecutionInput, ::aws_smithy_types::error::operation::BuildError> {
69        ::std::result::Result::Ok(crate::operation::describe_execution::DescribeExecutionInput {
70            execution_arn: self.execution_arn,
71            included_data: self.included_data,
72        })
73    }
74}
aws_sdk_sfn/operation/describe_execution/_describe_execution_input.rs

aws_sdk_sfn/operation/describe_execution/
_describe_execution_input.rs
