Amazon Chime SDK Meetings

2022/06/01 - Amazon Chime SDK Meetings - 2 new5 updated api methods

Changes  Adds support for centrally controlling each participant's ability to send and receive audio, video and screen share within a WebRTC session. Attendee capabilities can be specified when the attendee is created and updated during the session with the new BatchUpdateAttendeeCapabilitiesExcept API.

BatchUpdateAttendeeCapabilitiesExcept (new) Link ¶

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

See also: AWS API Documentation

Request Syntax

client.batch_update_attendee_capabilities_except(
    MeetingId='string',
    ExcludedAttendeeIds=[
        {
            'AttendeeId': 'string'
        },
    ],
    Capabilities={
        'Audio': 'SendReceive'|'Send'|'Receive'|'None',
        'Video': 'SendReceive'|'Send'|'Receive'|'None',
        'Content': 'SendReceive'|'Send'|'Receive'|'None'
    }
)
type MeetingId:

string

param MeetingId:

[REQUIRED]

The ID of the meeting associated with the update request.

type ExcludedAttendeeIds:

list

param ExcludedAttendeeIds:

[REQUIRED]

The AttendeeIDs that you want to exclude from one or more capabilities.

  • (dict) --

    A structure that contains one or more attendee IDs.

    • AttendeeId (string) -- [REQUIRED]

      A list of one or more attendee IDs.

type Capabilities:

dict

param Capabilities:

[REQUIRED]

The capabilities ( audio, video, or content) that you want to update.

  • Audio (string) -- [REQUIRED]

    The audio capability assigned to an attendee.

  • Video (string) -- [REQUIRED]

    The video capability assigned to an attendee.

  • Content (string) -- [REQUIRED]

    The content capability assigned to an attendee.

returns:

None

UpdateAttendeeCapabilities (new) Link ¶

The capabilties that you want to update.

See also: AWS API Documentation

Request Syntax

client.update_attendee_capabilities(
    MeetingId='string',
    AttendeeId='string',
    Capabilities={
        'Audio': 'SendReceive'|'Send'|'Receive'|'None',
        'Video': 'SendReceive'|'Send'|'Receive'|'None',
        'Content': 'SendReceive'|'Send'|'Receive'|'None'
    }
)
type MeetingId:

string

param MeetingId:

[REQUIRED]

The ID of the meeting associated with the update request.

type AttendeeId:

string

param AttendeeId:

[REQUIRED]

The ID of the attendee associated with the update request.

type Capabilities:

dict

param Capabilities:

[REQUIRED]

The capabilties that you want to update.

  • Audio (string) -- [REQUIRED]

    The audio capability assigned to an attendee.

  • Video (string) -- [REQUIRED]

    The video capability assigned to an attendee.

  • Content (string) -- [REQUIRED]

    The content capability assigned to an attendee.

rtype:

dict

returns:

Response Syntax

{
    'Attendee': {
        'ExternalUserId': 'string',
        'AttendeeId': 'string',
        'JoinToken': 'string',
        'Capabilities': {
            'Audio': 'SendReceive'|'Send'|'Receive'|'None',
            'Video': 'SendReceive'|'Send'|'Receive'|'None',
            'Content': 'SendReceive'|'Send'|'Receive'|'None'
        }
    }
}

Response Structure

  • (dict) --

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

      • Capabilities (dict) --

        The capabilities (audio, video, or content) assigned to an attendee.

        • Audio (string) --

          The audio capability assigned to an attendee.

        • Video (string) --

          The video capability assigned to an attendee.

        • Content (string) --

          The content capability assigned to an attendee.

BatchCreateAttendee (updated) Link ¶
Changes (both) 
{'Attendees': {'Capabilities': {'Audio': 'SendReceive | Send | Receive | None',
                                'Content': 'SendReceive | Send | Receive | '
                                           'None',
                                'Video': 'SendReceive | Send | Receive | '
                                         'None'}}}

