Class: Aws::ChimeSDKMeetings::Types::CreateAttendeeRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:external_user_id]

Instance Attribute Summary collapse

Instance Attribute Details

#capabilities ⇒ Types::AttendeeCapabilities

The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

  • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

  • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

  • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

  • If meeting features is defined as Video:MaxResolution:None but Content:MaxResolution is defined as something other than None and attendee capabilities are not defined in the API request, then the default attendee video capability is set to Receive and attendee content capability is set to SendReceive. This is because content SendReceive requires video to be at least Receive.

  • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

  • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Returns:



448
449
450
451
452
453
454
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 448

class CreateAttendeeRequest < Struct.new(
  :meeting_id,
  :external_user_id,
  :capabilities)
  SENSITIVE = [:external_user_id]
  include Aws::Structure
end

#external_user_id ⇒ String

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix.

Returns:

  • (String) 


448
449
450
451
452
453
454
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 448

class CreateAttendeeRequest < Struct.new(
  :meeting_id,
  :external_user_id,
  :capabilities)
  SENSITIVE = [:external_user_id]
  include Aws::Structure
end

#meeting_id ⇒ String

The unique ID of the meeting.

Returns:

  • (String) 


448
449
450
451
452
453
454
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/types.rb', line 448

class CreateAttendeeRequest < Struct.new(
  :meeting_id,
  :external_user_id,
  :capabilities)
  SENSITIVE = [:external_user_id]
  include Aws::Structure
end