AWS API Changes

2020/02/18 - Amazon Chime - 3 updated api methods

Changes Update chime client to latest version

CreateMeeting (updated)

Link ¶
Changes (response)

{'Meeting': {'MediaPlacement': {'AudioFallbackUrl': 'string'}}}

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. 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',
    MeetingHostId='string',
    MediaRegion='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 MeetingHostId:

string

param MeetingHostId:

Reserved.

type MediaRegion:

string

param MediaRegion:

The Region in which to create the meeting. Available values: ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-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 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',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'AudioFallbackUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': '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.
  - 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.
  - MediaRegion (string) --
    
    The Region in which to create the meeting. Available values: ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-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.

GetMeeting (updated)

Link ¶
Changes (response)

{'Meeting': {'MediaPlacement': {'AudioFallbackUrl': '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',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'AudioFallbackUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string'
        },
        'MediaRegion': 'string'
    }
}

Response Structure

(dict) --
- Meeting (dict) --
  
  The Amazon Chime SDK meeting information.
  - MeetingId (string) --
    
    The Amazon Chime SDK 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.
  - MediaRegion (string) --
    
    The Region in which to create the meeting. Available values: ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-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': {'AudioFallbackUrl': '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',
            'MediaPlacement': {
                'AudioHostUrl': 'string',
                'AudioFallbackUrl': 'string',
                'ScreenDataUrl': 'string',
                'ScreenSharingUrl': 'string',
                'ScreenViewingUrl': 'string',
                'SignalingUrl': 'string',
                'TurnControlUrl': '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.
    - 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.
    - MediaRegion (string) --
      
      The Region in which to create the meeting. Available values: ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-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.