aws_sdk_ssm/operation/get_parameter_history/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_parameter_history::_get_parameter_history_output::GetParameterHistoryOutputBuilder;
3
4pub use crate::operation::get_parameter_history::_get_parameter_history_input::GetParameterHistoryInputBuilder;
5
6impl crate::operation::get_parameter_history::builders::GetParameterHistoryInputBuilder {
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::get_parameter_history::GetParameterHistoryOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_parameter_history::GetParameterHistoryError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_parameter_history();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetParameterHistory`.
24///
25/// <p>Retrieves the history of all changes to a parameter.</p>
26/// <p>Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a <code>ValidationException</code> error.</p><important>
27/// <p>If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, <code>GetParameterHistory</code> retrieves whatever the original key alias was referencing.</p>
28/// </important>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct GetParameterHistoryFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::get_parameter_history::builders::GetParameterHistoryInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::get_parameter_history::GetParameterHistoryOutput,
38        crate::operation::get_parameter_history::GetParameterHistoryError,
39    > for GetParameterHistoryFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::get_parameter_history::GetParameterHistoryOutput,
47            crate::operation::get_parameter_history::GetParameterHistoryError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl GetParameterHistoryFluentBuilder {
54    /// Creates a new `GetParameterHistoryFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the GetParameterHistory as a reference.
63    pub fn as_input(&self) -> &crate::operation::get_parameter_history::builders::GetParameterHistoryInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::get_parameter_history::GetParameterHistoryOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::get_parameter_history::GetParameterHistoryError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::get_parameter_history::GetParameterHistory::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::get_parameter_history::GetParameterHistory::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::get_parameter_history::GetParameterHistoryOutput,
100        crate::operation::get_parameter_history::GetParameterHistoryError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// Create a paginator for this request
115    ///
116    /// Paginators are used by calling [`send().await`](crate::operation::get_parameter_history::paginator::GetParameterHistoryPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
117    pub fn into_paginator(self) -> crate::operation::get_parameter_history::paginator::GetParameterHistoryPaginator {
118        crate::operation::get_parameter_history::paginator::GetParameterHistoryPaginator::new(self.handle, self.inner)
119    }
120    /// <p>The name or Amazon Resource Name (ARN) of the parameter for which you want to review history. For parameters shared with you from another account, you must use the full ARN.</p>
121    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122        self.inner = self.inner.name(input.into());
123        self
124    }
125    /// <p>The name or Amazon Resource Name (ARN) of the parameter for which you want to review history. For parameters shared with you from another account, you must use the full ARN.</p>
126    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
127        self.inner = self.inner.set_name(input);
128        self
129    }
130    /// <p>The name or Amazon Resource Name (ARN) of the parameter for which you want to review history. For parameters shared with you from another account, you must use the full ARN.</p>
131    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
132        self.inner.get_name()
133    }
134    /// <p>Return decrypted values for secure string parameters. This flag is ignored for <code>String</code> and <code>StringList</code> parameter types.</p>
135    pub fn with_decryption(mut self, input: bool) -> Self {
136        self.inner = self.inner.with_decryption(input);
137        self
138    }
139    /// <p>Return decrypted values for secure string parameters. This flag is ignored for <code>String</code> and <code>StringList</code> parameter types.</p>
140    pub fn set_with_decryption(mut self, input: ::std::option::Option<bool>) -> Self {
141        self.inner = self.inner.set_with_decryption(input);
142        self
143    }
144    /// <p>Return decrypted values for secure string parameters. This flag is ignored for <code>String</code> and <code>StringList</code> parameter types.</p>
145    pub fn get_with_decryption(&self) -> &::std::option::Option<bool> {
146        self.inner.get_with_decryption()
147    }
148    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
149    pub fn max_results(mut self, input: i32) -> Self {
150        self.inner = self.inner.max_results(input);
151        self
152    }
153    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
154    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
155        self.inner = self.inner.set_max_results(input);
156        self
157    }
158    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
159    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
160        self.inner.get_max_results()
161    }
162    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
163    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
164        self.inner = self.inner.next_token(input.into());
165        self
166    }
167    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
168    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
169        self.inner = self.inner.set_next_token(input);
170        self
171    }
172    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
173    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
174        self.inner.get_next_token()
175    }
176}