ChimeSDKMeetings / Client / get_meeting

get_meeting

ChimeSDKMeetings.Client.get_meeting(**kwargs)

Gets the Amazon Chime SDK meeting details for the specified meeting ID. 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.get_meeting(
    MeetingId='string'
)

Parameters:

MeetingId (string) –

[REQUIRED]

The Amazon Chime SDK meeting ID.

Return type:

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 Amazon Chime SDK meeting information.

    • 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

• ChimeSDKMeetings.Client.exceptions.NotFoundException

• ChimeSDKMeetings.Client.exceptions.BadRequestException

• ChimeSDKMeetings.Client.exceptions.ForbiddenException

• ChimeSDKMeetings.Client.exceptions.UnauthorizedException

• ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException

• ChimeSDKMeetings.Client.exceptions.ServiceFailureException

• ChimeSDKMeetings.Client.exceptions.ThrottlingException