AWS API Changes

2021/11/04 - Amazon Chime SDK Meetings - 11 new api methods

Changes The Amazon Chime SDK Meetings APIs allow software developers to create meetings and attendees for interactive audio, video, screen and content sharing in custom meeting applications which use the Amazon Chime SDK.

CreateAttendee (new)

Link ¶

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'
)

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.

rtype:

dict

returns:

Response Syntax

{
    'Attendee': {
        'ExternalUserId': 'string',
        'AttendeeId': 'string',
        'JoinToken': 'string'
    }
}

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.

ListAttendees (new)

Link ¶

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'
        },
    ],
    '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.
- NextToken (string) --
  
  The token to use to retrieve the next page of results.

StopMeetingTranscription (new)

Link ¶

Stops transcription for the specified meetingId.

See also: AWS API Documentation

Request Syntax

client.stop_meeting_transcription(
    MeetingId='string'
)

type MeetingId:

string

param MeetingId:

[REQUIRED]

The unique ID of the meeting for which you stop transcription.

returns:

None

StartMeetingTranscription (new)

Link ¶

Starts transcription for the specified meetingId.

See also: AWS API Documentation

Request Syntax

client.start_meeting_transcription(
    MeetingId='string',
    TranscriptionConfiguration={
        'EngineTranscribeSettings': {
            'LanguageCode': 'en-US'|'en-GB'|'es-US'|'fr-CA'|'fr-FR'|'en-AU'|'it-IT'|'de-DE'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN',
            'VocabularyFilterMethod': 'remove'|'mask'|'tag',
            'VocabularyFilterName': 'string',
            'VocabularyName': 'string',
            'Region': 'us-east-2'|'us-east-1'|'us-west-2'|'ap-northeast-2'|'ap-southeast-2'|'ap-northeast-1'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'sa-east-1'|'auto'
        },
        'EngineTranscribeMedicalSettings': {
            'LanguageCode': 'en-US',
            'Specialty': 'PRIMARYCARE'|'CARDIOLOGY'|'NEUROLOGY'|'ONCOLOGY'|'RADIOLOGY'|'UROLOGY',
            'Type': 'CONVERSATION'|'DICTATION',
            'VocabularyName': 'string',
            'Region': 'us-east-1'|'us-east-2'|'us-west-2'|'ap-southeast-2'|'ca-central-1'|'eu-west-1'|'auto'
        }
    }
)

type MeetingId:

string

param MeetingId:

[REQUIRED]

The unique ID of the meeting being transcribed.

type TranscriptionConfiguration:

dict

param TranscriptionConfiguration:

[REQUIRED]

The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.

EngineTranscribeSettings (dict) --

The transcription configuration settings passed to Amazon Transcribe.
- LanguageCode (string) -- [REQUIRED]
  
  The language code specified for the Amazon Transcribe engine.
- VocabularyFilterMethod (string) --
  
  The filtering method passed to Amazon Transcribe.
- VocabularyFilterName (string) --
  
  The name of the vocabulary filter passed to Amazon Transcribe.
- VocabularyName (string) --
  
  The name of the vocabulary passed to Amazon Transcribe.
- Region (string) --
  
  The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.
EngineTranscribeMedicalSettings (dict) --

The transcription configuration settings passed to Amazon Transcribe Medical.
- LanguageCode (string) -- [REQUIRED]
  
  The language code specified for the Amazon Transcribe Medical engine.
- Specialty (string) -- [REQUIRED]
  
  The specialty specified for the Amazon Transcribe Medical engine.
- Type (string) -- [REQUIRED]
  
  The type of transcription.
- VocabularyName (string) --
  
  The name of the vocabulary passed to Amazon Transcribe Medical.
- Region (string) --
  
  The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.

returns:

None

DeleteMeeting (new)

Link ¶

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the 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.delete_meeting(
    MeetingId='string'
)

type MeetingId:

string

param MeetingId:

[REQUIRED]

The Amazon Chime SDK meeting ID.

returns:

None

BatchCreateAttendee (new)

Link ¶

Creates a group of meeting attendees.

See also: AWS API Documentation

Request Syntax

client.batch_create_attendee(
    MeetingId='string',
    Attendees=[
        {
            'ExternalUserId': 'string'
        },
    ]
)

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.

rtype:

dict

returns:

Response Syntax

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

DeleteAttendee (new)

Link ¶

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. 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.delete_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.

returns:

None

GetAttendee (new)

Link ¶

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'
    }
}

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.

GetMeeting (new)

Link ¶

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'
        }
    }
}

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

CreateMeetingWithAttendees (new)

Link ¶

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',
    NotificationsConfiguration={
        'LambdaFunctionArn': 'string',
        'SnsTopicArn': 'string',
        'SqsQueueArn': 'string'
    },
    Attendees=[
        {
            'ExternalUserId': '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. Default: us-east-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 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.

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

CreateMeeting (new)

Link ¶

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'
    }
)

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

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.

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'
        }
    }
}

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