Chime / Client / create_meeting

create_meeting#

Chime.Client.create_meeting(**kwargs)#

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . 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.create_meeting(
    ClientRequestToken='string',
    ExternalMeetingId='string',
    MeetingHostId='string',
    MediaRegion='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    NotificationsConfiguration={
        'SnsTopicArn': 'string',
        'SqsQueueArn': 'string'
    }
)

Parameters:

ClientRequestToken (string) –
[REQUIRED]

The unique identifier for the client request. Use a different token for different meetings.

This field is autopopulated if not provided.
ExternalMeetingId (string) – The external meeting ID.
MeetingHostId (string) – Reserved.
MediaRegion (string) –
The Region in which to create the meeting. Default: us-east-1.

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 .
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.
NotificationsConfiguration (dict) –
The configuration for resource targets to receive notifications when meeting and attendee events occur.
- SnsTopicArn (string) –
  
  The SNS topic ARN.
- SqsQueueArn (string) –
  
  The SQS queue ARN.

Return type:

dict

Returns:

Response Syntax

{
    'Meeting': {
        'MeetingId': 'string',
        'ExternalMeetingId': 'string',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'AudioFallbackUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string',
            'EventIngestionUrl': 'string'
        },
        'MediaRegion': 'string'
    }
}

Response Structure

(dict) –
- Meeting (dict) –
  
  The meeting information, including the meeting ID and MediaPlacement .
  - 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.

Exceptions

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