ChimeSDKMeetings / Client / batch_create_attendee

batch_create_attendee

ChimeSDKMeetings.Client.batch_create_attendee(**kwargs)

Creates up to 100 attendees 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.batch_create_attendee(
    MeetingId='string',
    Attendees=[
        {
            'ExternalUserId': 'string',
            'Capabilities': {
                'Audio': 'SendReceive'|'Send'|'Receive'|'None',
                'Video': 'SendReceive'|'Send'|'Receive'|'None',
                'Content': 'SendReceive'|'Send'|'Receive'|'None'
            }
        },
    ]
)

Parameters:

• MeetingId (string) –

  [REQUIRED]

  The Amazon Chime SDK ID of the meeting to which you’re adding attendees.

• Attendees (list) –

  [REQUIRED]

  The attendee information, including attendees’ IDs and join tokens.

  • (dict) –

    The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

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

    • Capabilities (dict) –

      A list of one or more capabilities.

      • 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

{
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string',
            'Capabilities': {
                'Audio': 'SendReceive'|'Send'|'Receive'|'None',
                'Video': 'SendReceive'|'Send'|'Receive'|'None',
                'Content': 'SendReceive'|'Send'|'Receive'|'None'
            }
        },
    ],
    'Errors': [
        {
            'ExternalUserId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Attendees (list) –

    The attendee information, including attendees’ IDs and join tokens.

    • (dict) –

      An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken. The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends, or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.

      We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

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

  • Errors (list) –

    If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

    • (dict) –

      The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.

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

      • ErrorCode (string) –

        The error code.

      • ErrorMessage (string) –

        The error message.

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