aws_sdk_ssm/client/
get_parameter.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 [`GetParameter`](crate::operation::get_parameter::builders::GetParameterFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::get_parameter::builders::GetParameterFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::get_parameter::builders::GetParameterFluentBuilder::set_name):<br>required: **true**<br><p>The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.</p> <p>To query by parameter label, use <code>"Name": "name:label"</code>. To query by parameter version, use <code>"Name": "name:version"</code>.</p> <p>For more information about shared parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with shared parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><br>
7    ///   - [`with_decryption(bool)`](crate::operation::get_parameter::builders::GetParameterFluentBuilder::with_decryption) / [`set_with_decryption(Option<bool>)`](crate::operation::get_parameter::builders::GetParameterFluentBuilder::set_with_decryption):<br>required: **false**<br><p>Return decrypted values for secure string parameters. This flag is ignored for <code>String</code> and <code>StringList</code> parameter types.</p><br>
8    /// - On success, responds with [`GetParameterOutput`](crate::operation::get_parameter::GetParameterOutput) with field(s):
9    ///   - [`parameter(Option<Parameter>)`](crate::operation::get_parameter::GetParameterOutput::parameter): <p>Information about a parameter.</p>
10    /// - On failure, responds with [`SdkError<GetParameterError>`](crate::operation::get_parameter::GetParameterError)
11    pub fn get_parameter(&self) -> crate::operation::get_parameter::builders::GetParameterFluentBuilder {
12        crate::operation::get_parameter::builders::GetParameterFluentBuilder::new(self.handle.clone())
13    }
14}