Table of Contents
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()list_tags_for_resource()start_meeting_transcription()stop_meeting_transcription()tag_resource()untag_resource()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'
}
},
]
)
[REQUIRED]
The Amazon Chime SDK ID of the meeting to which you're adding attendees.
[REQUIRED]
The attendee information, including attendees' IDs and join tokens.
The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
A list of one or more capabilities.
The audio capability assigned to an attendee.
The video capability assigned to an attendee.
The content capability assigned to an attendee.
dict
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 assigned to an attendee: audio, video, or content.
Note
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive . If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.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.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.UnprocessableEntityExceptionChimeSDKMeetings.Client.exceptions.LimitExceededExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptionbatch_update_attendee_capabilities_except(**kwargs)¶Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.
Note
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive . If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.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'
}
)
[REQUIRED]
The ID of the meeting associated with the update request.
[REQUIRED]
The AttendeeIDs that you want to exclude from one or more capabilities.
A structure that contains one or more attendee IDs.
A list of one or more attendee IDs.
[REQUIRED]
The capabilities (audio , video , or content ) that you want to update.
The audio capability assigned to an attendee.
The video capability assigned to an attendee.
The content capability assigned to an attendee.
None
Exceptions
ChimeSDKMeetings.Client.exceptions.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ConflictExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
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").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'
}
)
[REQUIRED]
The unique ID of the meeting.
[REQUIRED]
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
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.
Note
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive . If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.The audio capability assigned to an attendee.
The video capability assigned to an attendee.
The content capability assigned to an attendee.
dict
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 assigned to an attendee: audio, video, or content.
Note
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive . If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.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.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.UnprocessableEntityExceptionChimeSDKMeetings.Client.exceptions.LimitExceededExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptioncreate_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',
TenantIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The unique identifier for the client request. Use a different token for different meetings.
This field is autopopulated if not provided.
[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 .
[REQUIRED]
The external meeting ID.
The configuration for resource targets to receive notifications when meeting and attendee events occur.
The ARN of the AWS Lambda function in the notifications configuration.
The ARN of the SNS topic.
The ARN of the SQS queue.
Lists the audio and video features enabled for a meeting, such as echo reduction.
The configuration settings for the audio features available to a meeting.
Makes echo reduction available to clients who connect to the meeting.
A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
Applies one or more tags to an Amazon Chime SDK meeting. Note the following:
Warning
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
Minimum permissions
In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag a ChimeSDKMeetings instance using the TagResources operation, you must have both of the following permissions:
tag:TagResources
ChimeSDKMeetings:CreateTags
Note
Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.
A key-value pair that you define.
The tag's key.
The tag's value.
dict
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',
'TenantIds': [
'string',
],
'MeetingArn': '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.
TenantIds (list) --
Array of strings.
MeetingArn (string) --
The ARN of the meeting.
Exceptions
ChimeSDKMeetings.Client.exceptions.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.LimitExceededExceptioncreate_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',
TenantIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The unique identifier for the client request. Use a different token for different meetings.
This field is autopopulated if not provided.
[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 .
[REQUIRED]
The external meeting ID.
Lists the audio and video features enabled for a meeting, such as echo reduction.
The configuration settings for the audio features available to a meeting.
Makes echo reduction available to clients who connect to the meeting.
The configuration for resource targets to receive notifications when meeting and attendee events occur.
The ARN of the AWS Lambda function in the notifications configuration.
The ARN of the SNS topic.
The ARN of the SQS queue.
[REQUIRED]
The attendee information, including attendees' IDs and join tokens.
The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
A list of one or more capabilities.
The audio capability assigned to an attendee.
The video capability assigned to an attendee.
The content capability assigned to an attendee.
A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
The tags in the request.
A key-value pair that you define.
The tag's key.
The tag's value.
dict
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',
'TenantIds': [
'string',
],
'MeetingArn': '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.
TenantIds (list) --
Array of strings.
MeetingArn (string) --
The ARN of the 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 assigned to an attendee: audio, video, or content.
Note
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive . If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.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.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.LimitExceededExceptiondelete_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'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The Amazon Chime SDK attendee ID.
None
Exceptions
ChimeSDKMeetings.Client.exceptions.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptiondelete_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'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
Exceptions
ChimeSDKMeetings.Client.exceptions.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptionget_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'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The Amazon Chime SDK attendee ID.
dict
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 assigned to an attendee: audio, video, or content.
Note
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive . If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.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.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptionget_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'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
{
'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',
'TenantIds': [
'string',
],
'MeetingArn': 'string'
}
}
Response Structure
The Amazon Chime SDK meeting information.
The Amazon Chime SDK meeting ID.
Reserved.
The external meeting ID.
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 .
The media placement for the meeting.
The audio host URL.
The audio fallback URL.
The signaling URL.
The turn control URL.
The screen data URL.
The screen viewing URL.
The screen sharing URL.
The event ingestion URL.
The features available to a meeting, such as Amazon Voice Focus.
The configuration settings for the audio features available to a meeting.
Makes echo reduction available to clients who connect to the meeting.
When specified, replicates the media from the primary meeting to this meeting.
Array of strings.
The ARN of the meeting.
Exceptions
ChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
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
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
dict
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 assigned to an attendee: audio, video, or content.
Note
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive . If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.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.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptionReturns a list of the tags available for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The ARN of the resource.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tags requested for the specified resource.
A key-value pair that you define.
The tag's key.
The tag's value.
Exceptions
ChimeSDKMeetings.Client.exceptions.ResourceNotFoundExceptionstart_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'
}
}
)
[REQUIRED]
The unique ID of the meeting being transcribed.
[REQUIRED]
The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings .
The transcription configuration settings passed to Amazon Transcribe.
The language code specified for the Amazon Transcribe engine.
The filtering method passed to Amazon Transcribe.
The name of the vocabulary filter passed to Amazon Transcribe.
The name of the vocabulary passed to Amazon Transcribe.
The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.
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.
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.
Set this field to PII to identify personally identifiable information in the transcription output.
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 .
Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType .
PIIEntityTypesmust be comma-separated. The available values are:BANK_ACCOUNT_NUMBER,BANK_ROUTING, CREDIT_DEBIT_NUMBER,CREDIT_DEBIT_CVV,CREDIT_DEBIT_EXPIRY,PIN,ADDRESS,NAME,PHONE,SSN, andALL.
PiiEntityTypesis an optional parameter with a default value ofALL.
The name of the language model used during transcription.
Automatically identifies the language spoken in media files.
Language codes for the languages that you want to identify. You must provide at least 2 codes.
Language code for the preferred language.
The transcription configuration settings passed to Amazon Transcribe Medical.
The language code specified for the Amazon Transcribe Medical engine.
The specialty specified for the Amazon Transcribe Medical engine.
The type of transcription.
The name of the vocabulary passed to Amazon Transcribe Medical.
The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
Set this field to PHI to identify personal health information in the transcription output.
None
Exceptions
ChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.BadRequestExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.LimitExceededExceptionChimeSDKMeetings.Client.exceptions.UnprocessableEntityExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptionstop_meeting_transcription(**kwargs)¶Stops transcription for the specified meetingId .
See also: AWS API Documentation
Request Syntax
response = client.stop_meeting_transcription(
MeetingId='string'
)
[REQUIRED]
The unique ID of the meeting for which you stop transcription.
Exceptions
ChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.BadRequestExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.UnprocessableEntityExceptionChimeSDKMeetings.Client.exceptions.ThrottlingExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionChimeSDKMeetings.Client.exceptions.ServiceFailureExceptiontag_resource(**kwargs)¶The resource that supports tags.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN of the resource.
[REQUIRED]
Lists the requested tags.
A key-value pair that you define.
The tag's key.
The tag's value.
dict
Response Syntax
{}
Response Structure
Exceptions
ChimeSDKMeetings.Client.exceptions.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ResourceNotFoundExceptionChimeSDKMeetings.Client.exceptions.TooManyTagsExceptionuntag_resource(**kwargs)¶Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:
Minimum permissions
In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions:
tag:UntagResource
ChimeSDKMeetings:DeleteTags
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource that you're removing tags from.
[REQUIRED]
The tag keys being removed from the resources.
dict
Response Syntax
{}
Response Structure
Exceptions
ChimeSDKMeetings.Client.exceptions.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ResourceNotFoundExceptionupdate_attendee_capabilities(**kwargs)¶The capabilties that you want to update.
Note
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive . If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.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'
}
)
[REQUIRED]
The ID of the meeting associated with the update request.
[REQUIRED]
The ID of the attendee associated with the update request.
[REQUIRED]
The capabilties that you want to update.
The audio capability assigned to an attendee.
The video capability assigned to an attendee.
The content capability assigned to an attendee.
dict
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 updated attendee data.
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 assigned to an attendee: audio, video, or content.
Note
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive . If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.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.BadRequestExceptionChimeSDKMeetings.Client.exceptions.ConflictExceptionChimeSDKMeetings.Client.exceptions.UnauthorizedExceptionChimeSDKMeetings.Client.exceptions.NotFoundExceptionChimeSDKMeetings.Client.exceptions.ForbiddenExceptionChimeSDKMeetings.Client.exceptions.ServiceUnavailableExceptionThe available paginators are: