Struct aws_sdk_ssm::operation::list_documents::ListDocumentsInput
source · #[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)§
This struct is marked as non-exhaustive
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§
source§impl ListDocumentsInput
impl ListDocumentsInput
sourcepub fn document_filter_list(&self) -> &[DocumentFilter]
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()
.
sourcepub fn filters(&self) -> &[DocumentKeyValuesFilter]
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()
.
sourcepub fn max_results(&self) -> Option<i32>
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.
sourcepub fn next_token(&self) -> Option<&str>
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.)
source§impl ListDocumentsInput
impl ListDocumentsInput
sourcepub fn builder() -> ListDocumentsInputBuilder
pub fn builder() -> ListDocumentsInputBuilder
Creates a new builder-style object to manufacture ListDocumentsInput
.
Trait Implementations§
source§impl Clone for ListDocumentsInput
impl Clone for ListDocumentsInput
source§fn clone(&self) -> ListDocumentsInput
fn clone(&self) -> ListDocumentsInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListDocumentsInput
impl Debug for ListDocumentsInput
source§impl PartialEq for ListDocumentsInput
impl PartialEq for ListDocumentsInput
source§fn eq(&self, other: &ListDocumentsInput) -> bool
fn eq(&self, other: &ListDocumentsInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ListDocumentsInput
Auto Trait Implementations§
impl Freeze for ListDocumentsInput
impl RefUnwindSafe for ListDocumentsInput
impl Send for ListDocumentsInput
impl Sync for ListDocumentsInput
impl Unpin for ListDocumentsInput
impl UnwindSafe for ListDocumentsInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more