// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_documents::_list_documents_input::ListDocumentsInputBuilder;
pub use crate::operation::list_documents::_list_documents_output::ListDocumentsOutputBuilder;
impl crate::operation::list_documents::builders::ListDocumentsInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::list_documents::ListDocumentsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::list_documents::ListDocumentsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.list_documents();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `ListDocuments`.
///
/// <p>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.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ListDocumentsFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::list_documents::builders::ListDocumentsInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::list_documents::ListDocumentsOutput,
crate::operation::list_documents::ListDocumentsError,
> for ListDocumentsFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::list_documents::ListDocumentsOutput,
crate::operation::list_documents::ListDocumentsError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl ListDocumentsFluentBuilder {
/// Creates a new `ListDocumentsFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the ListDocuments as a reference.
pub fn as_input(&self) -> &crate::operation::list_documents::builders::ListDocumentsInputBuilder {
&self.inner
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::list_documents::ListDocumentsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::list_documents::ListDocumentsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::list_documents::ListDocuments::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::list_documents::ListDocuments::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::list_documents::ListDocumentsOutput,
crate::operation::list_documents::ListDocumentsError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::operation::list_documents::paginator::ListDocumentsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
pub fn into_paginator(self) -> crate::operation::list_documents::paginator::ListDocumentsPaginator {
crate::operation::list_documents::paginator::ListDocumentsPaginator::new(self.handle, self.inner)
}
///
/// Appends an item to `DocumentFilterList`.
///
/// To override the contents of this collection use [`set_document_filter_list`](Self::set_document_filter_list).
///
/// <p>This data type is deprecated. Instead, use <code>Filters</code>.</p>
pub fn document_filter_list(mut self, input: crate::types::DocumentFilter) -> Self {
self.inner = self.inner.document_filter_list(input);
self
}
/// <p>This data type is deprecated. Instead, use <code>Filters</code>.</p>
pub fn set_document_filter_list(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DocumentFilter>>) -> Self {
self.inner = self.inner.set_document_filter_list(input);
self
}
/// <p>This data type is deprecated. Instead, use <code>Filters</code>.</p>
pub fn get_document_filter_list(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DocumentFilter>> {
self.inner.get_document_filter_list()
}
///
/// Appends an item to `Filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>One or more <code>DocumentKeyValuesFilter</code> 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 <code>Owner</code>, <code>Name</code>, <code>PlatformTypes</code>, <code>DocumentType</code>, and <code>TargetType</code>. For example, to return documents you own use <code>Key=Owner,Values=Self</code>. To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p><note>
/// <p>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <code>Key=tag:tagName,Values=valueName1,valueName2</code></p>
/// </note>
pub fn filters(mut self, input: crate::types::DocumentKeyValuesFilter) -> Self {
self.inner = self.inner.filters(input);
self
}
/// <p>One or more <code>DocumentKeyValuesFilter</code> 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 <code>Owner</code>, <code>Name</code>, <code>PlatformTypes</code>, <code>DocumentType</code>, and <code>TargetType</code>. For example, to return documents you own use <code>Key=Owner,Values=Self</code>. To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p><note>
/// <p>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <code>Key=tag:tagName,Values=valueName1,valueName2</code></p>
/// </note>
pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DocumentKeyValuesFilter>>) -> Self {
self.inner = self.inner.set_filters(input);
self
}
/// <p>One or more <code>DocumentKeyValuesFilter</code> 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 <code>Owner</code>, <code>Name</code>, <code>PlatformTypes</code>, <code>DocumentType</code>, and <code>TargetType</code>. For example, to return documents you own use <code>Key=Owner,Values=Self</code>. To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p><note>
/// <p>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <code>Key=tag:tagName,Values=valueName1,valueName2</code></p>
/// </note>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DocumentKeyValuesFilter>> {
self.inner.get_filters()
}
/// <p>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.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>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.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>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.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
self.inner.get_max_results()
}
/// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_next_token()
}
}