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

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)


581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 581

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

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


581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 581

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)


581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 581

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

#next_tokenString

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

Returns:

  • (String)


581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 581

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

#user_nameString

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

Returns:

  • (String)


581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 581

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

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


581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 581

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