Struct aws_sdk_ssm::client::fluent_builders::ListDocuments

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

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

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

pub async fn send(
    self
) -> Result<ListDocumentsOutput, SdkError<ListDocumentsError>> where
    R::Policy: SmithyRetryPolicy<ListDocumentsInputOperationOutputAlias, ListDocumentsOutput, ListDocumentsError, ListDocumentsInputOperationRetryAlias>, 

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 document_filter_list(self, inp: impl Into<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.

pub fn set_document_filter_list(
    self,
    input: Option<Vec<DocumentFilter>>
) -> Self

This data type is deprecated. Instead, use Filters.

pub fn filters(self, inp: impl Into<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

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

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

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<C: Debug, M: Debug, R: Debug> Debug for ListDocuments<C, M, R>

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

Formats the value using the given formatter.