Class: Aws::Connect::Types::CreateParticipantRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


4128
4129
4130
4131
4132
4133
4134
4135
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 4128

class CreateParticipantRequest < Struct.new(
  :instance_id,
  :contact_id,
  :client_token,
  :participant_details)
  SENSITIVE = []
  include Aws::Structure
end

#contact_id ⇒ String

The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

Returns:

  • (String) 


4128
4129
4130
4131
4132
4133
4134
4135
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 4128

class CreateParticipantRequest < Struct.new(
  :instance_id,
  :contact_id,
  :client_token,
  :participant_details)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


4128
4129
4130
4131
4132
4133
4134
4135
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 4128

class CreateParticipantRequest < Struct.new(
  :instance_id,
  :contact_id,
  :client_token,
  :participant_details)
  SENSITIVE = []
  include Aws::Structure
end

#participant_details ⇒ Types::ParticipantDetailsToAdd

Information identifying the participant.

The only Valid value for ParticipantRole is CUSTOM_BOT.

DisplayName is Required.

Returns:



4128
4129
4130
4131
4132
4133
4134
4135
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 4128

class CreateParticipantRequest < Struct.new(
  :instance_id,
  :contact_id,
  :client_token,
  :participant_details)
  SENSITIVE = []
  include Aws::Structure
end