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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Note:

When making an API call, you may pass DescribeWorkspacesRequest data as a 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)


435
436
437
438
439
440
441
442
443
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 435

class DescribeWorkspacesRequest < Struct.new(
  :workspace_ids,
  :directory_id,
  :user_name,
  :bundle_id,
  :limit,
  :next_token)
  include Aws::Structure
end

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


435
436
437
438
439
440
441
442
443
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 435

class DescribeWorkspacesRequest < Struct.new(
  :workspace_ids,
  :directory_id,
  :user_name,
  :bundle_id,
  :limit,
  :next_token)
  include Aws::Structure
end

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)


435
436
437
438
439
440
441
442
443
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 435

class DescribeWorkspacesRequest < Struct.new(
  :workspace_ids,
  :directory_id,
  :user_name,
  :bundle_id,
  :limit,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


435
436
437
438
439
440
441
442
443
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 435

class DescribeWorkspacesRequest < Struct.new(
  :workspace_ids,
  :directory_id,
  :user_name,
  :bundle_id,
  :limit,
  :next_token)
  include Aws::Structure
end

#user_nameString

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

Returns:

  • (String)


435
436
437
438
439
440
441
442
443
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 435

class DescribeWorkspacesRequest < Struct.new(
  :workspace_ids,
  :directory_id,
  :user_name,
  :bundle_id,
  :limit,
  :next_token)
  include Aws::Structure
end

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


435
436
437
438
439
440
441
442
443
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 435

class DescribeWorkspacesRequest < Struct.new(
  :workspace_ids,
  :directory_id,
  :user_name,
  :bundle_id,
  :limit,
  :next_token)
  include Aws::Structure
end