ChimeSDKMeetings **************** 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 Amazon Web Services 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 ChimeSDKMeetings / Client / stop_meeting_transcription stop_meeting_transcription ************************** ChimeSDKMeetings.Client.stop_meeting_transcription(**kwargs) Stops transcription for the specified "meetingId". For more information, refer to Using Amazon Chime SDK live transcription in the *Amazon Chime SDK Developer Guide*. Warning: By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve Amazon Web Services AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations. 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" ChimeSDKMeetings / Client / get_paginator get_paginator ************* ChimeSDKMeetings.Client.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: "botocore.paginate.Paginator" Returns: A paginator object. ChimeSDKMeetings / Client / create_meeting create_meeting ************** ChimeSDKMeetings.Client.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' }, 'Video': { 'MaxResolution': 'None'|'HD'|'FHD' }, 'Content': { 'MaxResolution': 'None'|'FHD'|'UHD' }, 'Attendee': { 'MaxCount': 123 } }, PrimaryMeetingId='string', TenantIds=[ 'string', ], Tags=[ { 'Key': 'string', 'Value': '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 Amazon Web Services GovCloud (US) Regions: "us-gov-east-1", "us-gov-west-1". * **MeetingHostId** (*string*) -- Reserved. * **ExternalMeetingId** (*string*) -- **[REQUIRED]** The external meeting ID. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **NotificationsConfiguration** (*dict*) -- The configuration for resource targets to receive notifications when meeting and attendee events occur. * **LambdaFunctionArn** *(string) --* The ARN of the Amazon Web Services 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. * **Video** *(dict) --* The configuration settings for the video features available to a meeting. * **MaxResolution** *(string) --* The maximum video resolution for the meeting. Applies to all attendees. Note: Defaults to "HD". To use "FHD", you must also provide a "MeetingFeatures:Attendee:MaxCount" value and override the default size limit of 250 attendees. * **Content** *(dict) --* The configuration settings for the content features available to a meeting. * **MaxResolution** *(string) --* The maximum resolution for the meeting content. Note: Defaults to "FHD". To use "UHD", you must also provide a "MeetingFeatures:Attendee:MaxCount" value and override the default size limit of 250 attendees. * **Attendee** *(dict) --* The configuration settings for the attendee features available to a meeting. * **MaxCount** *(integer) --* The maximum number of attendees allowed into the meeting. * **PrimaryMeetingId** (*string*) -- When specified, replicates the media from the primary meeting to the new meeting. * **TenantIds** (*list*) -- A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users. * *(string) --* * **Tags** (*list*) -- Applies one or more tags to an Amazon Chime SDK meeting. Note the following: * Not all resources have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service. * Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the *AWS General Reference*. * You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account. * To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service. 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. * *(dict) --* A key-value pair that you define. * **Key** *(string) --* **[REQUIRED]** The tag's key. * **Value** *(string) --* **[REQUIRED]** The tag's value. 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' }, 'Video': { 'MaxResolution': 'None'|'HD'|'FHD' }, 'Content': { 'MaxResolution': 'None'|'FHD'|'UHD' }, 'Attendee': { 'MaxCount': 123 } }, '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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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 Amazon Web Services 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. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **ScreenDataUrl** *(string) --* The screen data URL. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **ScreenViewingUrl** *(string) --* The screen viewing URL. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **ScreenSharingUrl** *(string) --* The screen sharing URL. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **EventIngestionUrl** *(string) --* The event ingestion URL. * **MeetingFeatures** *(dict) --* The features available to 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. * **Video** *(dict) --* The configuration settings for the video features available to a meeting. * **MaxResolution** *(string) --* The maximum video resolution for the meeting. Applies to all attendees. Note: Defaults to "HD". To use "FHD", you must also provide a "MeetingFeatures:Attendee:MaxCount" value and override the default size limit of 250 attendees. * **Content** *(dict) --* The configuration settings for the content features available to a meeting. * **MaxResolution** *(string) --* The maximum resolution for the meeting content. Note: Defaults to "FHD". To use "UHD", you must also provide a "MeetingFeatures:Attendee:MaxCount" value and override the default size limit of 250 attendees. * **Attendee** *(dict) --* The configuration settings for the attendee features available to a meeting. * **MaxCount** *(integer) --* The maximum number of attendees allowed into the meeting. * **PrimaryMeetingId** *(string) --* When specified, replicates the media from the primary meeting to this meeting. * **TenantIds** *(list) --* Array of strings. * *(string) --* * **MeetingArn** *(string) --* The ARN of the meeting. **Exceptions** * "ChimeSDKMeetings.Client.exceptions.BadRequestException" * "ChimeSDKMeetings.Client.exceptions.ConflictException" * "ChimeSDKMeetings.Client.exceptions.ForbiddenException" * "ChimeSDKMeetings.Client.exceptions.UnauthorizedException" * "ChimeSDKMeetings.Client.exceptions.ThrottlingException" * "ChimeSDKMeetings.Client.exceptions.ServiceFailureException" * "ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException" * "ChimeSDKMeetings.Client.exceptions.LimitExceededException" ChimeSDKMeetings / Client / create_meeting_with_attendees create_meeting_with_attendees ***************************** ChimeSDKMeetings.Client.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' }, 'Video': { 'MaxResolution': 'None'|'HD'|'FHD' }, 'Content': { 'MaxResolution': 'None'|'FHD'|'UHD' }, 'Attendee': { 'MaxCount': 123 } }, 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' }, ] ) 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 Amazon Web Services GovCloud (US) Regions: "us-gov-east-1", "us-gov-west-1". * **MeetingHostId** (*string*) -- Reserved. * **ExternalMeetingId** (*string*) -- **[REQUIRED]** The external meeting ID. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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. * **Video** *(dict) --* The configuration settings for the video features available to a meeting. * **MaxResolution** *(string) --* The maximum video resolution for the meeting. Applies to all attendees. Note: Defaults to "HD". To use "FHD", you must also provide a "MeetingFeatures:Attendee:MaxCount" value and override the default size limit of 250 attendees. * **Content** *(dict) --* The configuration settings for the content features available to a meeting. * **MaxResolution** *(string) --* The maximum resolution for the meeting content. Note: Defaults to "FHD". To use "UHD", you must also provide a "MeetingFeatures:Attendee:MaxCount" value and override the default size limit of 250 attendees. * **Attendee** *(dict) --* The configuration settings for the attendee features available to a meeting. * **MaxCount** *(integer) --* The maximum number of attendees allowed into the meeting. * **NotificationsConfiguration** (*dict*) -- The configuration for resource targets to receive notifications when meeting and attendee events occur. * **LambdaFunctionArn** *(string) --* The ARN of the Amazon Web Services 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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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. * **TenantIds** (*list*) -- A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users. * *(string) --* * **Tags** (*list*) -- The tags in the request. * *(dict) --* A key-value pair that you define. * **Key** *(string) --* **[REQUIRED]** The tag's key. * **Value** *(string) --* **[REQUIRED]** The tag's value. 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' }, 'Video': { 'MaxResolution': 'None'|'HD'|'FHD' }, 'Content': { 'MaxResolution': 'None'|'FHD'|'UHD' }, 'Attendee': { 'MaxCount': 123 } }, '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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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 Amazon Web Services 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. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **ScreenDataUrl** *(string) --* The screen data URL. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **ScreenViewingUrl** *(string) --* The screen viewing URL. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **ScreenSharingUrl** *(string) --* The screen sharing URL. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **EventIngestionUrl** *(string) --* The event ingestion URL. * **MeetingFeatures** *(dict) --* The features available to 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. * **Video** *(dict) --* The configuration settings for the video features available to a meeting. * **MaxResolution** *(string) --* The maximum video resolution for the meeting. Applies to all attendees. Note: Defaults to "HD". To use "FHD", you must also provide a "MeetingFeatures:Attendee:MaxCount" value and override the default size limit of 250 attendees. * **Content** *(dict) --* The configuration settings for the content features available to a meeting. * **MaxResolution** *(string) --* The maximum resolution for the meeting content. Note: Defaults to "FHD". To use "UHD", you must also provide a "MeetingFeatures:Attendee:MaxCount" value and override the default size limit of 250 attendees. * **Attendee** *(dict) --* The configuration settings for the attendee features available to a meeting. * **MaxCount** *(integer) --* The maximum number of attendees allowed into the meeting. * **PrimaryMeetingId** *(string) --* When specified, replicates the media from the primary meeting to this meeting. * **TenantIds** *(list) --* Array of strings. * *(string) --* * **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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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: * If you specify "MeetingFeatures:Video:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Video" will be rejected with "ValidationError 400". * If you specify "MeetingFeatures:Content:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Content" will be rejected with "ValidationError 400". * You can't set "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. * When you change an "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. * When you change a "video" or "content" capability from "None" or "Receive" to "Send" or "SendReceive" , and if the attendee turned on their video or content streams, remote attendees 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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The error message. **Exceptions** * "ChimeSDKMeetings.Client.exceptions.BadRequestException" * "ChimeSDKMeetings.Client.exceptions.ConflictException" * "ChimeSDKMeetings.Client.exceptions.ForbiddenException" * "ChimeSDKMeetings.Client.exceptions.UnauthorizedException" * "ChimeSDKMeetings.Client.exceptions.ThrottlingException" * "ChimeSDKMeetings.Client.exceptions.ServiceFailureException" * "ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException" * "ChimeSDKMeetings.Client.exceptions.LimitExceededException" ChimeSDKMeetings / Client / delete_meeting delete_meeting ************** ChimeSDKMeetings.Client.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" ChimeSDKMeetings / Client / can_paginate can_paginate ************ ChimeSDKMeetings.Client.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. ChimeSDKMeetings / Client / list_tags_for_resource list_tags_for_resource ********************** ChimeSDKMeetings.Client.list_tags_for_resource(**kwargs) Returns 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' ) Parameters: **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* The tags requested for the specified resource. * *(dict) --* A key-value pair that you define. * **Key** *(string) --* The tag's key. * **Value** *(string) --* The tag's value. **Exceptions** * "ChimeSDKMeetings.Client.exceptions.BadRequestException" * "ChimeSDKMeetings.Client.exceptions.ForbiddenException" * "ChimeSDKMeetings.Client.exceptions.UnauthorizedException" * "ChimeSDKMeetings.Client.exceptions.LimitExceededException" * "ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException" * "ChimeSDKMeetings.Client.exceptions.ServiceFailureException" * "ChimeSDKMeetings.Client.exceptions.ThrottlingException" * "ChimeSDKMeetings.Client.exceptions.ResourceNotFoundException" ChimeSDKMeetings / Client / untag_resource untag_resource ************** ChimeSDKMeetings.Client.untag_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: * To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag. * You can only tag resources that are located in the specified Amazon Web Services Region for the calling Amazon Web Services account. **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', ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource that you're removing tags from. * **TagKeys** (*list*) -- **[REQUIRED]** The tag keys being removed from the resources. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ChimeSDKMeetings.Client.exceptions.BadRequestException" * "ChimeSDKMeetings.Client.exceptions.ForbiddenException" * "ChimeSDKMeetings.Client.exceptions.UnauthorizedException" * "ChimeSDKMeetings.Client.exceptions.LimitExceededException" * "ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException" * "ChimeSDKMeetings.Client.exceptions.ServiceFailureException" * "ChimeSDKMeetings.Client.exceptions.ThrottlingException" * "ChimeSDKMeetings.Client.exceptions.ResourceNotFoundException" ChimeSDKMeetings / Client / get_waiter get_waiter ********** ChimeSDKMeetings.Client.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" ChimeSDKMeetings / Client / create_attendee create_attendee *************** ChimeSDKMeetings.Client.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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. * **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. 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: * If you specify "MeetingFeatures:Video:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Video" will be rejected with "ValidationError 400". * If you specify "MeetingFeatures:Content:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Content" will be rejected with "ValidationError 400". * You can't set "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. * When you change an "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. * When you change a "video" or "content" capability from "None" or "Receive" to "Send" or "SendReceive" , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back- end server. * **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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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: * If you specify "MeetingFeatures:Video:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Video" will be rejected with "ValidationError 400". * If you specify "MeetingFeatures:Content:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Content" will be rejected with "ValidationError 400". * You can't set "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. * When you change an "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. * When you change a "video" or "content" capability from "None" or "Receive" to "Send" or "SendReceive" , and if the attendee turned on their video or content streams, remote attendees 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.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" ChimeSDKMeetings / Client / batch_create_attendee batch_create_attendee ********************* ChimeSDKMeetings.Client.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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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: * If you specify "MeetingFeatures:Video:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Video" will be rejected with "ValidationError 400". * If you specify "MeetingFeatures:Content:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Content" will be rejected with "ValidationError 400". * You can't set "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. * When you change an "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. * When you change a "video" or "content" capability from "None" or "Receive" to "Send" or "SendReceive" , and if the attendee turned on their video or content streams, remote attendees 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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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" ChimeSDKMeetings / Client / get_attendee get_attendee ************ ChimeSDKMeetings.Client.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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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: * If you specify "MeetingFeatures:Video:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Video" will be rejected with "ValidationError 400". * If you specify "MeetingFeatures:Content:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Content" will be rejected with "ValidationError 400". * You can't set "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. * When you change an "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. * When you change a "video" or "content" capability from "None" or "Receive" to "Send" or "SendReceive" , and if the attendee turned on their video or content streams, remote attendees 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.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" ChimeSDKMeetings / Client / start_meeting_transcription start_meeting_transcription *************************** ChimeSDKMeetings.Client.start_meeting_transcription(**kwargs) Starts transcription for the specified "meetingId". For more information, refer to Using Amazon Chime SDK live transcription in the *Amazon Chime SDK Developer Guide*. If you specify an invalid configuration, a "TranscriptFailed" event will be sent with the contents of the "BadRequestException" generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the *Amazon Transcribe Developer Guide*. Note: By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve AWS AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations. 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'|'th-TH'|'hi-IN', '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'|'th-TH'|'hi-IN', 'VocabularyNames': 'string', 'VocabularyFilterNames': 'string' }, '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) --* Specify the language code that represents the language spoken. If you're unsure of the language spoken in your audio, consider using "IdentifyLanguage" to enable automatic language identification. * **VocabularyFilterMethod** *(string) --* Specify how you want your vocabulary filter applied to your transcript. To replace words with "***", choose "mask". To delete words, choose "remove". To flag words without changing them, choose "tag". * **VocabularyFilterName** *(string) --* Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region. If you include "IdentifyLanguage" and want to use one or more vocabulary filters with your transcription, use the "VocabularyFilterNames" parameter instead. * **VocabularyName** *(string) --* Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive. If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region. If you include "IdentifyLanguage" and want to use one or more custom vocabularies with your transcription, use the "VocabularyNames" parameter instead. * **Region** *(string) --* The Amazon Web Services Region in which to use Amazon Transcribe. If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the "MediaRegion", then a "TranscriptFailed" event is sent. Use "auto" to use Amazon Transcribe in a Region near the meeting’s "MediaRegion". For more information, refer to Choosing a transcription Region in the *Amazon Chime SDK Developer Guide*. * **EnablePartialResultsStabilization** *(boolean) --* Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. * **PartialResultsStability** *(string) --* Specify the level of stability to use when you enable partial results stabilization ( "EnablePartialResultsStabilization"). Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy. * **ContentIdentificationType** *(string) --* Labels all personally identifiable information (PII) identified in your transcript. If you don't include "PiiEntityTypes", all PII is identified. Note: You can’t set "ContentIdentificationType" and "ContentRedactionType". * **ContentRedactionType** *(string) --* Content redaction is performed at the segment level. If you don't include "PiiEntityTypes", all PII is redacted. Note: You can’t set "ContentRedactionType" and "ContentIdentificationType". * **PiiEntityTypes** *(string) --* Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select "ALL". Values must be comma-separated and can include: "ADDRESS", "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY" "CREDIT_DEBIT_NUMBER", "EMAIL", "NAME", "PHONE", "PIN", "SSN", or "ALL". Note that if you include "PiiEntityTypes", you must also include "ContentIdentificationType" or "ContentRedactionType". If you include "ContentRedactionType" or "ContentIdentificationType", but do not include PiiEntityTypes, all PII is redacted or identified. * **LanguageModelName** *(string) --* Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive. The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch. If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region. * **IdentifyLanguage** *(boolean) --* Enables automatic language identification for your transcription. If you include "IdentifyLanguage", you can optionally use "LanguageOptions" to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy. You can also use "PreferredLanguage" to include a preferred language. Doing so can help Amazon Transcribe identify the language faster. You must include either "LanguageCode" or "IdentifyLanguage". Language identification can't be combined with custom language models or redaction. * **LanguageOptions** *(string) --* Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. Including language options can improve the accuracy of language identification. If you include "LanguageOptions", you must also include "IdentifyLanguage". Warning: You can only include one language dialect per language. For example, you cannot include "en-US" and "en-AU". * **PreferredLanguage** *(string) --* Specify a preferred language from the subset of languages codes you specified in "LanguageOptions". You can only use this parameter if you include "IdentifyLanguage" and "LanguageOptions". * **VocabularyNames** *(string) --* Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region. If you don't include "IdentifyLanguage" and want to use a custom vocabulary with your transcription, use the "VocabularyName" parameter instead. * **VocabularyFilterNames** *(string) --* Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region. If you're *not* including "IdentifyLanguage" and want to use a custom vocabulary filter with your transcription, use the "VocabularyFilterName" parameter instead. * **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 Amazon Web Services 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" ChimeSDKMeetings / Client / close close ***** ChimeSDKMeetings.Client.close() Closes underlying endpoint connections. ChimeSDKMeetings / Client / get_meeting get_meeting *********** ChimeSDKMeetings.Client.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' }, 'Video': { 'MaxResolution': 'None'|'HD'|'FHD' }, 'Content': { 'MaxResolution': 'None'|'FHD'|'UHD' }, 'Attendee': { 'MaxCount': 123 } }, 'PrimaryMeetingId': 'string', 'TenantIds': [ 'string', ], 'MeetingArn': '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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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 Amazon Web Services 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. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **ScreenDataUrl** *(string) --* The screen data URL. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **ScreenViewingUrl** *(string) --* The screen viewing URL. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **ScreenSharingUrl** *(string) --* The screen sharing URL. Warning: **This parameter is deprecated and no longer used by the Amazon Chime SDK.** * **EventIngestionUrl** *(string) --* The event ingestion URL. * **MeetingFeatures** *(dict) --* The features available to 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. * **Video** *(dict) --* The configuration settings for the video features available to a meeting. * **MaxResolution** *(string) --* The maximum video resolution for the meeting. Applies to all attendees. Note: Defaults to "HD". To use "FHD", you must also provide a "MeetingFeatures:Attendee:MaxCount" value and override the default size limit of 250 attendees. * **Content** *(dict) --* The configuration settings for the content features available to a meeting. * **MaxResolution** *(string) --* The maximum resolution for the meeting content. Note: Defaults to "FHD". To use "UHD", you must also provide a "MeetingFeatures:Attendee:MaxCount" value and override the default size limit of 250 attendees. * **Attendee** *(dict) --* The configuration settings for the attendee features available to a meeting. * **MaxCount** *(integer) --* The maximum number of attendees allowed into the meeting. * **PrimaryMeetingId** *(string) --* When specified, replicates the media from the primary meeting to this meeting. * **TenantIds** *(list) --* Array of strings. * *(string) --* * **MeetingArn** *(string) --* The ARN of the 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" ChimeSDKMeetings / Client / batch_update_attendee_capabilities_except batch_update_attendee_capabilities_except ***************************************** ChimeSDKMeetings.Client.batch_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: * If you specify "MeetingFeatures:Video:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Video" will be rejected with "ValidationError 400". * If you specify "MeetingFeatures:Content:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Content" will be rejected with "ValidationError 400". * You can't set "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. * When you change an "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. * When you change a "video" or "content" capability from "None" or "Receive" to "Send" or "SendReceive" , and if the attendee turned on their video or content streams, remote attendees 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' } ) 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" * "ChimeSDKMeetings.Client.exceptions.ServiceFailureException" * "ChimeSDKMeetings.Client.exceptions.ThrottlingException" ChimeSDKMeetings / Client / update_attendee_capabilities update_attendee_capabilities **************************** ChimeSDKMeetings.Client.update_attendee_capabilities(**kwargs) The capabilities 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: * If you specify "MeetingFeatures:Video:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Video" will be rejected with "ValidationError 400". * If you specify "MeetingFeatures:Content:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Content" will be rejected with "ValidationError 400". * You can't set "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. * When you change an "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. * When you change a "video" or "content" capability from "None" or "Receive" to "Send" or "SendReceive" , and if the attendee turned on their video or content streams, remote attendees 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' } ) 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 capabilities 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) --* 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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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: * If you specify "MeetingFeatures:Video:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Video" will be rejected with "ValidationError 400". * If you specify "MeetingFeatures:Content:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Content" will be rejected with "ValidationError 400". * You can't set "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. * When you change an "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. * When you change a "video" or "content" capability from "None" or "Receive" to "Send" or "SendReceive" , and if the attendee turned on their video or content streams, remote attendees 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.BadRequestException" * "ChimeSDKMeetings.Client.exceptions.ConflictException" * "ChimeSDKMeetings.Client.exceptions.UnauthorizedException" * "ChimeSDKMeetings.Client.exceptions.NotFoundException" * "ChimeSDKMeetings.Client.exceptions.ForbiddenException" * "ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException" * "ChimeSDKMeetings.Client.exceptions.ServiceFailureException" * "ChimeSDKMeetings.Client.exceptions.ThrottlingException" ChimeSDKMeetings / Client / tag_resource tag_resource ************ ChimeSDKMeetings.Client.tag_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' }, ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource. * **Tags** (*list*) -- **[REQUIRED]** Lists the requested tags. * *(dict) --* A key-value pair that you define. * **Key** *(string) --* **[REQUIRED]** The tag's key. * **Value** *(string) --* **[REQUIRED]** The tag's value. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ChimeSDKMeetings.Client.exceptions.BadRequestException" * "ChimeSDKMeetings.Client.exceptions.ForbiddenException" * "ChimeSDKMeetings.Client.exceptions.UnauthorizedException" * "ChimeSDKMeetings.Client.exceptions.LimitExceededException" * "ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException" * "ChimeSDKMeetings.Client.exceptions.ServiceFailureException" * "ChimeSDKMeetings.Client.exceptions.ThrottlingException" * "ChimeSDKMeetings.Client.exceptions.ResourceNotFoundException" * "ChimeSDKMeetings.Client.exceptions.TooManyTagsException" ChimeSDKMeetings / Client / delete_attendee delete_attendee *************** ChimeSDKMeetings.Client.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" ChimeSDKMeetings / Client / list_attendees list_attendees ************** ChimeSDKMeetings.Client.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. Pattern: "[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*" Values that begin with "aws:" are reserved. You can't configure a value that uses this prefix. Case insensitive. * **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: * If you specify "MeetingFeatures:Video:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Video" will be rejected with "ValidationError 400". * If you specify "MeetingFeatures:Content:MaxResolution:None" when you create a meeting, all API requests that include "SendReceive", "Send", or "Receive" for "AttendeeCapabilities:Content" will be rejected with "ValidationError 400". * You can't set "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. * When you change an "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. * When you change a "video" or "content" capability from "None" or "Receive" to "Send" or "SendReceive" , and if the attendee turned on their video or content streams, remote attendees 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.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"