Struct aws_sdk_workdocs::client::fluent_builders::DescribeGroups

pub struct DescribeGroups<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeGroups.

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

Implementations

impl<C, M, R> DescribeGroups<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeGroupsOutput, SdkError<DescribeGroupsError>> where
    R::Policy: SmithyRetryPolicy<DescribeGroupsInputOperationOutputAlias, DescribeGroupsOutput, DescribeGroupsError, DescribeGroupsInputOperationRetryAlias>, 

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

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

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

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

pub fn search_query(self, inp: impl Into<String>) -> Self

A query to describe groups by group name.

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

A query to describe groups by group name.

pub fn organization_id(self, inp: impl Into<String>) -> Self

The ID of the organization.

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

The ID of the organization.

pub fn marker(self, inp: impl Into<String>) -> Self

The marker for the next set of results. (You received this marker from a previous call.)

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

The marker for the next set of results. (You received this marker from a previous call.)

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

The maximum number of items to return with this call.

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

The maximum number of items to return with this call.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeGroups<C, M, R>

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

Formats the value using the given formatter.