Creates up to 100 attendees for an active Amazon Chime SDK meeting. 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.batch_create_attendee(
    MeetingId='string',
    Attendees=[
        {
            'ExternalUserId': 'string',
            'Capabilities': {
                'Audio': 'SendReceive'|'Send'|'Receive'|'None',
                'Video': 'SendReceive'|'Send'|'Receive'|'None',
                'Content': 'SendReceive'|'Send'|'Receive'|'None'
            }
        },
    ]
)
type MeetingId:

string

param MeetingId:

[REQUIRED]

The Amazon Chime SDK ID of the meeting to which you're adding attendees.

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.

    • Capabilities (dict) --

      A list of one or more capabilities.

      • Audio (string) -- [REQUIRED]

        The audio capability assigned to an attendee.

      • Video (string) -- [REQUIRED]

        The video capability assigned to an attendee.

      • Content (string) -- [REQUIRED]

        The content capability assigned to an attendee.

rtype:

dict

returns:

Response Syntax

{
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string',
            'Capabilities': {
                'Audio': 'SendReceive'|'Send'|'Receive'|'None',
                'Video': 'SendReceive'|'Send'|'Receive'|'None',
                'Content': 'SendReceive'|'Send'|'Receive'|'None'
            }
        },
    ],
    'Errors': [
        {
            'ExternalUserId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

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

        • Capabilities (dict) --

          The capabilities (audio, video, or content) assigned to an attendee.

          • Audio (string) --

            The audio capability assigned to an attendee.

          • Video (string) --

            The video capability assigned to an attendee.

          • Content (string) --

            The content capability assigned to an 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.

CreateAttendee (updated) Link ¶
Changes (request, response)
Request 
{'Capabilities': {'Audio': 'SendReceive | Send | Receive | None',
                  'Content': 'SendReceive | Send | Receive | None',
                  'Video': 'SendReceive | Send | Receive | None'}}
Response 
{'Attendee': {'Capabilities': {'Audio': 'SendReceive | Send | Receive | None',
                               'Content': 'SendReceive | Send | Receive | None',
                               'Video': 'SendReceive | Send | Receive | None'}}}

Creates a new attendee for an active Amazon Chime SDK meeting. 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_attendee(
    MeetingId='string',
    ExternalUserId='string',
    Capabilities={
        'Audio': 'SendReceive'|'Send'|'Receive'|'None',
        'Video': 'SendReceive'|'Send'|'Receive'|'None',
        'Content': 'SendReceive'|'Send'|'Receive'|'None'
    }
)
type MeetingId:

string

param MeetingId:

[REQUIRED]

The unique ID of the meeting.

type ExternalUserId:

string

param ExternalUserId:

[REQUIRED]

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

type Capabilities:

dict

param Capabilities:

The capabilities ( audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

  • Audio (string) -- [REQUIRED]

    The audio capability assigned to an attendee.

  • Video (string) -- [REQUIRED]

    The video capability assigned to an attendee.

  • Content (string) -- [REQUIRED]

    The content capability assigned to an attendee.

rtype:

dict

returns:

Response Syntax

{
    'Attendee': {
        'ExternalUserId': 'string',
        'AttendeeId': 'string',
        'JoinToken': 'string',
        'Capabilities': {
            'Audio': 'SendReceive'|'Send'|'Receive'|'None',
            'Video': 'SendReceive'|'Send'|'Receive'|'None',
            'Content': 'SendReceive'|'Send'|'Receive'|'None'
        }
    }
}

Response Structure

  • (dict) --

    • Attendee (dict) --

      The attendee information, including attendee ID and join token.

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

      • Capabilities (dict) --

        The capabilities (audio, video, or content) assigned to an attendee.

        • Audio (string) --

          The audio capability assigned to an attendee.

        • Video (string) --

          The video capability assigned to an attendee.

        • Content (string) --

          The content capability assigned to an attendee.

CreateMeetingWithAttendees (updated) Link ¶
Changes (both) 
{'Attendees': {'Capabilities': {'Audio': 'SendReceive | Send | Receive | None',
                                'Content': 'SendReceive | Send | Receive | '
                                           'None',
                                'Video': 'SendReceive | Send | Receive | '
                                         'None'}}}

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',
            'Capabilities': {
                'Audio': 'SendReceive'|'Send'|'Receive'|'None',
                'Video': 'SendReceive'|'Send'|'Receive'|'None',
                'Content': 'SendReceive'|'Send'|'Receive'|'None'
            }
        },
    ],
    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.

    • Capabilities (dict) --

      A list of one or more capabilities.

      • Audio (string) -- [REQUIRED]

        The audio capability assigned to an attendee.

      • Video (string) -- [REQUIRED]

        The video capability assigned to an attendee.

      • Content (string) -- [REQUIRED]

        The content capability assigned to an attendee.

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',
            'Capabilities': {
                'Audio': 'SendReceive'|'Send'|'Receive'|'None',
                'Video': 'SendReceive'|'Send'|'Receive'|'None',
                'Content': 'SendReceive'|'Send'|'Receive'|'None'
            }
        },
    ],
    '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.

        • Capabilities (dict) --

          The capabilities (audio, video, or content) assigned to an attendee.

          • Audio (string) --

            The audio capability assigned to an attendee.

          • Video (string) --

            The video capability assigned to an attendee.

          • Content (string) --

            The content capability assigned to an 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.

