Struct aws_sdk_directory::client::fluent_builders::DescribeDirectories

pub struct DescribeDirectories { /* private fields */ }

Fluent builder constructing a request to DescribeDirectories.

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Implementations

impl DescribeDirectories

pub async fn send(
    self
) -> Result<DescribeDirectoriesOutput, SdkError<DescribeDirectoriesError>>

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 directory_ids(self, input: impl Into<String>) -> Self

Appends an item to DirectoryIds.

To override the contents of this collection use set_directory_ids.

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

pub fn set_directory_ids(self, input: Option<Vec<String>>) -> Self

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

pub fn next_token(self, input: impl Into<String>) -> Self

The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.

pub fn set_next_token(self, input: Option<String>) -> Self

The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.

pub fn limit(self, input: i32) -> Self

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

pub fn set_limit(self, input: Option<i32>) -> Self

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Trait Implementations

impl Clone for DescribeDirectories

fn clone(&self) -> DescribeDirectories

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDirectories

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

Formats the value using the given formatter.