Class: Aws::Connect::Types::SearchWorkspacesRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::SearchWorkspacesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #instance_id ⇒ String

  The identifier of the Amazon Connect instance.

• #max_results ⇒ Integer

  The maximum number of results to return per page.

• #next_token ⇒ String

  The token for the next set of results.

• #search_criteria ⇒ Types::WorkspaceSearchCriteria

  The search criteria, including field names and comparison types.

• #search_filter ⇒ Types::WorkspaceSearchFilter

  Filters to apply to the search, such as tag-based filters.

Instance Attribute Details

#instance_id ⇒ String

The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource Name (ARN) of the instance.

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 29092

class SearchWorkspacesRequest < Struct.new(
  :instance_id,
  :next_token,
  :max_results,
  :search_filter,
  :search_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per page.

Returns:

• (Integer)

# File 'lib/aws-sdk-connect/types.rb', line 29092

class SearchWorkspacesRequest < Struct.new(
  :instance_id,
  :next_token,
  :max_results,
  :search_filter,
  :search_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 29092

class SearchWorkspacesRequest < Struct.new(
  :instance_id,
  :next_token,
  :max_results,
  :search_filter,
  :search_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#search_criteria ⇒ Types::WorkspaceSearchCriteria

The search criteria, including field names and comparison types.

Returns:

• (Types::WorkspaceSearchCriteria)

# File 'lib/aws-sdk-connect/types.rb', line 29092

class SearchWorkspacesRequest < Struct.new(
  :instance_id,
  :next_token,
  :max_results,
  :search_filter,
  :search_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#search_filter ⇒ Types::WorkspaceSearchFilter

Filters to apply to the search, such as tag-based filters.

Returns:

• (Types::WorkspaceSearchFilter)

# File 'lib/aws-sdk-connect/types.rb', line 29092

class SearchWorkspacesRequest < Struct.new(
  :instance_id,
  :next_token,
  :max_results,
  :search_filter,
  :search_criteria)
  SENSITIVE = []
  include Aws::Structure
end