GetAttendee (updated) Link ¶
Changes (response) 
{'Attendee': {'Capabilities': {'Audio': 'SendReceive | Send | Receive | None',
                               'Content': 'SendReceive | Send | Receive | None',
                               'Video': 'SendReceive | Send | Receive | None'}}}

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee 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_attendee(
    MeetingId='string',
    AttendeeId='string'
)
type MeetingId:

string

param MeetingId:

[REQUIRED]

The Amazon Chime SDK meeting ID.

type AttendeeId:

string

param AttendeeId:

[REQUIRED]

The Amazon Chime SDK attendee ID.

rtype:

dict

returns:

Response Syntax

{
    'Attendee': {
        'ExternalUserId': 'string',
        'AttendeeId': 'string',
        'JoinToken': 'string',
        'Capabilities': {
            'Audio': 'SendReceive'|'Send'|'Receive'|'None',
            'Video': 'SendReceive'|'Send'|'Receive'|'None',
            'Content': 'SendReceive'|'Send'|'Receive'|'None'
        }
    }
}

Response Structure

  • (dict) --

    • Attendee (dict) --

      The Amazon Chime SDK attendee information.

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

      • Capabilities (dict) --

        The capabilities (audio, video, or content) assigned to an attendee.

        • Audio (string) --

          The audio capability assigned to an attendee.

        • Video (string) --

          The video capability assigned to an attendee.

        • Content (string) --

          The content capability assigned to an attendee.

ListAttendees (updated) Link ¶
Changes (response) 
{'Attendees': {'Capabilities': {'Audio': 'SendReceive | Send | Receive | None',
                                'Content': 'SendReceive | Send | Receive | '
                                           'None',
                                'Video': 'SendReceive | Send | Receive | '
                                         'None'}}}

Lists the attendees for the specified Amazon Chime SDK meeting. 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.list_attendees(
    MeetingId='string',
    NextToken='string',
    MaxResults=123
)
type MeetingId:

string

param MeetingId:

[REQUIRED]

The Amazon Chime SDK meeting ID.

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call.

rtype:

dict

returns:

Response Syntax

{
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string',
            'Capabilities': {
                'Audio': 'SendReceive'|'Send'|'Receive'|'None',
                'Video': 'SendReceive'|'Send'|'Receive'|'None',
                'Content': 'SendReceive'|'Send'|'Receive'|'None'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Attendees (list) --

      The Amazon Chime SDK attendee information.

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

        • Capabilities (dict) --

          The capabilities (audio, video, or content) assigned to an attendee.

          • Audio (string) --

            The audio capability assigned to an attendee.

          • Video (string) --

            The video capability assigned to an attendee.

          • Content (string) --

            The content capability assigned to an attendee.

    • NextToken (string) --

      The token to use to retrieve the next page of results.