:doc:`ChimeSDKMeetings <../../chime-sdk-meetings>` / Client / create_meeting

**************
create_meeting
**************



.. py:method:: ChimeSDKMeetings.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 `Available Regions <https://docs.aws.amazon.com/chime-sdk/latest/dg/sdk-available-regions>`__ and `Using meeting Regions <https://docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html>`__, both in the *Amazon Chime SDK Developer Guide*. For more information about the Amazon Chime SDK, see `Using the Amazon Chime SDK <https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html>`__ in the *Amazon Chime SDK Developer Guide*.

   

  .. note::

    

    If you use this API in conjuction with the and APIs, and you don't specify the ``MeetingFeatures.Content.MaxResolution`` or ``MeetingFeatures.Video.MaxResolution`` parameters, the following defaults are used:

     

    
    * Content.MaxResolution: FHD
     
    * Video.MaxResolution: HD
    

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateMeeting>`_  


  **Request Syntax**
  ::

    response = client.create_meeting(
        ClientRequestToken='string',
        MediaRegion='string',
        MeetingHostId='string',
        ExternalMeetingId='string',
        NotificationsConfiguration={
            'LambdaFunctionArn': 'string',
            'SnsTopicArn': 'string',
            'SqsQueueArn': 'string'
        },
        MeetingFeatures={
            'Audio': {
                'EchoReduction': 'AVAILABLE'|'UNAVAILABLE'
            },
            'Video': {
                'MaxResolution': 'None'|'HD'|'FHD'
            },
            'Content': {
                'MaxResolution': 'None'|'FHD'|'UHD'
            },
            'Attendee': {
                'MaxCount': 123
            }
        },
        PrimaryMeetingId='string',
        TenantIds=[
            'string',
        ],
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        MediaPlacementNetworkType='Ipv4Only'|'DualStack'
    )
    
  :type ClientRequestToken: string
  :param ClientRequestToken: **[REQUIRED]** 

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

    This field is autopopulated if not provided.

  
  :type MediaRegion: string
  :param MediaRegion: **[REQUIRED]** 

    The Region in which to 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``.

     

    Available values in Amazon Web Services GovCloud (US) Regions: ``us-gov-east-1``, ``us-gov-west-1``.

    

  
  :type MeetingHostId: string
  :param MeetingHostId: 

    Reserved.

    

  
  :type ExternalMeetingId: string
  :param ExternalMeetingId: **[REQUIRED]** 

    The external meeting ID.

     

    Pattern: ``[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*``

     

    Values that begin with ``aws:`` are reserved. You can't configure a value that uses this prefix. Case insensitive.

    

  
  :type NotificationsConfiguration: dict
  :param NotificationsConfiguration: 

    The configuration for resource targets to receive notifications when meeting and attendee events occur.

    

  
    - **LambdaFunctionArn** *(string) --* 

      The ARN of the Amazon Web Services Lambda function in the notifications configuration.

      

    
    - **SnsTopicArn** *(string) --* 

      The ARN of the SNS topic.

      

    
    - **SqsQueueArn** *(string) --* 

      The ARN of the SQS queue.

      

    
  
  :type MeetingFeatures: dict
  :param MeetingFeatures: 

    Lists the audio and video features enabled for a meeting, such as echo reduction.

    

  
    - **Audio** *(dict) --* 

      The configuration settings for the audio features available to a meeting.

      

    
      - **EchoReduction** *(string) --* 

        Makes echo reduction available to clients who connect to the meeting.

        

      
    
    - **Video** *(dict) --* 

      The configuration settings for the video features available to a meeting.

      

    
      - **MaxResolution** *(string) --* 

        The maximum video resolution for the meeting. Applies to all attendees.

         

        .. note::

          

          Defaults to ``HD``. To use ``FHD``, you must also provide a ``MeetingFeatures:Attendee:MaxCount`` value and override the default size limit of 250 attendees.

          

        

      
    
    - **Content** *(dict) --* 

      The configuration settings for the content features available to a meeting.

      

    
      - **MaxResolution** *(string) --* 

        The maximum resolution for the meeting content.

         

        .. note::

          

          Defaults to ``FHD``. To use ``UHD``, you must also provide a ``MeetingFeatures:Attendee:MaxCount`` value and override the default size limit of 250 attendees.

          

        

      
    
    - **Attendee** *(dict) --* 

      The configuration settings for the attendee features available to a meeting.

      

    
      - **MaxCount** *(integer) --* 

        The maximum number of attendees allowed into the meeting.

        

      
    
  
  :type PrimaryMeetingId: string
  :param PrimaryMeetingId: 

    When specified, replicates the media from the primary meeting to the new meeting.

    

  
  :type TenantIds: list
  :param TenantIds: 

    A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.

    

  
    - *(string) --* 

    

  :type Tags: list
  :param Tags: 

    Applies one or more tags to an Amazon Chime SDK meeting. Note the following:

     

    
    * Not all resources have tags. For a list of services with resources that support tagging using this operation, see `Services that support the Resource Groups Tagging API <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html>`__. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.
     
    * Each resource can have up to 50 tags. For other limits, see `Tag Naming and Usage Conventions <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions>`__ in the *AWS General Reference*.
     
    * You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.
     
    * To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.
    

     

    .. warning::

       

      Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

       

     

    **Minimum permissions**

     

    In addition to the ``tag:TagResources`` permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag a ``ChimeSDKMeetings`` instance using the ``TagResources`` operation, you must have both of the following permissions:

     

    ``tag:TagResources``

     

    ``ChimeSDKMeetings:CreateTags``

     

    .. note::

      

      Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the ``s3:GetBucketTagging`` permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.

      

    

  
    - *(dict) --* 

      A key-value pair that you define.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

        The tag's key.

        

      
      - **Value** *(string) --* **[REQUIRED]** 

        The tag's value.

        

      
    

  :type MediaPlacementNetworkType: string
  :param MediaPlacementNetworkType: 

    The type of network for the media placement. Either IPv4 only or dual-stack (IPv4 and IPv6).

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Meeting': {
              'MeetingId': 'string',
              'MeetingHostId': 'string',
              'ExternalMeetingId': 'string',
              'MediaRegion': 'string',
              'MediaPlacement': {
                  'AudioHostUrl': 'string',
                  'AudioFallbackUrl': 'string',
                  'SignalingUrl': 'string',
                  'TurnControlUrl': 'string',
                  'ScreenDataUrl': 'string',
                  'ScreenViewingUrl': 'string',
                  'ScreenSharingUrl': 'string',
                  'EventIngestionUrl': 'string'
              },
              'MeetingFeatures': {
                  'Audio': {
                      'EchoReduction': 'AVAILABLE'|'UNAVAILABLE'
                  },
                  'Video': {
                      'MaxResolution': 'None'|'HD'|'FHD'
                  },
                  'Content': {
                      'MaxResolution': 'None'|'FHD'|'UHD'
                  },
                  'Attendee': {
                      'MaxCount': 123
                  }
              },
              'PrimaryMeetingId': 'string',
              'TenantIds': [
                  'string',
              ],
              'MeetingArn': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Meeting** *(dict) --* 

        The meeting information, including the meeting ID and ``MediaPlacement``.

        
        

        - **MeetingId** *(string) --* 

          The Amazon Chime SDK meeting ID.

          
        

        - **MeetingHostId** *(string) --* 

          Reserved.

          
        

        - **ExternalMeetingId** *(string) --* 

          The external meeting ID.

           

          Pattern: ``[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*``

           

          Values that begin with ``aws:`` are reserved. You can't configure a value that uses this prefix. Case insensitive.

          
        

        - **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``.

           

          Available values in Amazon Web Services GovCloud (US) Regions: ``us-gov-east-1``, ``us-gov-west-1``.

          
        

        - **MediaPlacement** *(dict) --* 

          The media placement for the meeting.

          
          

          - **AudioHostUrl** *(string) --* 

            The audio host URL.

            
          

          - **AudioFallbackUrl** *(string) --* 

            The audio fallback URL.

            
          

          - **SignalingUrl** *(string) --* 

            The signaling URL.

            
          

          - **TurnControlUrl** *(string) --* 

            The turn control URL.

             

            .. warning::

               

              **This parameter is deprecated and no longer used by the Amazon Chime SDK.**

              

            
          

          - **ScreenDataUrl** *(string) --* 

            The screen data URL.

             

            .. warning::

               

              **This parameter is deprecated and no longer used by the Amazon Chime SDK.**

              

            
          

          - **ScreenViewingUrl** *(string) --* 

            The screen viewing URL.

             

            .. warning::

               

              **This parameter is deprecated and no longer used by the Amazon Chime SDK.**

              

            
          

          - **ScreenSharingUrl** *(string) --* 

            The screen sharing URL.

             

            .. warning::

               

              **This parameter is deprecated and no longer used by the Amazon Chime SDK.**

              

            
          

          - **EventIngestionUrl** *(string) --* 

            The event ingestion URL.

            
      
        

        - **MeetingFeatures** *(dict) --* 

          The features available to a meeting, such as echo reduction.

          
          

          - **Audio** *(dict) --* 

            The configuration settings for the audio features available to a meeting.

            
            

            - **EchoReduction** *(string) --* 

              Makes echo reduction available to clients who connect to the meeting.

              
        
          

          - **Video** *(dict) --* 

            The configuration settings for the video features available to a meeting.

            
            

            - **MaxResolution** *(string) --* 

              The maximum video resolution for the meeting. Applies to all attendees.

               

              .. note::

                

                Defaults to ``HD``. To use ``FHD``, you must also provide a ``MeetingFeatures:Attendee:MaxCount`` value and override the default size limit of 250 attendees.

                

              
        
          

          - **Content** *(dict) --* 

            The configuration settings for the content features available to a meeting.

            
            

            - **MaxResolution** *(string) --* 

              The maximum resolution for the meeting content.

               

              .. note::

                

                Defaults to ``FHD``. To use ``UHD``, you must also provide a ``MeetingFeatures:Attendee:MaxCount`` value and override the default size limit of 250 attendees.

                

              
        
          

          - **Attendee** *(dict) --* 

            The configuration settings for the attendee features available to a meeting.

            
            

            - **MaxCount** *(integer) --* 

              The maximum number of attendees allowed into the meeting.

              
        
      
        

        - **PrimaryMeetingId** *(string) --* 

          When specified, replicates the media from the primary meeting to this meeting.

          
        

        - **TenantIds** *(list) --* 

          Array of strings.

          
          

          - *(string) --* 
      
        

        - **MeetingArn** *(string) --* 

          The ARN of the meeting.

          
    
  
  **Exceptions**
  
  *   :py:class:`ChimeSDKMeetings.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKMeetings.Client.exceptions.ConflictException`

  
  *   :py:class:`ChimeSDKMeetings.Client.exceptions.ForbiddenException`

  
  *   :py:class:`ChimeSDKMeetings.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`ChimeSDKMeetings.Client.exceptions.ThrottlingException`

  
  *   :py:class:`ChimeSDKMeetings.Client.exceptions.ServiceFailureException`

  
  *   :py:class:`ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`ChimeSDKMeetings.Client.exceptions.LimitExceededException`

  