Class: Aws::Connect::Types::UpdateAgentStatusRequest

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 UpdateAgentStatusRequest data as a hash:

{
  instance_id: "InstanceId", # required
  agent_status_id: "AgentStatusId", # required
  name: "AgentStatusName",
  description: "UpdateAgentStatusDescription",
  state: "ENABLED", # accepts ENABLED, DISABLED
  display_order: 1,
  reset_order_number: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_status_idString

The identifier of the agent status.

Returns:

  • (String)


7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7806

class UpdateAgentStatusRequest < Struct.new(
  :instance_id,
  :agent_status_id,
  :name,
  :description,
  :state,
  :display_order,
  :reset_order_number)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the agent status.

Returns:

  • (String)


7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7806

class UpdateAgentStatusRequest < Struct.new(
  :instance_id,
  :agent_status_id,
  :name,
  :description,
  :state,
  :display_order,
  :reset_order_number)
  SENSITIVE = []
  include Aws::Structure
end

#display_orderInteger

The display order of the agent status.

Returns:

  • (Integer)


7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7806

class UpdateAgentStatusRequest < Struct.new(
  :instance_id,
  :agent_status_id,
  :name,
  :description,
  :state,
  :display_order,
  :reset_order_number)
  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)


7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7806

class UpdateAgentStatusRequest < Struct.new(
  :instance_id,
  :agent_status_id,
  :name,
  :description,
  :state,
  :display_order,
  :reset_order_number)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the agent status.

Returns:

  • (String)


7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7806

class UpdateAgentStatusRequest < Struct.new(
  :instance_id,
  :agent_status_id,
  :name,
  :description,
  :state,
  :display_order,
  :reset_order_number)
  SENSITIVE = []
  include Aws::Structure
end

#reset_order_numberBoolean

A number indicating the reset order of the agent status.

Returns:

  • (Boolean)


7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7806

class UpdateAgentStatusRequest < Struct.new(
  :instance_id,
  :agent_status_id,
  :name,
  :description,
  :state,
  :display_order,
  :reset_order_number)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The state of the agent status.

Returns:

  • (String)


7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7806

class UpdateAgentStatusRequest < Struct.new(
  :instance_id,
  :agent_status_id,
  :name,
  :description,
  :state,
  :display_order,
  :reset_order_number)
  SENSITIVE = []
  include Aws::Structure
end