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

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpaces::Types::DescribeWorkspacesRequest

Defined in:

gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bundle_id ⇒ String

  The identifier of the bundle.

• #directory_id ⇒ String

  The identifier of the directory.

• #limit ⇒ Integer

  The maximum number of items to return.

• #next_token ⇒ String

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

• #user_name ⇒ String

  The name of the directory user.

• #workspace_ids ⇒ Array<String>

  The identifiers of the WorkSpaces.

• #workspace_name ⇒ String

  The name of the user-decoupled WorkSpace.

Instance Attribute Details

#bundle_id ⇒ String

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)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2304

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

#directory_id ⇒ String

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)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2304

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

#limit ⇒ Integer

The maximum number of items to return.

Returns:

• (Integer)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2304

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

#next_token ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2304

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

#user_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2304

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

#workspace_ids ⇒ Array<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>)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2304

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

#workspace_name ⇒ String

The name of the user-decoupled WorkSpace.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2304

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