Chime / Client / get_attendee

get_attendee#

Chime.Client.get_attendee(**kwargs)#

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, GetAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

response = client.get_attendee(
    MeetingId='string',
    AttendeeId='string'
)

Parameters:

MeetingId (string) –
[REQUIRED]

The Amazon Chime SDK meeting ID.
AttendeeId (string) –
[REQUIRED]

The Amazon Chime SDK attendee ID.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- Attendee (dict) –
  
  The Amazon Chime SDK attendee information.
  - 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.ThrottledClientException
Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException