Struct aws_sdk_ssm::client::fluent_builders::DescribeParameters

pub struct DescribeParameters { /* private fields */ }

Fluent builder constructing a request to DescribeParameters.

Get information about a parameter.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

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, DescribeParameters retrieves whatever the original key alias was referencing.

Implementations

impl DescribeParameters

pub async fn send(
    self
) -> Result<DescribeParametersOutput, SdkError<DescribeParametersError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeParametersPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn filters(self, input: ParametersFilter) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

This data type is deprecated. Instead, use ParameterFilters.

pub fn set_filters(self, input: Option<Vec<ParametersFilter>>) -> Self

This data type is deprecated. Instead, use ParameterFilters.

pub fn parameter_filters(self, input: ParameterStringFilter) -> Self

Appends an item to ParameterFilters.

To override the contents of this collection use set_parameter_filters.

Filters to limit the request results.

pub fn set_parameter_filters(
    self,
    input: Option<Vec<ParameterStringFilter>>
) -> Self

Filters to limit the request results.

pub fn max_results(self, input: i32) -> Self

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.

pub fn set_max_results(self, input: Option<i32>) -> Self

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.

pub fn next_token(self, input: impl Into<String>) -> Self

The token for the next set of items to return. (You received this token from a previous call.)

pub fn set_next_token(self, input: Option<String>) -> Self

The token for the next set of items to return. (You received this token from a previous call.)

Trait Implementations

impl Clone for DescribeParameters

fn clone(&self) -> DescribeParameters

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.