aws_sdk_ssm/client/

get_parameters.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetParameters`](crate::operation::get_parameters::builders::GetParametersFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`names(impl Into<String>)`](crate::operation::get_parameters::builders::GetParametersFluentBuilder::names) / [`set_names(Option<Vec::<String>>)`](crate::operation::get_parameters::builders::GetParametersFluentBuilder::set_names):<br>required: **true**<br><p>The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs.</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><note>  <p>The results for <code>GetParameters</code> requests are listed in alphabetical order in query responses.</p> </note> <p>For 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>
    ///   - [`with_decryption(bool)`](crate::operation::get_parameters::builders::GetParametersFluentBuilder::with_decryption) / [`set_with_decryption(Option<bool>)`](crate::operation::get_parameters::builders::GetParametersFluentBuilder::set_with_decryption):<br>required: **false**<br><p>Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for <code>String</code> and <code>StringList</code> parameter types.</p><br>
    /// - On success, responds with [`GetParametersOutput`](crate::operation::get_parameters::GetParametersOutput) with field(s):
    ///   - [`parameters(Option<Vec::<Parameter>>)`](crate::operation::get_parameters::GetParametersOutput::parameters): <p>A list of details for a parameter.</p>
    ///   - [`invalid_parameters(Option<Vec::<String>>)`](crate::operation::get_parameters::GetParametersOutput::invalid_parameters): <p>A list of parameters that aren't formatted correctly or don't run during an execution.</p>
    /// - On failure, responds with [`SdkError<GetParametersError>`](crate::operation::get_parameters::GetParametersError)
    pub fn get_parameters(&self) -> crate::operation::get_parameters::builders::GetParametersFluentBuilder {
        crate::operation::get_parameters::builders::GetParametersFluentBuilder::new(self.handle.clone())
    }
}