Struct aws_sdk_ssm::client::fluent_builders::ListDocuments
source · [−]pub struct ListDocuments { /* private fields */ }
Expand description
Fluent builder constructing a request to ListDocuments
.
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
Implementations
sourceimpl ListDocuments
impl ListDocuments
sourcepub async fn send(
self
) -> Result<ListDocumentsOutput, SdkError<ListDocumentsError>>
pub async fn send(
self
) -> Result<ListDocumentsOutput, SdkError<ListDocumentsError>>
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) -> ListDocumentsPaginator
pub fn into_paginator(self) -> ListDocumentsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a Stream
.
sourcepub fn document_filter_list(self, input: DocumentFilter) -> Self
pub fn document_filter_list(self, input: DocumentFilter) -> Self
Appends an item to DocumentFilterList
.
To override the contents of this collection use set_document_filter_list
.
This data type is deprecated. Instead, use Filters
.
sourcepub fn set_document_filter_list(
self,
input: Option<Vec<DocumentFilter>>
) -> Self
pub fn set_document_filter_list(
self,
input: Option<Vec<DocumentFilter>>
) -> Self
This data type is deprecated. Instead, use Filters
.
sourcepub fn filters(self, input: DocumentKeyValuesFilter) -> Self
pub fn filters(self, input: DocumentKeyValuesFilter) -> Self
Appends an item to Filters
.
To override the contents of this collection use set_filters
.
One or more DocumentKeyValuesFilter
objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner
, Name
, PlatformTypes
, DocumentType
, and TargetType
. For example, to return documents you own use Key=Owner,Values=Self
. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName
.
This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2
sourcepub fn set_filters(self, input: Option<Vec<DocumentKeyValuesFilter>>) -> Self
pub fn set_filters(self, input: Option<Vec<DocumentKeyValuesFilter>>) -> Self
One or more DocumentKeyValuesFilter
objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner
, Name
, PlatformTypes
, DocumentType
, and TargetType
. For example, to return documents you own use Key=Owner,Values=Self
. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName
.
This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2
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
The token for the next set of items to return. (You received this token from a previous call.)
sourcepub fn set_next_token(self, input: Option<String>) -> Self
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
sourceimpl Clone for ListDocuments
impl Clone for ListDocuments
sourcefn clone(&self) -> ListDocuments
fn clone(&self) -> ListDocuments
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 ListDocuments
impl Send for ListDocuments
impl Sync for ListDocuments
impl Unpin for ListDocuments
impl !UnwindSafe for ListDocuments
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