Struct aws_sdk_workspaces::client::fluent_builders::DescribeWorkspaces

pub struct DescribeWorkspaces { /* private fields */ }

Fluent builder constructing a request to DescribeWorkspaces.

Describes the specified WorkSpaces.

You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.

Implementations

impl DescribeWorkspaces

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeWorkspaces, AwsResponseRetryClassifier>, SdkError<DescribeWorkspacesError>>

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<DescribeWorkspacesOutput, SdkError<DescribeWorkspacesError>>

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) -> DescribeWorkspacesPaginator

Create a paginator for this request

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

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

Appends an item to WorkspaceIds.

To override the contents of this collection use set_workspace_ids.

The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.

Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

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

The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.

Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

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

The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

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

The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

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

The name of the directory user. You must specify this parameter with DirectoryId.

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

The name of the directory user. You must specify this parameter with DirectoryId.

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

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

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

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

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

The maximum number of items to return.

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

The maximum number of items to return.

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

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

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

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Trait Implementations

impl Clone for DescribeWorkspaces

fn clone(&self) -> DescribeWorkspaces

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeWorkspaces

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

Formats the value using the given formatter.