AWS API Changes

2021/06/24 - Amazon Chime - 4 updated api methods

Changes Adds EventIngestionUrl field to MediaPlacement

CreateMeeting (updated)

Link ¶
Changes (response)

{'Meeting': {'MediaPlacement': {'EventIngestionUrl': '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',
    ExternalMeetingId='string',
    MeetingHostId='string',
    MediaRegion='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    NotificationsConfiguration={
        '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 ExternalMeetingId:

string

param ExternalMeetingId:

The external meeting ID.

type MeetingHostId:

string

param MeetingHostId:

Reserved.

type MediaRegion:

string

param MediaRegion:

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 Tags:

list

param Tags:

The tag key-value pairs.

(dict) --

Describes a tag applied to a resource.
- Key (string) -- [REQUIRED]
  
  The key of the tag.
- Value (string) -- [REQUIRED]
  
  The value of the tag.

type NotificationsConfiguration:

dict

param NotificationsConfiguration:

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

SnsTopicArn (string) --

The SNS topic ARN.
SqsQueueArn (string) --

The SQS queue ARN.

rtype:

dict

returns:

Response Syntax

{
    'Meeting': {
        'MeetingId': 'string',
        'ExternalMeetingId': 'string',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'AudioFallbackUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string',
            'EventIngestionUrl': 'string'
        },
        'MediaRegion': 'string'
    }
}

Response Structure

(dict) --
- Meeting (dict) --
  
  The meeting information, including the meeting ID and MediaPlacement .
  - MeetingId (string) --
    
    The Amazon Chime SDK meeting ID.
  - ExternalMeetingId (string) --
    
    The external meeting ID.
  - MediaPlacement (dict) --
    
    The media placement for the meeting.
    - AudioHostUrl (string) --
      
      The audio host URL.
    - AudioFallbackUrl (string) --
      
      The audio fallback URL.
    - ScreenDataUrl (string) --
      
      The screen data URL.
    - ScreenSharingUrl (string) --
      
      The screen sharing URL.
    - ScreenViewingUrl (string) --
      
      The screen viewing URL.
    - SignalingUrl (string) --
      
      The signaling URL.
    - TurnControlUrl (string) --
      
      The turn control URL.
    - EventIngestionUrl (string) --
      
      The event ingestion URL.
  - 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.

CreateMeetingWithAttendees (updated)

Link ¶
Changes (response)

{'Meeting': {'MediaPlacement': {'EventIngestionUrl': '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',
    ExternalMeetingId='string',
    MeetingHostId='string',
    MediaRegion='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    NotificationsConfiguration={
        'SnsTopicArn': 'string',
        'SqsQueueArn': 'string'
    },
    Attendees=[
        {
            'ExternalUserId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': '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 ExternalMeetingId:

string

param ExternalMeetingId:

The external meeting ID.

type MeetingHostId:

string

param MeetingHostId:

Reserved.

type MediaRegion:

string

param MediaRegion:

The Region in which to create the meeting. Default: us-east-1 .

type Tags:

list

param Tags:

The tag key-value pairs.

(dict) --

Describes a tag applied to a resource.
- Key (string) -- [REQUIRED]
  
  The key of the tag.
- Value (string) -- [REQUIRED]
  
  The value of the tag.

type NotificationsConfiguration:

dict

param NotificationsConfiguration:

The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region ( us-east-1).

SnsTopicArn (string) --

The SNS topic ARN.
SqsQueueArn (string) --

The SQS queue ARN.

type Attendees:

list

param Attendees:

The request containing the attendees to create.

(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.
- Tags (list) --
  
  The tag key-value pairs.
  - (dict) --
    
    Describes a tag applied to a resource.
    - Key (string) -- [REQUIRED]
      
      The key of the tag.
    - Value (string) -- [REQUIRED]
      
      The value of the tag.

rtype:

dict

returns:

Response Syntax

{
    'Meeting': {
        'MeetingId': 'string',
        'ExternalMeetingId': 'string',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'AudioFallbackUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string',
            'EventIngestionUrl': 'string'
        },
        'MediaRegion': 'string'
    },
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string'
        },
    ],
    'Errors': [
        {
            'ExternalUserId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- Meeting (dict) --
  
  A meeting created using the Amazon Chime SDK.
  - MeetingId (string) --
    
    The Amazon Chime SDK meeting ID.
  - ExternalMeetingId (string) --
    
    The external meeting ID.
  - MediaPlacement (dict) --
    
    The media placement for the meeting.
    - AudioHostUrl (string) --
      
      The audio host URL.
    - AudioFallbackUrl (string) --
      
      The audio fallback URL.
    - ScreenDataUrl (string) --
      
      The screen data URL.
    - ScreenSharingUrl (string) --
      
      The screen sharing URL.
    - ScreenViewingUrl (string) --
      
      The screen viewing URL.
    - SignalingUrl (string) --
      
      The signaling URL.
    - TurnControlUrl (string) --
      
      The turn control URL.
    - EventIngestionUrl (string) --
      
      The event ingestion URL.
  - 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.
- 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': {'MediaPlacement': {'EventIngestionUrl': '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',
        'ExternalMeetingId': 'string',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'AudioFallbackUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string',
            'EventIngestionUrl': 'string'
        },
        'MediaRegion': 'string'
    }
}

Response Structure

(dict) --
- Meeting (dict) --
  
  The Amazon Chime SDK meeting information.
  - MeetingId (string) --
    
    The Amazon Chime SDK meeting ID.
  - ExternalMeetingId (string) --
    
    The external meeting ID.
  - MediaPlacement (dict) --
    
    The media placement for the meeting.
    - AudioHostUrl (string) --
      
      The audio host URL.
    - AudioFallbackUrl (string) --
      
      The audio fallback URL.
    - ScreenDataUrl (string) --
      
      The screen data URL.
    - ScreenSharingUrl (string) --
      
      The screen sharing URL.
    - ScreenViewingUrl (string) --
      
      The screen viewing URL.
    - SignalingUrl (string) --
      
      The signaling URL.
    - TurnControlUrl (string) --
      
      The turn control URL.
    - EventIngestionUrl (string) --
      
      The event ingestion URL.
  - 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.

ListMeetings (updated)

Link ¶
Changes (response)

{'Meetings': {'MediaPlacement': {'EventIngestionUrl': 'string'}}}

Lists up to 100 active Amazon Chime SDK meetings. 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_meetings(
    NextToken='string',
    MaxResults=123
)

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

{
    'Meetings': [
        {
            'MeetingId': 'string',
            'ExternalMeetingId': 'string',
            'MediaPlacement': {
                'AudioHostUrl': 'string',
                'AudioFallbackUrl': 'string',
                'ScreenDataUrl': 'string',
                'ScreenSharingUrl': 'string',
                'ScreenViewingUrl': 'string',
                'SignalingUrl': 'string',
                'TurnControlUrl': 'string',
                'EventIngestionUrl': 'string'
            },
            'MediaRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Meetings (list) --
  
  The Amazon Chime SDK meeting information.
  - (dict) --
    
    A meeting created using the Amazon Chime SDK.
    - MeetingId (string) --
      
      The Amazon Chime SDK meeting ID.
    - ExternalMeetingId (string) --
      
      The external meeting ID.
    - MediaPlacement (dict) --
      
      The media placement for the meeting.
      - AudioHostUrl (string) --
        
        The audio host URL.
      - AudioFallbackUrl (string) --
        
        The audio fallback URL.
      - ScreenDataUrl (string) --
        
        The screen data URL.
      - ScreenSharingUrl (string) --
        
        The screen sharing URL.
      - ScreenViewingUrl (string) --
        
        The screen viewing URL.
      - SignalingUrl (string) --
        
        The signaling URL.
      - TurnControlUrl (string) --
        
        The turn control URL.
      - EventIngestionUrl (string) --
        
        The event ingestion URL.
    - 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.
- NextToken (string) --
  
  The token to use to retrieve the next page of results.