Chime / Client / list_meetings

list_meetings#

Chime.Client.list_meetings(**kwargs)#

Lists up to 100 active Amazon Chime SDK meetings. 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_meetings(
    NextToken='string',
    MaxResults=123
)

Parameters:

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

{
    'Meetings': [
        {
            'MeetingId': 'string',
            'ExternalMeetingId': 'string',
            'MediaPlacement': {
                'AudioHostUrl': 'string',
                'AudioFallbackUrl': 'string',
                'ScreenDataUrl': 'string',
                'ScreenSharingUrl': 'string',
                'ScreenViewingUrl': 'string',
                'SignalingUrl': 'string',
                'TurnControlUrl': 'string',
                'EventIngestionUrl': 'string'
            },
            'MediaRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Meetings (list) –
  
  The Amazon Chime SDK meeting information.
  - (dict) –
    
    A meeting created using the Amazon Chime SDK.
    - MeetingId (string) –
      
      The Amazon Chime SDK meeting ID.
    - ExternalMeetingId (string) –
      
      The external meeting ID.
    - MediaPlacement (dict) –
      
      The media placement for the meeting.
      - AudioHostUrl (string) –
        
        The audio host URL.
      - AudioFallbackUrl (string) –
        
        The audio fallback URL.
      - ScreenDataUrl (string) –
        
        The screen data URL.
      - ScreenSharingUrl (string) –
        
        The screen sharing URL.
      - ScreenViewingUrl (string) –
        
        The screen viewing URL.
      - SignalingUrl (string) –
        
        The signaling URL.
      - TurnControlUrl (string) –
        
        The turn control URL.
      - EventIngestionUrl (string) –
        
        The event ingestion URL to which you send client meeting events.
    - MediaRegion (string) –
      
      The Region in which you create the meeting. Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
- 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.ThrottledClientException
Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException