String externalUserId
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
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:
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 attendess can receive those streams, but only after media renegotiation between the
client and the Amazon Chime back-end server.
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 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.
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:
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 attendess 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.
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 AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.
String meetingHostId
Reserved.
String externalMeetingId
The external meeting ID.
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.
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 AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.
String meetingHostId
Reserved.
String externalMeetingId
The external meeting ID.
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.
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 AWS 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
The language code specified for the Amazon Transcribe engine.
String vocabularyFilterMethod
The filtering method passed to Amazon Transcribe.
String vocabularyFilterName
The name of the vocabulary filter passed to Amazon Transcribe.
String vocabularyName
The name of the vocabulary passed to Amazon Transcribe.
String region
The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.
Boolean enablePartialResultsStabilization
Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.
String partialResultsStability
The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.
String contentIdentificationType
Set this field to PII to identify personally identifiable information in the transcription output.
String contentRedactionType
Set this field to PII to redact personally identifiable information in the transcription output.
Content redaction is performed only upon complete transcription of the audio segments.
You can’t set ContentRedactionType and ContentIdentificationType in the same request.
If you set both, your request returns a BadRequestException.
String piiEntityTypes
Lists the PII entity types you want to identify or redact. To specify entity types, you must enable
ContentIdentificationType or ContentRedactionType.
PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER,
BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY,
PIN, EMAIL, ADDRESS, NAME, PHONE,
SSN, and ALL.
PiiEntityTypes is an optional parameter with a default value of ALL.
String languageModelName
The name of the language model used during transcription.
Boolean identifyLanguage
Automatically identifies the language spoken in media files.
String languageOptions
Language codes for the languages that you want to identify. You must provide at least 2 codes.
String preferredLanguage
Language code for the preferred language.
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 audioHostUrl
The audio host URL.
String audioFallbackUrl
The audio fallback URL.
String signalingUrl
The signaling URL.
String turnControlUrl
The turn control URL.
String screenDataUrl
The screen data URL.
String screenViewingUrl
The screen viewing URL.
String screenSharingUrl
The screen sharing URL.
String eventIngestionUrl
The event ingestion URL.
String meetingId
The Amazon Chime SDK meeting ID.
String meetingHostId
Reserved.
String externalMeetingId
The external meeting ID.
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 AWS 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 Amazon Voice Focus.
String primaryMeetingId
When specified, replicates the media from the primary meeting to this meeting.
List<E> tenantIds
Array of strings.
AudioFeatures audio
The configuration settings for the audio 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 capabilties that you want to update.
Attendee attendee
The updated attendee data.
Copyright © 2022. All rights reserved.