Class: Aws::Connect::Types::SearchAgentStatusesRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::SearchAgentStatusesRequest

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::AgentStatusSearchCriteria

  The search criteria to be used to return agent statuses.

• #search_filter ⇒ Types::AgentStatusSearchFilter

  Filters to be applied to search results.

Instance Attribute Details

#instance_id ⇒ String

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Returns:

• (String)

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

class SearchAgentStatusesRequest < 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 28257

class SearchAgentStatusesRequest < 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 28257

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

#search_criteria ⇒ Types::AgentStatusSearchCriteria

The search criteria to be used to return agent statuses.

Returns:

• (Types::AgentStatusSearchCriteria)

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

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

#search_filter ⇒ Types::AgentStatusSearchFilter

Filters to be applied to search results.

Returns:

• (Types::AgentStatusSearchFilter)

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

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