ChimeSDKMeetings ¶

Table of Contents

ChimeSDKMeetings
- Client
- Paginators

Client ¶

class ChimeSDKMeetings.Client¶

A low-level client representing Amazon Chime SDK Meetings

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings .

import boto3

client = boto3.client('chime-sdk-meetings')

These are the available methods:

batch_create_attendee()
batch_update_attendee_capabilities_except()
can_paginate()
close()
create_attendee()
create_meeting()
create_meeting_with_attendees()
delete_attendee()
delete_meeting()
get_attendee()
get_meeting()
get_paginator()
get_waiter()
list_attendees()
start_meeting_transcription()
stop_meeting_transcription()
update_attendee_capabilities()

batch_create_attendee(**kwargs)¶

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

response = 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'
            }
        },
    ]
)

Parameters

MeetingId (string) --
[REQUIRED]

The Amazon Chime SDK ID of the meeting to which you're adding attendees.
Attendees (list) --
[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.

Return type

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.

Exceptions

ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.UnprocessableEntityException
ChimeSDKMeetings.Client.exceptions.LimitExceededException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException
ChimeSDKMeetings.Client.exceptions.ThrottlingException

batch_update_attendee_capabilities_except(**kwargs)¶

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

See also: AWS API Documentation

Request Syntax

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

Parameters

MeetingId (string) --
[REQUIRED]

The ID of the meeting associated with the update request.
ExcludedAttendeeIds (list) --
[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.
Capabilities (dict) --
[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

Exceptions

ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ConflictException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

close()¶: Closes underlying endpoint connections.

create_attendee(**kwargs)¶

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

response = client.create_attendee(
    MeetingId='string',
    ExternalUserId='string',
    Capabilities={
        'Audio': 'SendReceive'|'Send'|'Receive'|'None',
        'Video': 'SendReceive'|'Send'|'Receive'|'None',
        'Content': 'SendReceive'|'Send'|'Receive'|'None'
    }
)

Parameters

MeetingId (string) --
[REQUIRED]

The unique ID of the meeting.
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) --
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.

Return type

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.

Exceptions

ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.UnprocessableEntityException
ChimeSDKMeetings.Client.exceptions.LimitExceededException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException
ChimeSDKMeetings.Client.exceptions.ThrottlingException

create_meeting(**kwargs)¶

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

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

Parameters

ClientRequestToken (string) --
[REQUIRED]

The unique identifier for the client request. Use a different token for different meetings.

This field is autopopulated if not provided.
MediaRegion (string) --
[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 .
MeetingHostId (string) -- Reserved.
ExternalMeetingId (string) --
[REQUIRED]

The external meeting ID.
NotificationsConfiguration (dict) --
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.
MeetingFeatures (dict) --
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.
PrimaryMeetingId (string) -- When specified, replicates the media from the primary meeting to the new meeting.

Return type

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.

Exceptions

ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.ThrottlingException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.LimitExceededException

create_meeting_with_attendees(**kwargs)¶

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

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

Parameters

ClientRequestToken (string) --
[REQUIRED]

The unique identifier for the client request. Use a different token for different meetings.

This field is autopopulated if not provided.
MediaRegion (string) --
[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 .
MeetingHostId (string) -- Reserved.
ExternalMeetingId (string) --
[REQUIRED]

The external meeting ID.
MeetingFeatures (dict) --
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.
NotificationsConfiguration (dict) --
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.
Attendees (list) --
[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.
PrimaryMeetingId (string) -- When specified, replicates the media from the primary meeting to the new meeting.

Return type

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.

Exceptions

ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.ThrottlingException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.LimitExceededException

delete_attendee(**kwargs)¶

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

response = client.delete_attendee(
    MeetingId='string',
    AttendeeId='string'
)

Parameters

MeetingId (string) --
[REQUIRED]

The Amazon Chime SDK meeting ID.
AttendeeId (string) --
[REQUIRED]

The Amazon Chime SDK attendee ID.

Returns

None

Exceptions

ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException
ChimeSDKMeetings.Client.exceptions.ThrottlingException

delete_meeting(**kwargs)¶

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

response = client.delete_meeting(
    MeetingId='string'
)

Parameters

MeetingId (string) --

[REQUIRED]

The Amazon Chime SDK meeting ID.

Returns

None

Exceptions

ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException
ChimeSDKMeetings.Client.exceptions.ThrottlingException

get_attendee(**kwargs)¶

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

response = client.get_attendee(
    MeetingId='string',
    AttendeeId='string'
)

Parameters

MeetingId (string) --
[REQUIRED]

The Amazon Chime SDK meeting ID.
AttendeeId (string) --
[REQUIRED]

The Amazon Chime SDK attendee ID.

Return type

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.

Exceptions

ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException
ChimeSDKMeetings.Client.exceptions.ThrottlingException

get_meeting(**kwargs)¶

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

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

Parameters

MeetingId (string) --

[REQUIRED]

The Amazon Chime SDK meeting ID.

Return type

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.

Exceptions

ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException
ChimeSDKMeetings.Client.exceptions.ThrottlingException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

list_attendees(**kwargs)¶

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

response = client.list_attendees(
    MeetingId='string',
    NextToken='string',
    MaxResults=123
)

Parameters

MeetingId (string) --
[REQUIRED]

The Amazon Chime SDK meeting ID.
NextToken (string) -- The token to use to retrieve the next page of results.
MaxResults (integer) -- The maximum number of results to return in a single call.

Return type

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.

Exceptions

ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException
ChimeSDKMeetings.Client.exceptions.ThrottlingException

start_meeting_transcription(**kwargs)¶

Starts transcription for the specified meetingId .

See also: AWS API Documentation

Request Syntax

response = 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'|'us-gov-west-1',
            'EnablePartialResultsStabilization': True|False,
            'PartialResultsStability': 'low'|'medium'|'high',
            'ContentIdentificationType': 'PII',
            'ContentRedactionType': 'PII',
            'PiiEntityTypes': 'string',
            'LanguageModelName': 'string',
            'IdentifyLanguage': True|False,
            'LanguageOptions': 'string',
            'PreferredLanguage': 'en-US'|'en-GB'|'es-US'|'fr-CA'|'fr-FR'|'en-AU'|'it-IT'|'de-DE'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'
        },
        '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',
            'ContentIdentificationType': 'PHI'
        }
    }
)

Parameters

MeetingId (string) --
[REQUIRED]

The unique ID of the meeting being transcribed.
TranscriptionConfiguration (dict) --
[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) --
    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.
  - EnablePartialResultsStabilization (boolean) --
    Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.
  - PartialResultsStability (string) --
    The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.
  - ContentIdentificationType (string) --
    Set this field to PII to identify personally identifiable information in the transcription output.
  - ContentRedactionType (string) --
    Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.
    
    You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException .
  - PiiEntityTypes (string) --
    Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType .
    
    PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER , BANK_ROUTING, CREDIT_DEBIT_NUMBER , CREDIT_DEBIT_CVV , CREDIT_DEBIT_EXPIRY , PIN , EMAIL , ADDRESS , NAME , PHONE , SSN , and ALL .
    PiiEntityTypes is an optional parameter with a default value of ALL .
  - LanguageModelName (string) --
    The name of the language model used during transcription.
  - IdentifyLanguage (boolean) --
    Automatically identifies the language spoken in media files.
  - LanguageOptions (string) --
    Language codes for the languages that you want to identify. You must provide at least 2 codes.
  - PreferredLanguage (string) --
    Language code for the preferred language.
- 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.
  - ContentIdentificationType (string) --
    Set this field to PHI to identify personal health information in the transcription output.

Returns

None

Exceptions

ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.LimitExceededException
ChimeSDKMeetings.Client.exceptions.UnprocessableEntityException
ChimeSDKMeetings.Client.exceptions.ThrottlingException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException

stop_meeting_transcription(**kwargs)¶

Stops transcription for the specified meetingId .

See also: AWS API Documentation

Request Syntax

response = client.stop_meeting_transcription(
    MeetingId='string'
)

Parameters

MeetingId (string) --

[REQUIRED]

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

Returns

None

Exceptions

ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.UnprocessableEntityException
ChimeSDKMeetings.Client.exceptions.ThrottlingException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException

update_attendee_capabilities(**kwargs)¶

The capabilties that you want to update.

See also: AWS API Documentation

Request Syntax

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

Parameters

MeetingId (string) --
[REQUIRED]

The ID of the meeting associated with the update request.
AttendeeId (string) --
[REQUIRED]

The ID of the attendee associated with the update request.
Capabilities (dict) --
[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.

Return type

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.

Exceptions

ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.ConflictException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException

Paginators ¶

The available paginators are:

Table Of Contents

ChimeSDKMeetings¶

Client¶

Paginators¶

ChimeSDKMeetings ¶

Client ¶

Paginators ¶