Struct ListDocumentsInput

#[non_exhaustive]
pub struct ListDocumentsInput {
    pub document_filter_list: Option<Vec<DocumentFilter>>,
    pub filters: Option<Vec<DocumentKeyValuesFilter>>,
    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.

document_filter_list: Option<Vec<DocumentFilter>>

This data type is deprecated. Instead, use Filters.

filters: 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

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>

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

Implementations

impl ListDocumentsInput

pub fn document_filter_list(&self) -> &[DocumentFilter]

This data type is deprecated. Instead, use Filters.

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

pub fn filters(&self) -> &[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

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

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>

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

impl ListDocumentsInput

pub fn builder() -> ListDocumentsInputBuilder

Creates a new builder-style object to manufacture ListDocumentsInput.

Trait Implementations

impl Clone for ListDocumentsInput

fn clone(&self) -> ListDocumentsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListDocumentsInput

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

Formats the value using the given formatter.

impl PartialEq for ListDocumentsInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListDocumentsInput