pub struct ListDomainsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListDomains
.
Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. The element must be set toarn:aws:swf::AccountID:domain/*
, where AccountID is the account ID, with no dashes. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause
parameter is set to OPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Implementations§
source§impl ListDomainsFluentBuilder
impl ListDomainsFluentBuilder
sourcepub fn as_input(&self) -> &ListDomainsInputBuilder
pub fn as_input(&self) -> &ListDomainsInputBuilder
Access the ListDomains as a reference.
sourcepub async fn send(
self,
) -> Result<ListDomainsOutput, SdkError<ListDomainsError, HttpResponse>>
pub async fn send( self, ) -> Result<ListDomainsOutput, SdkError<ListDomainsError, HttpResponse>>
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.
sourcepub fn customize(
self,
) -> CustomizableOperation<ListDomainsOutput, ListDomainsError, Self>
pub fn customize( self, ) -> CustomizableOperation<ListDomainsOutput, ListDomainsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> ListDomainsPaginator
pub fn into_paginator(self) -> ListDomainsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn next_page_token(self, input: impl Into<String>) -> Self
pub fn next_page_token(self, input: impl Into<String>) -> Self
If NextPageToken
is returned there are more results available. The value of NextPageToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400
error: "Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be returned in a single call.
sourcepub fn set_next_page_token(self, input: Option<String>) -> Self
pub fn set_next_page_token(self, input: Option<String>) -> Self
If NextPageToken
is returned there are more results available. The value of NextPageToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400
error: "Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be returned in a single call.
sourcepub fn get_next_page_token(&self) -> &Option<String>
pub fn get_next_page_token(&self) -> &Option<String>
If NextPageToken
is returned there are more results available. The value of NextPageToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400
error: "Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be returned in a single call.
sourcepub fn registration_status(self, input: RegistrationStatus) -> Self
pub fn registration_status(self, input: RegistrationStatus) -> Self
Specifies the registration status of the domains to list.
sourcepub fn set_registration_status(self, input: Option<RegistrationStatus>) -> Self
pub fn set_registration_status(self, input: Option<RegistrationStatus>) -> Self
Specifies the registration status of the domains to list.
sourcepub fn get_registration_status(&self) -> &Option<RegistrationStatus>
pub fn get_registration_status(&self) -> &Option<RegistrationStatus>
Specifies the registration status of the domains to list.
sourcepub fn maximum_page_size(self, input: i32) -> Self
pub fn maximum_page_size(self, input: i32) -> Self
The maximum number of results that are returned per call. Use nextPageToken
to obtain further pages of results.
sourcepub fn set_maximum_page_size(self, input: Option<i32>) -> Self
pub fn set_maximum_page_size(self, input: Option<i32>) -> Self
The maximum number of results that are returned per call. Use nextPageToken
to obtain further pages of results.
sourcepub fn get_maximum_page_size(&self) -> &Option<i32>
pub fn get_maximum_page_size(&self) -> &Option<i32>
The maximum number of results that are returned per call. Use nextPageToken
to obtain further pages of results.
sourcepub fn reverse_order(self, input: bool) -> Self
pub fn reverse_order(self, input: bool) -> Self
When set to true
, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name
of the domains.
sourcepub fn set_reverse_order(self, input: Option<bool>) -> Self
pub fn set_reverse_order(self, input: Option<bool>) -> Self
When set to true
, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name
of the domains.
sourcepub fn get_reverse_order(&self) -> &Option<bool>
pub fn get_reverse_order(&self) -> &Option<bool>
When set to true
, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name
of the domains.
Trait Implementations§
source§impl Clone for ListDomainsFluentBuilder
impl Clone for ListDomainsFluentBuilder
source§fn clone(&self) -> ListDomainsFluentBuilder
fn clone(&self) -> ListDomainsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for ListDomainsFluentBuilder
impl !RefUnwindSafe for ListDomainsFluentBuilder
impl Send for ListDomainsFluentBuilder
impl Sync for ListDomainsFluentBuilder
impl Unpin for ListDomainsFluentBuilder
impl !UnwindSafe for ListDomainsFluentBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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