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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

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)


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'lib/aws-sdk-workspaces/types.rb', line 2167

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

#directory_idString

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)


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'lib/aws-sdk-workspaces/types.rb', line 2167

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

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'lib/aws-sdk-workspaces/types.rb', line 2167

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

#next_tokenString

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

Returns:

  • (String)


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'lib/aws-sdk-workspaces/types.rb', line 2167

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

#user_nameString

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

Returns:

  • (String)


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'lib/aws-sdk-workspaces/types.rb', line 2167

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

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


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'lib/aws-sdk-workspaces/types.rb', line 2167

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

#workspace_nameString

The name of the user-decoupled WorkSpace.

Returns:

  • (String)


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'lib/aws-sdk-workspaces/types.rb', line 2167

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