Struct aws_sdk_ssm::operation::get_parameters_by_path::GetParametersByPathInput

#[non_exhaustive]
pub struct GetParametersByPathInput {
    pub path: Option<String>,
    pub recursive: Option<bool>,
    pub parameter_filters: Option<Vec<ParameterStringFilter>>,
    pub with_decryption: Option<bool>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: Option<String>

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, 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

recursive: Option<bool>

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.

parameter_filters: Option<Vec<ParameterStringFilter>>

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.

with_decryption: Option<bool>

Retrieve all parameters in a hierarchy with their value decrypted.

max_results: Option<i32>

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.

next_token: Option<String>

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

Implementations

impl GetParametersByPathInput

pub fn path(&self) -> Option<&str>

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, 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) -> Option<bool>

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) -> &[ParameterStringFilter]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameter_filters.is_none().

pub fn with_decryption(&self) -> Option<bool>

Retrieve all parameters in a hierarchy with their value decrypted.

pub fn max_results(&self) -> Option<i32>

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) -> Option<&str>

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

impl GetParametersByPathInput

pub fn builder() -> GetParametersByPathInputBuilder

Creates a new builder-style object to manufacture GetParametersByPathInput.

Trait Implementations

impl Clone for GetParametersByPathInput

fn clone(&self) -> GetParametersByPathInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetParametersByPathInput

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

Formats the value using the given formatter.

impl PartialEq for GetParametersByPathInput

fn eq(&self, other: &GetParametersByPathInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetParametersByPathInput