Chime / Client / create_attendee

create_attendee

Chime.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 SDK Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_attendee(
    MeetingId='string',
    ExternalUserId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• MeetingId (string) –

  [REQUIRED]

  The Amazon Chime SDK meeting ID.

• 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

{
    'Attendee': {
        'ExternalUserId': 'string',
        'AttendeeId': 'string',
        'JoinToken': 'string'
    }
}

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.

    • AttendeeId (string) –

      The Amazon Chime SDK attendee ID.

    • JoinToken (string) –

      The join token used by the Amazon Chime SDK attendee.

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