Struct aws_sdk_ssm::client::fluent_builders::GetParametersByPath
source · [−]pub struct GetParametersByPath { /* private fields */ }
Expand description
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
sourceimpl GetParametersByPath
impl GetParametersByPath
sourcepub async fn send(
self
) -> Result<GetParametersByPathOutput, SdkError<GetParametersByPathError>>
pub async fn send(
self
) -> Result<GetParametersByPathOutput, SdkError<GetParametersByPathError>>
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.
sourcepub fn into_paginator(self) -> GetParametersByPathPaginator
pub fn into_paginator(self) -> GetParametersByPathPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a Stream
.
sourcepub fn path(self, input: impl Into<String>) -> Self
pub fn path(self, input: impl Into<String>) -> Self
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
sourcepub fn set_path(self, input: Option<String>) -> Self
pub fn set_path(self, input: Option<String>) -> Self
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
sourcepub fn recursive(self, input: bool) -> Self
pub fn recursive(self, input: 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
.
sourcepub fn set_recursive(self, input: Option<bool>) -> Self
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
.
sourcepub fn parameter_filters(self, input: ParameterStringFilter) -> Self
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.
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
.
sourcepub fn set_parameter_filters(
self,
input: Option<Vec<ParameterStringFilter>>
) -> Self
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
.
sourcepub fn with_decryption(self, input: bool) -> Self
pub fn with_decryption(self, input: bool) -> Self
Retrieve all parameters in a hierarchy with their value decrypted.
sourcepub fn set_with_decryption(self, input: Option<bool>) -> Self
pub fn set_with_decryption(self, input: Option<bool>) -> Self
Retrieve all parameters in a hierarchy with their value decrypted.
sourcepub fn max_results(self, input: i32) -> Self
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.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
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.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
A token to start the list. Use this token to get the next set of results.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
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
sourceimpl Clone for GetParametersByPath
impl Clone for GetParametersByPath
sourcefn clone(&self) -> GetParametersByPath
fn clone(&self) -> GetParametersByPath
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for GetParametersByPath
impl Send for GetParametersByPath
impl Sync for GetParametersByPath
impl Unpin for GetParametersByPath
impl !UnwindSafe for GetParametersByPath
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more