Class: Aws::Connect::Types::ListAgentStatusRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb

Overview

Note:

When making an API call, you may pass ListAgentStatusRequest data as a hash:

{
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  agent_status_types: ["ROUTABLE"], # accepts ROUTABLE, CUSTOM, OFFLINE
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_status_typesArray<String>

Available agent status types.

Returns:

  • (Array<String>)


4677
4678
4679
4680
4681
4682
4683
4684
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 4677

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

#instance_idString

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

Returns:

  • (String)


4677
4678
4679
4680
4681
4682
4683
4684
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 4677

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

#max_resultsInteger

The maximum number of results to return per page.

Returns:

  • (Integer)


4677
4678
4679
4680
4681
4682
4683
4684
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 4677

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

#next_tokenString

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)


4677
4678
4679
4680
4681
4682
4683
4684
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 4677

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