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

Contains the inputs for the DescribeWorkspaces operation.

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.

Returns:

  • (String)

    The identifier of a bundle to obtain the WorkSpaces for.

#directory_idString

Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.

Returns:

  • (String)

    Specifies the directory identifier to which to limit the WorkSpaces.

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)

    The maximum number of items to return.

#next_tokenString

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

Returns:

  • (String)

    The NextToken value from a previous call to this operation.

#user_nameString

Used with the DirectoryId parameter to specify the directory user for whom to obtain the WorkSpace.

Returns:

  • (String)

    Used with the DirectoryId parameter to specify the directory user for whom to obtain the WorkSpace.

#workspace_idsArray<String>

An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

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

    An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information.