Chime / Client / list_attendees

list_attendees#

Chime.Client.list_attendees(**kwargs)#

Lists the attendees for the specified 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.

Request Syntax

response = client.list_attendees(
    MeetingId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

MeetingId (string) –
[REQUIRED]

The Amazon Chime SDK meeting ID.
NextToken (string) – The token to use to retrieve the next page of results.
MaxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Attendees (list) –
  
  The Amazon Chime SDK attendee information.
  - (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.
- NextToken (string) –
  
  The token to use to retrieve the next page of results.

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