create_attendee

ChimeSDKMeetings.Client.create_attendee(**kwargs)

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_attendee(
    MeetingId='string',
    ExternalUserId='string',
    Capabilities={
        'Audio': 'SendReceive'|'Send'|'Receive'|'None',
        'Video': 'SendReceive'|'Send'|'Receive'|'None',
        'Content': 'SendReceive'|'Send'|'Receive'|'None'
    }
)

Parameters

• MeetingId (string) --

  [REQUIRED]

  The unique ID of the meeting.

• ExternalUserId (string) --

  [REQUIRED]

  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.

• Capabilities (dict) --

  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.

  Note

  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:

  • 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.
  • 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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
  • Audio (string) -- [REQUIRED]

    The audio capability assigned to an attendee.

  • Video (string) -- [REQUIRED]

    The video capability assigned to an attendee.

  • Content (string) -- [REQUIRED]

    The content capability assigned to an attendee.

Return type

dict

Returns

Response Syntax

{
    'Attendee': {
        'ExternalUserId': 'string',
        'AttendeeId': 'string',
        'JoinToken': 'string',
        'Capabilities': {
            'Audio': 'SendReceive'|'Send'|'Receive'|'None',
            'Video': 'SendReceive'|'Send'|'Receive'|'None',
            'Content': 'SendReceive'|'Send'|'Receive'|'None'
        }
    }
}

Response Structure

• (dict) --

  • Attendee (dict) --

    The attendee information, including attendee ID and join token.

    • ExternalUserId (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. Case insensitive.

    • AttendeeId (string) --

      The Amazon Chime SDK attendee ID.

    • JoinToken (string) --

      The join token used by the Amazon Chime SDK attendee.

    • Capabilities (dict) --

      The capabilities assigned to an attendee: audio, video, or content.

      Note

      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:

      • 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.
      • 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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

      • Audio (string) --

        The audio capability assigned to an attendee.

      • Video (string) --

        The video capability assigned to an attendee.

      • Content (string) --

        The content capability assigned to an attendee.

Exceptions

• ChimeSDKMeetings.Client.exceptions.BadRequestException
• ChimeSDKMeetings.Client.exceptions.ForbiddenException
• ChimeSDKMeetings.Client.exceptions.NotFoundException
• ChimeSDKMeetings.Client.exceptions.UnauthorizedException
• ChimeSDKMeetings.Client.exceptions.UnprocessableEntityException
• ChimeSDKMeetings.Client.exceptions.LimitExceededException
• ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
• ChimeSDKMeetings.Client.exceptions.ServiceFailureException
• ChimeSDKMeetings.Client.exceptions.ThrottlingException