You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkSpaces::Types::DescribeWorkspacesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeWorkspacesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  workspace_ids: ["WorkspaceId"],
  directory_id: "DirectoryId",
  user_name: "UserName",
  bundle_id: "BundleId",
  limit: 1,
  next_token: "PaginationToken",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_id ⇒ String

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

Returns:

  • (String) —

    The identifier of the bundle.

#directory_id ⇒ String

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.

Returns:

  • (String) —

    The identifier of the directory.

#limit ⇒ Integer

The maximum number of items to return.

Returns:

  • (Integer) —

    The maximum number of items to return.

#next_token ⇒ String

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

Returns:

  • (String) —

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

#user_name ⇒ String

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

Returns:

  • (String) —

    The name of the directory user.

#workspace_ids ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    The identifiers of the WorkSpaces.