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.
", "operations": { "BatchCreateAttendee": "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.
", "BatchUpdateAttendeeCapabilitiesExcept": "Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.
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.
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.
", "CreateMeeting": "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.
", "CreateMeetingWithAttendees": "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.
", "DeleteAttendee": "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.
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.
", "GetAttendee": "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.
", "GetMeeting": "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.
", "ListAttendees": "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.
", "ListTagsForResource": "Returns a list of the tags available for the specified resource.
", "StartMeetingTranscription": "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.
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.
Stops transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.
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.
The resource that supports tags.
", "UntagResource": "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
The capabilities that you want to update.
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.
The ARN of the resource.
", "Meeting$MeetingArn": "The ARN of the meeting.
", "ResourceNotFoundException$ResourceName": "The name of the resource that couldn't be found.
", "TagResourceRequest$ResourceARN": "The ARN of the resource.
", "TooManyTagsException$ResourceName": "The name of the resource that received too many tags.
", "UntagResourceRequest$ResourceARN": "The ARN of the resource that you're removing tags from.
" } }, "Arn": { "base": null, "refs": { "NotificationsConfiguration$LambdaFunctionArn": "The ARN of the Amazon Web Services Lambda function in the notifications configuration.
", "NotificationsConfiguration$SnsTopicArn": "The ARN of the SNS topic.
", "NotificationsConfiguration$SqsQueueArn": "The ARN of the SQS queue.
" } }, "Attendee": { "base": "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.
The attendee information, including attendee ID and join token.
", "GetAttendeeResponse$Attendee": "The Amazon Chime SDK attendee information.
", "UpdateAttendeeCapabilitiesResponse$Attendee": "The updated attendee data.
" } }, "AttendeeCapabilities": { "base": "The media capabilities of an attendee: audio, video, or content.
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information, refer to and .
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 an attendee unmutes their microphone, audio flows 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 the attendee turns 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.
The capabilities assigned to an attendee: audio, video, or content.
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.
The capabilities (audio, video, or content) that you want to update.
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.
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.
A list of one or more capabilities.
", "UpdateAttendeeCapabilitiesRequest$Capabilities": "The capabilities that you want to update.
" } }, "AttendeeFeatures": { "base": "Lists the maximum number of attendees allowed into the meeting.
If you specify FHD for MeetingFeatures:Video:MaxResolution, or if you specify UHD for MeetingFeatures:Content:MaxResolution, the maximum number of attendees changes from the default of 250 to 25.
The configuration settings for the attendee features available to a meeting.
" } }, "AttendeeIdItem": { "base": "A structure that contains one or more attendee IDs.
", "refs": { "AttendeeIdsList$member": null } }, "AttendeeIdsList": { "base": null, "refs": { "BatchUpdateAttendeeCapabilitiesExceptRequest$ExcludedAttendeeIds": "The AttendeeIDs that you want to exclude from one or more capabilities.
The attendee information, including attendees' IDs and join tokens.
", "CreateMeetingWithAttendeesResponse$Attendees": "The attendee information, including attendees' IDs and join tokens.
", "ListAttendeesResponse$Attendees": "The Amazon Chime SDK attendee information.
" } }, "AttendeeMax": { "base": null, "refs": { "AttendeeFeatures$MaxCount": "The maximum number of attendees allowed into the meeting.
" } }, "AudioFeatures": { "base": "An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.
", "refs": { "MeetingFeaturesConfiguration$Audio": "The configuration settings for the audio features available to a meeting.
" } }, "BadRequestException": { "base": "The input parameters don't match the service's restrictions.
", "refs": { } }, "BatchCreateAttendeeErrorList": { "base": null, "refs": { "BatchCreateAttendeeResponse$Errors": "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.
", "CreateMeetingWithAttendeesResponse$Errors": "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.
" } }, "BatchCreateAttendeeRequest": { "base": null, "refs": { } }, "BatchCreateAttendeeResponse": { "base": null, "refs": { } }, "BatchUpdateAttendeeCapabilitiesExceptRequest": { "base": null, "refs": { } }, "Boolean": { "base": null, "refs": { "EngineTranscribeSettings$EnablePartialResultsStabilization": "Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
", "EngineTranscribeSettings$IdentifyLanguage": "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.
" } }, "ClientRequestToken": { "base": null, "refs": { "CreateMeetingRequest$ClientRequestToken": "The unique identifier for the client request. Use a different token for different meetings.
", "CreateMeetingWithAttendeesRequest$ClientRequestToken": "The unique identifier for the client request. Use a different token for different meetings.
" } }, "ConflictException": { "base": "Multiple instances of the same request have been made simultaneously.
", "refs": { } }, "ContentFeatures": { "base": "Lists the content (screen share) features for the meeting. Applies to all attendees.
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.
The configuration settings for the content features available to a meeting.
" } }, "ContentResolution": { "base": null, "refs": { "ContentFeatures$MaxResolution": "The maximum resolution for the meeting content.
Defaults to FHD. To use UHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
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.
", "refs": { "BatchCreateAttendeeErrorList$member": null } }, "CreateAttendeeRequest": { "base": null, "refs": { } }, "CreateAttendeeRequestItem": { "base": "The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
", "refs": { "CreateAttendeeRequestItemList$member": null, "CreateMeetingWithAttendeesRequestItemList$member": null } }, "CreateAttendeeRequestItemList": { "base": null, "refs": { "BatchCreateAttendeeRequest$Attendees": "The attendee information, including attendees' IDs and join tokens.
" } }, "CreateAttendeeResponse": { "base": null, "refs": { } }, "CreateMeetingRequest": { "base": null, "refs": { } }, "CreateMeetingResponse": { "base": null, "refs": { } }, "CreateMeetingWithAttendeesRequest": { "base": null, "refs": { } }, "CreateMeetingWithAttendeesRequestItemList": { "base": null, "refs": { "CreateMeetingWithAttendeesRequest$Attendees": "The attendee information, including attendees' IDs and join tokens.
" } }, "CreateMeetingWithAttendeesResponse": { "base": null, "refs": { } }, "DeleteAttendeeRequest": { "base": null, "refs": { } }, "DeleteMeetingRequest": { "base": null, "refs": { } }, "EngineTranscribeMedicalSettings": { "base": "Settings specific to the Amazon Transcribe Medical engine.
", "refs": { "TranscriptionConfiguration$EngineTranscribeMedicalSettings": "The transcription configuration settings passed to Amazon Transcribe Medical.
" } }, "EngineTranscribeSettings": { "base": "Settings specific for Amazon Transcribe as the live transcription engine.
If you specify an invalid combination of parameters, 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.
The transcription configuration settings passed to Amazon Transcribe.
" } }, "ExternalMeetingId": { "base": null, "refs": { "CreateMeetingRequest$ExternalMeetingId": "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.
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.
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.
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.
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.
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.
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.
Reserved.
", "CreateMeetingWithAttendeesRequest$MeetingHostId": "Reserved.
", "Meeting$MeetingHostId": "Reserved.
" } }, "ForbiddenException": { "base": "The client is permanently forbidden from making the request.
", "refs": { } }, "GetAttendeeRequest": { "base": null, "refs": { } }, "GetAttendeeResponse": { "base": null, "refs": { } }, "GetMeetingRequest": { "base": null, "refs": { } }, "GetMeetingResponse": { "base": null, "refs": { } }, "GuidString": { "base": null, "refs": { "Attendee$AttendeeId": "The Amazon Chime SDK attendee ID.
", "AttendeeIdItem$AttendeeId": "A list of one or more attendee IDs.
", "BatchCreateAttendeeRequest$MeetingId": "The Amazon Chime SDK ID of the meeting to which you're adding attendees.
", "BatchUpdateAttendeeCapabilitiesExceptRequest$MeetingId": "The ID of the meeting associated with the update request.
", "CreateAttendeeRequest$MeetingId": "The unique ID of the meeting.
", "DeleteAttendeeRequest$MeetingId": "The Amazon Chime SDK meeting ID.
", "DeleteAttendeeRequest$AttendeeId": "The Amazon Chime SDK attendee ID.
", "DeleteMeetingRequest$MeetingId": "The Amazon Chime SDK meeting ID.
", "GetAttendeeRequest$MeetingId": "The Amazon Chime SDK meeting ID.
", "GetAttendeeRequest$AttendeeId": "The Amazon Chime SDK attendee ID.
", "GetMeetingRequest$MeetingId": "The Amazon Chime SDK meeting ID.
", "ListAttendeesRequest$MeetingId": "The Amazon Chime SDK meeting ID.
", "Meeting$MeetingId": "The Amazon Chime SDK meeting ID.
", "StartMeetingTranscriptionRequest$MeetingId": "The unique ID of the meeting being transcribed.
", "StopMeetingTranscriptionRequest$MeetingId": "The unique ID of the meeting for which you stop transcription.
", "UpdateAttendeeCapabilitiesRequest$MeetingId": "The ID of the meeting associated with the update request.
", "UpdateAttendeeCapabilitiesRequest$AttendeeId": "The ID of the attendee associated with the update request.
" } }, "JoinTokenString": { "base": null, "refs": { "Attendee$JoinToken": "The join token used by the Amazon Chime SDK attendee.
" } }, "LimitExceededException": { "base": "The request exceeds the resource limit.
", "refs": { } }, "ListAttendeesRequest": { "base": null, "refs": { } }, "ListAttendeesResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "MediaCapabilities": { "base": null, "refs": { "AttendeeCapabilities$Audio": "The audio capability assigned to an attendee.
", "AttendeeCapabilities$Video": "The video capability assigned to an attendee.
", "AttendeeCapabilities$Content": "The content capability assigned to an attendee.
" } }, "MediaPlacement": { "base": "A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
", "refs": { "Meeting$MediaPlacement": "The media placement for the meeting.
" } }, "MediaRegion": { "base": null, "refs": { "CreateMeetingRequest$MediaRegion": "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.
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.
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.
A meeting created using the Amazon Chime SDK.
", "refs": { "CreateMeetingResponse$Meeting": "The meeting information, including the meeting ID and MediaPlacement.
The meeting information, including the meeting ID and MediaPlacement.
The Amazon Chime SDK meeting information.
" } }, "MeetingFeatureStatus": { "base": null, "refs": { "AudioFeatures$EchoReduction": "Makes echo reduction available to clients who connect to the meeting.
" } }, "MeetingFeaturesConfiguration": { "base": "The configuration settings of the features available to a meeting.
", "refs": { "CreateMeetingRequest$MeetingFeatures": "Lists the audio and video features enabled for a meeting, such as echo reduction.
", "CreateMeetingWithAttendeesRequest$MeetingFeatures": "Lists the audio and video features enabled for a meeting, such as echo reduction.
", "Meeting$MeetingFeatures": "The features available to a meeting, such as echo reduction.
" } }, "NotFoundException": { "base": "One or more of the resources in the request does not exist in the system.
", "refs": { } }, "NotificationsConfiguration": { "base": "The configuration for resource targets to receive notifications when meeting and attendee events occur.
", "refs": { "CreateMeetingRequest$NotificationsConfiguration": "The configuration for resource targets to receive notifications when meeting and attendee events occur.
", "CreateMeetingWithAttendeesRequest$NotificationsConfiguration": "The configuration for resource targets to receive notifications when meeting and attendee events occur.
" } }, "PrimaryMeetingId": { "base": null, "refs": { "CreateMeetingRequest$PrimaryMeetingId": "When specified, replicates the media from the primary meeting to the new meeting.
", "CreateMeetingWithAttendeesRequest$PrimaryMeetingId": "When specified, replicates the media from the primary meeting to the new meeting.
", "Meeting$PrimaryMeetingId": "When specified, replicates the media from the primary meeting to this meeting.
" } }, "ResourceNotFoundException": { "base": "The resource that you want to tag couldn't be found.
", "refs": { } }, "ResultMax": { "base": null, "refs": { "ListAttendeesRequest$MaxResults": "The maximum number of results to return in a single call.
" } }, "RetryAfterSeconds": { "base": null, "refs": { "ServiceUnavailableException$RetryAfterSeconds": "The number of seconds the caller should wait before retrying.
" } }, "ServiceFailureException": { "base": "The service encountered an unexpected error.
", "refs": { } }, "ServiceUnavailableException": { "base": "The service is currently unavailable.
", "refs": { } }, "StartMeetingTranscriptionRequest": { "base": null, "refs": { } }, "StopMeetingTranscriptionRequest": { "base": null, "refs": { } }, "String": { "base": null, "refs": { "BadRequestException$Code": null, "BadRequestException$Message": null, "BadRequestException$RequestId": "The request id associated with the call responsible for the exception.
", "ConflictException$Code": null, "ConflictException$Message": null, "ConflictException$RequestId": "The ID of the request involved in the conflict.
", "CreateAttendeeError$ErrorCode": "The error code.
", "CreateAttendeeError$ErrorMessage": "The error message.
", "EngineTranscribeMedicalSettings$VocabularyName": "The name of the vocabulary passed to Amazon Transcribe Medical.
", "EngineTranscribeSettings$VocabularyFilterName": "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.
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.
The request id associated with the call responsible for the exception.
", "LimitExceededException$Code": null, "LimitExceededException$Message": null, "LimitExceededException$RequestId": "The request id associated with the call responsible for the exception.
", "ListAttendeesRequest$NextToken": "The token to use to retrieve the next page of results.
", "ListAttendeesResponse$NextToken": "The token to use to retrieve the next page of results.
", "MediaPlacement$AudioHostUrl": "The audio host URL.
", "MediaPlacement$AudioFallbackUrl": "The audio fallback URL.
", "MediaPlacement$SignalingUrl": "The signaling URL.
", "MediaPlacement$TurnControlUrl": "The turn control URL.
This parameter is deprecated and no longer used by the Amazon Chime SDK.
The screen data URL.
This parameter is deprecated and no longer used by the Amazon Chime SDK.
The screen viewing URL.
This parameter is deprecated and no longer used by the Amazon Chime SDK.
The screen sharing URL.
This parameter is deprecated and no longer used by the Amazon Chime SDK.
The event ingestion URL.
", "NotFoundException$Code": null, "NotFoundException$Message": null, "NotFoundException$RequestId": "The request ID associated with the call responsible for the exception.
", "ResourceNotFoundException$Code": null, "ResourceNotFoundException$Message": null, "ResourceNotFoundException$RequestId": "The ID of the resource that couldn't be found.
", "ServiceFailureException$Code": null, "ServiceFailureException$Message": null, "ServiceFailureException$RequestId": "The ID of the failed request.
", "ServiceUnavailableException$Code": null, "ServiceUnavailableException$Message": null, "ServiceUnavailableException$RequestId": "The request id associated with the call responsible for the exception.
", "ThrottlingException$Code": null, "ThrottlingException$Message": null, "ThrottlingException$RequestId": "The ID of the request that exceeded the throttling limit.
", "TooManyTagsException$Code": null, "TooManyTagsException$Message": null, "TooManyTagsException$RequestId": "The ID of the request that contains too many tags.
", "UnauthorizedException$Code": null, "UnauthorizedException$Message": null, "UnauthorizedException$RequestId": "The request id associated with the call responsible for the exception.
", "UnprocessableEntityException$Code": null, "UnprocessableEntityException$Message": null, "UnprocessableEntityException$RequestId": "The request id associated with the call responsible for the exception.
" } }, "Tag": { "base": "A key-value pair that you define.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The tag's key.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "The tag keys being removed from the resources.
" } }, "TagList": { "base": null, "refs": { "CreateMeetingRequest$Tags": "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.
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
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.
The tags in the request.
", "ListTagsForResourceResponse$Tags": "The tags requested for the specified resource.
", "TagResourceRequest$Tags": "Lists the requested tags.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$Value": "The tag's value.
" } }, "TenantId": { "base": null, "refs": { "TenantIdList$member": null } }, "TenantIdList": { "base": null, "refs": { "CreateMeetingRequest$TenantIds": "A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
", "CreateMeetingWithAttendeesRequest$TenantIds": "A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
", "Meeting$TenantIds": "Array of strings.
" } }, "ThrottlingException": { "base": "The number of customer requests exceeds the request rate limit.
", "refs": { } }, "TooManyTagsException": { "base": "Too many tags were added to the specified resource.
", "refs": { } }, "TranscribeContentIdentificationType": { "base": null, "refs": { "EngineTranscribeSettings$ContentIdentificationType": "Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.
You can’t set ContentIdentificationType and ContentRedactionType.
Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.
You can’t set ContentRedactionType and ContentIdentificationType.
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.
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.
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.
" } }, "TranscribeLanguageOptions": { "base": null, "refs": { "EngineTranscribeSettings$LanguageOptions": "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.
You can only include one language dialect per language. For example, you cannot include en-US and en-AU.
Set this field to PHI to identify personal health information in the transcription output.
The language code specified for the Amazon Transcribe Medical engine.
" } }, "TranscribeMedicalRegion": { "base": null, "refs": { "EngineTranscribeMedicalSettings$Region": "The Amazon Web Services Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
" } }, "TranscribeMedicalSpecialty": { "base": null, "refs": { "EngineTranscribeMedicalSettings$Specialty": "The specialty specified for the Amazon Transcribe Medical engine.
" } }, "TranscribeMedicalType": { "base": null, "refs": { "EngineTranscribeMedicalSettings$Type": "The type of transcription.
" } }, "TranscribePartialResultsStability": { "base": null, "refs": { "EngineTranscribeSettings$PartialResultsStability": "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.
" } }, "TranscribePiiEntityTypes": { "base": null, "refs": { "EngineTranscribeSettings$PiiEntityTypes": "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.
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.
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.
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.
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.
The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
The user isn't authorized to request a resource.
", "refs": { } }, "UnprocessableEntityException": { "base": "The request was well-formed but was unable to be followed due to semantic errors.
", "refs": { } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateAttendeeCapabilitiesRequest": { "base": null, "refs": { } }, "UpdateAttendeeCapabilitiesResponse": { "base": null, "refs": { } }, "VideoFeatures": { "base": "The video features set for the meeting. Applies to all attendees.
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.
The configuration settings for the video features available to a meeting.
" } }, "VideoResolution": { "base": null, "refs": { "VideoFeatures$MaxResolution": "The maximum video resolution for the meeting. Applies to all attendees.
Defaults to HD. To use FHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.