aws_sdk_ssm/client/
describe_parameters.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 [`DescribeParameters`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`filters(ParametersFilter)`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::filters) / [`set_filters(Option<Vec::<ParametersFilter>>)`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::set_filters):<br>required: **false**<br><p>This data type is deprecated. Instead, use <code>ParameterFilters</code>.</p><br>
8    ///   - [`parameter_filters(ParameterStringFilter)`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::parameter_filters) / [`set_parameter_filters(Option<Vec::<ParameterStringFilter>>)`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::set_parameter_filters):<br>required: **false**<br><p>Filters to limit the request results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::set_max_results):<br>required: **false**<br><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><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of items to return. (You received this token from a previous call.)</p><br>
11    ///   - [`shared(bool)`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::shared) / [`set_shared(Option<bool>)`](crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::set_shared):<br>required: **false**<br><p>Lists parameters that are shared with you.</p><note>  <p>By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the <code>PutResourcePolicy</code> command to be returned, the associated <code>RAM Resource Share Created From Policy</code> must have been promoted to a standard Resource Share using the RAM <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> API operation.</p>  <p>For more information about sharing 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> </note><br>
12    /// - On success, responds with [`DescribeParametersOutput`](crate::operation::describe_parameters::DescribeParametersOutput) with field(s):
13    ///   - [`parameters(Option<Vec::<ParameterMetadata>>)`](crate::operation::describe_parameters::DescribeParametersOutput::parameters): <p>Parameters returned by the request.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_parameters::DescribeParametersOutput::next_token): <p>The token to use when requesting the next set of items.</p>
15    /// - On failure, responds with [`SdkError<DescribeParametersError>`](crate::operation::describe_parameters::DescribeParametersError)
16    pub fn describe_parameters(&self) -> crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder {
17        crate::operation::describe_parameters::builders::DescribeParametersFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_ssm/client/describe_parameters.rs

aws_sdk_ssm/client/
describe_parameters.rs
