Struct aws_sdk_ssm::operation::list_documents::builders::ListDocumentsInputBuilder

#[non_exhaustive]
pub struct ListDocumentsInputBuilder { /* private fields */ }

A builder for ListDocumentsInput.

Implementations

impl ListDocumentsInputBuilder

pub fn document_filter_list(self, input: DocumentFilter) -> Self

Appends an item to document_filter_list.

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 get_document_filter_list(&self) -> &Option<Vec<DocumentFilter>>

This data type is deprecated. Instead, use Filters.

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

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 get_filters(&self) -> &Option<Vec<DocumentKeyValuesFilter>>

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, 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.

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 get_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, input: 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.)

pub fn get_next_token(&self) -> &Option<String>

The token for the next set of items to return. (You received this token from a previous call.)

pub fn build(self) -> Result<ListDocumentsInput, BuildError>

Consumes the builder and constructs a ListDocumentsInput.

impl ListDocumentsInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<ListDocumentsOutput, SdkError<ListDocumentsError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ListDocumentsInputBuilder

fn clone(&self) -> ListDocumentsInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListDocumentsInputBuilder

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

Formats the value using the given formatter.

impl Default for ListDocumentsInputBuilder

fn default() -> ListDocumentsInputBuilder

Returns the “default value” for a type.

impl PartialEq for ListDocumentsInputBuilder

fn eq(&self, other: &ListDocumentsInputBuilder) -> 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 ListDocumentsInputBuilder