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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

Returns:

  • (String)

    The ID of the bundle.

#directory_idString

The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName). This parameter cannot be combined with any other filter.

Returns:

  • (String)

    The ID of the directory.

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)

    The maximum number of items to return.

#next_tokenString

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

Returns:

  • (String)

    The token for the next set of results.

#user_nameString

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

Returns:

  • (String)

    The name of the directory user.

#workspace_idsArray<String>

The IDs of the WorkSpaces. This parameter cannot be combined 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 IDs of the WorkSpaces.