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