Struct aws_sdk_ssm::client::fluent_builders::GetParametersByPath

pub struct GetParametersByPath<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to GetParametersByPath.

Retrieve information about one or more parameters in a specific hierarchy.

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.

Implementations

impl<C, M, R> GetParametersByPath<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetParametersByPathOutput, SdkError<GetParametersByPathError>> where
    R::Policy: SmithyRetryPolicy<GetParametersByPathInputOperationOutputAlias, GetParametersByPathOutput, GetParametersByPathError, GetParametersByPathInputOperationRetryAlias>, 

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 path(self, inp: impl Into<String>) -> Self

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

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

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

pub fn recursive(self, inp: bool) -> Self

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

pub fn set_recursive(self, input: Option<bool>) -> Self

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

pub fn parameter_filters(self, inp: impl Into<ParameterStringFilter>) -> Self

Appends an item to ParameterFilters.

To override the contents of this collection use set_parameter_filters.

Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

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

Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

pub fn with_decryption(self, inp: bool) -> Self

Retrieve all parameters in a hierarchy with their value decrypted.

pub fn set_with_decryption(self, input: Option<bool>) -> Self

Retrieve all parameters in a hierarchy with their value decrypted.

pub fn max_results(self, inp: 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, inp: impl Into<String>) -> Self

A token to start the list. Use this token to get the next set of results.

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

A token to start the list. Use this token to get the next set of results.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for GetParametersByPath<C, M, R>

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

Formats the value using the given formatter.