Chime / Client / batch_create_attendee

batch_create_attendee#

Chime.Client.batch_create_attendee(**kwargs)#

Creates up to 100 new 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',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

Parameters:

MeetingId (string) –
[REQUIRED]

The Amazon Chime SDK meeting ID.
Attendees (list) –
[REQUIRED]

The request containing the attendees to create.
- (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.
  - Tags (list) –
    
    The tag key-value pairs.
    - (dict) –
      
      Describes a tag applied to a resource.
      - Key (string) – [REQUIRED]
        
        The key of the tag.
      - Value (string) – [REQUIRED]
        
        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string'
        },
    ],
    '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.
    - AttendeeId (string) –
      
      The Amazon Chime SDK attendee ID.
    - JoinToken (string) –
      
      The join token used by the Amazon Chime SDK 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.
    - ErrorCode (string) –
      
      The error code.
    - ErrorMessage (string) –
      
      The error message.

Exceptions

Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.NotFoundException
Chime.Client.exceptions.ResourceLimitExceededException
Chime.Client.exceptions.ThrottledClientException
Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException