Amazon Chime SDK Meetings

2022/03/21 - Amazon Chime SDK Meetings - 3 updated api methods

Changes  Add support for media replication to link multiple WebRTC media sessions together to reach larger and global audiences. Participants connected to a replica session can be granted access to join the primary session and can switch sessions with their existing WebRTC connection

CreateMeeting (updated) Link ¶
Changes (request, response)
Request 
{'PrimaryMeetingId': 'string'}
Response 
{'Meeting': {'PrimaryMeetingId': 'string'}}

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

client.create_meeting(
    ClientRequestToken='string',
    MediaRegion='string',
    MeetingHostId='string',
    ExternalMeetingId='string',
    NotificationsConfiguration={
        'LambdaFunctionArn': 'string',
        'SnsTopicArn': 'string',
        'SqsQueueArn': 'string'
    },
    MeetingFeatures={
        'Audio': {
            'EchoReduction': 'AVAILABLE'|'UNAVAILABLE'
        }
    },
    PrimaryMeetingId='string'
)
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 AWS 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.

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 AWS 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.

type PrimaryMeetingId

string

param PrimaryMeetingId

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

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'
            }
        },
        'PrimaryMeetingId': '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.

      • 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 AWS 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.

        • ScreenDataUrl (string) --

          The screen data URL.

        • ScreenViewingUrl (string) --

          The screen viewing URL.

        • ScreenSharingUrl (string) --

          The screen sharing URL.

        • EventIngestionUrl (string) --

          The event ingestion URL.

      • MeetingFeatures (dict) --

        The features available to a meeting, such as Amazon Voice Focus.

        • 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.

      • PrimaryMeetingId (string) --

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

CreateMeetingWithAttendees (updated) Link ¶
Changes (request, response)
Request 
{'PrimaryMeetingId': 'string'}
Response 
{'Meeting': {'PrimaryMeetingId': 'string'}}

Creates a new Amazon Chime SDK meeting in the specified media Region, with 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

client.create_meeting_with_attendees(
    ClientRequestToken='string',
    MediaRegion='string',
    MeetingHostId='string',
    ExternalMeetingId='string',
    MeetingFeatures={
        'Audio': {
            'EchoReduction': 'AVAILABLE'|'UNAVAILABLE'
        }
    },
    NotificationsConfiguration={
        'LambdaFunctionArn': 'string',
        'SnsTopicArn': 'string',
        'SqsQueueArn': 'string'
    },
    Attendees=[
        {
            'ExternalUserId': 'string'
        },
    ],
    PrimaryMeetingId='string'
)
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 AWS 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.

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.

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 AWS Lambda function in the notifications configuration.

  • SnsTopicArn (string) --

    The ARN of the SNS topic.

  • SqsQueueArn (string) --

    The ARN of the SQS queue.

type Attendees

list

param Attendees

[REQUIRED]

The attendee information, including attendees' IDs and join tokens.

  • (dict) --

    The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

    • ExternalUserId (string) -- [REQUIRED]

      The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

type PrimaryMeetingId

string

param PrimaryMeetingId

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

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'
            }
        },
        'PrimaryMeetingId': 'string'
    },
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string'
        },
    ],
    'Errors': [
        {
            'ExternalUserId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': '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.

      • 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 AWS 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.

        • ScreenDataUrl (string) --

          The screen data URL.

        • ScreenViewingUrl (string) --

          The screen viewing URL.

        • ScreenSharingUrl (string) --

          The screen sharing URL.

        • EventIngestionUrl (string) --

          The event ingestion URL.

      • MeetingFeatures (dict) --

        The features available to a meeting, such as Amazon Voice Focus.

        • 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.

      • PrimaryMeetingId (string) --

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

    • Attendees (list) --

      The attendee information, including attendees' IDs and join tokens.

      • (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.

    • Errors (list) --

      If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

      • (dict) --

        The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.

        • ExternalUserId (string) --

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

GetMeeting (updated) Link ¶
Changes (response) 
{'Meeting': {'PrimaryMeetingId': 'string'}}

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

client.get_meeting(
    MeetingId='string'
)
type MeetingId

string

param MeetingId

[REQUIRED]

The Amazon Chime SDK meeting ID.

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'
            }
        },
        'PrimaryMeetingId': '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.

      • 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 AWS 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.

        • ScreenDataUrl (string) --

          The screen data URL.

        • ScreenViewingUrl (string) --

          The screen viewing URL.

        • ScreenSharingUrl (string) --

          The screen sharing URL.

        • EventIngestionUrl (string) --

          The event ingestion URL.

      • MeetingFeatures (dict) --

        The features available to a meeting, such as Amazon Voice Focus.

        • 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.

      • PrimaryMeetingId (string) --

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