Struct aws_sdk_swf::client::fluent_builders::ListDomains

pub struct ListDomains { /* private fields */ }

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 to arn: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

impl ListDomains

pub async fn customize(
    self
) -> Result<CustomizableOperation<ListDomains, AwsResponseRetryClassifier>, SdkError<ListDomainsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(self) -> Result<ListDomainsOutput, SdkError<ListDomainsError>>

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.

pub fn into_paginator(self) -> ListDomainsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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 60 seconds. 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.

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 60 seconds. 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.

pub fn registration_status(self, input: RegistrationStatus) -> Self

Specifies the registration status of the domains to list.

pub fn set_registration_status(self, input: Option<RegistrationStatus>) -> Self

Specifies the registration status of the domains to list.

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.

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.

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.

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.

Trait Implementations

impl Clone for ListDomains

fn clone(&self) -> ListDomains

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListDomains

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

Formats the value using the given formatter.