String externalUserId
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.
String attendeeId
The Amazon Chime SDK attendee ID.
String joinToken
The join token used by the Amazon Chime SDK attendee.
AttendeeCapabilities capabilities
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.
Integer maxCount
The maximum number of attendees allowed into the meeting.
String attendeeId
A list of one or more attendee IDs.
String echoReduction
Makes echo reduction available to clients who connect to the meeting.
String meetingId
The ID of the meeting associated with the update request.
List<E> excludedAttendeeIds
The AttendeeIDs that you want to exclude from one or more capabilities.
AttendeeCapabilities capabilities
The capabilities (audio, video, or content) that you want to update.
String 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.
String externalUserId
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.
String errorCode
The error code.
String errorMessage
The error message.
String meetingId
The unique ID of the meeting.
String externalUserId
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.
AttendeeCapabilities capabilities
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.
String externalUserId
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.
AttendeeCapabilities capabilities
A list of one or more capabilities.
Attendee attendee
The attendee information, including attendee ID and join token.
String clientRequestToken
The unique identifier for the client request. Use a different token for different meetings.
String 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.
String meetingHostId
Reserved.
String 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.
NotificationsConfiguration notificationsConfiguration
The configuration for resource targets to receive notifications when meeting and attendee events occur.
MeetingFeaturesConfiguration meetingFeatures
Lists the audio and video features enabled for a meeting, such as echo reduction.
String primaryMeetingId
When specified, replicates the media from the primary meeting to the new meeting.
List<E> tenantIds
A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
List<E> 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.
Meeting meeting
The meeting information, including the meeting ID and MediaPlacement.
String clientRequestToken
The unique identifier for the client request. Use a different token for different meetings.
String 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.
String meetingHostId
Reserved.
String 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.
MeetingFeaturesConfiguration meetingFeatures
Lists the audio and video features enabled for a meeting, such as echo reduction.
NotificationsConfiguration notificationsConfiguration
The configuration for resource targets to receive notifications when meeting and attendee events occur.
List<E> attendees
The attendee information, including attendees' IDs and join tokens.
String primaryMeetingId
When specified, replicates the media from the primary meeting to the new meeting.
List<E> tenantIds
A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
List<E> tags
The tags in the request.
Meeting meeting
The meeting information, including the meeting ID and MediaPlacement.
List<E> attendees
The attendee information, including attendees' IDs and join tokens.
List<E> 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.
String meetingId
The Amazon Chime SDK meeting ID.
String languageCode
The language code specified for the Amazon Transcribe Medical engine.
String specialty
The specialty specified for the Amazon Transcribe Medical engine.
String type
The type of transcription.
String vocabularyName
The name of the vocabulary passed to Amazon Transcribe Medical.
String 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.
String contentIdentificationType
Set this field to PHI to identify personal health information in the transcription output.
String languageCode
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.
String vocabularyFilterMethod
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.
String 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.
String vocabularyName
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.
String region
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.
Boolean enablePartialResultsStabilization
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
String 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.
String 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.
String 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.
String 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.
String languageModelName
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.
Boolean 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.
String 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.
String preferredLanguage
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.
String vocabularyNames
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.
String vocabularyFilterNames
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.
Attendee attendee
The Amazon Chime SDK attendee information.
String meetingId
The Amazon Chime SDK meeting ID.
Meeting meeting
The Amazon Chime SDK meeting information.
String resourceARN
The ARN of the resource.
String audioHostUrl
The audio host URL.
String audioFallbackUrl
The audio fallback URL.
String signalingUrl
The signaling URL.
String turnControlUrl
The turn control URL.
This parameter is deprecated and no longer used by the Amazon Chime SDK.
String screenDataUrl
The screen data URL.
This parameter is deprecated and no longer used by the Amazon Chime SDK.
String screenViewingUrl
The screen viewing URL.
This parameter is deprecated and no longer used by the Amazon Chime SDK.
String screenSharingUrl
The screen sharing URL.
This parameter is deprecated and no longer used by the Amazon Chime SDK.
String eventIngestionUrl
The event ingestion URL.
String meetingId
The Amazon Chime SDK meeting ID.
String meetingHostId
Reserved.
String 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.
String mediaRegion
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 mediaPlacement
The media placement for the meeting.
MeetingFeaturesConfiguration meetingFeatures
The features available to a meeting, such as echo reduction.
String primaryMeetingId
When specified, replicates the media from the primary meeting to this meeting.
List<E> tenantIds
Array of strings.
String meetingArn
The ARN of the meeting.
AudioFeatures audio
The configuration settings for the audio features available to a meeting.
VideoFeatures video
The configuration settings for the video features available to a meeting.
ContentFeatures content
The configuration settings for the content features available to a meeting.
AttendeeFeatures attendee
The configuration settings for the attendee features available to a meeting.
String meetingId
The unique ID of the meeting being transcribed.
TranscriptionConfiguration transcriptionConfiguration
The configuration for the current transcription operation. Must contain EngineTranscribeSettings or
EngineTranscribeMedicalSettings.
String meetingId
The unique ID of the meeting for which you stop transcription.
EngineTranscribeSettings engineTranscribeSettings
The transcription configuration settings passed to Amazon Transcribe.
EngineTranscribeMedicalSettings engineTranscribeMedicalSettings
The transcription configuration settings passed to Amazon Transcribe Medical.
String meetingId
The ID of the meeting associated with the update request.
String attendeeId
The ID of the attendee associated with the update request.
AttendeeCapabilities capabilities
The capabilities that you want to update.
Attendee attendee
The updated attendee data.
String 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.
Copyright © 2025. All rights reserved.