The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.
", "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.
", "CreateAttendee": "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.
", "StartMeetingTranscription": "Starts transcription for the specified meetingId.
Stops transcription for the specified meetingId.
The ARN of the AWS 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.
" } }, "AttendeeList": { "base": null, "refs": { "BatchCreateAttendeeResponse$Attendees": "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.
" } }, "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": { } }, "Boolean": { "base": null, "refs": { "EngineTranscribeSettings$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.
" } }, "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.
" } }, "CreateAttendeeError": { "base": "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 to the Amazon Transcribe engine.
", "refs": { "TranscriptionConfiguration$EngineTranscribeSettings": "The transcription configuration settings passed to Amazon Transcribe.
" } }, "ExternalMeetingId": { "base": null, "refs": { "CreateMeetingRequest$ExternalMeetingId": "The external meeting ID.
", "CreateMeetingWithAttendeesRequest$ExternalMeetingId": "The external meeting ID.
", "Meeting$ExternalMeetingId": "The external meeting ID.
" } }, "ExternalUserId": { "base": null, "refs": { "Attendee$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", "CreateAttendeeError$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", "CreateAttendeeRequest$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", "CreateAttendeeRequestItem$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", "CreateMeetingRequest$MeetingHostId": "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.
", "BatchCreateAttendeeRequest$MeetingId": "The Amazon Chime SDK ID of the meeting to which you're adding attendees.
", "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.
" } }, "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": { } }, "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 .
The Region in which to create the meeting.
", "Meeting$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.
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 Amazon Voice Focus.
" } }, "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.
" } }, "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.
" } }, "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.
", "CreateAttendeeError$ErrorCode": "The error code.
", "CreateAttendeeError$ErrorMessage": "The error message.
", "EngineTranscribeMedicalSettings$VocabularyName": "The name of the vocabulary passed to Amazon Transcribe Medical.
", "EngineTranscribeSettings$VocabularyFilterName": "The name of the vocabulary filter passed to Amazon Transcribe.
", "EngineTranscribeSettings$VocabularyName": "The name of the vocabulary passed to Amazon Transcribe.
", "ForbiddenException$Code": null, "ForbiddenException$Message": null, "ForbiddenException$RequestId": "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.
", "MediaPlacement$ScreenDataUrl": "The screen data URL.
", "MediaPlacement$ScreenViewingUrl": "The screen viewing URL.
", "MediaPlacement$ScreenSharingUrl": "The screen sharing URL.
", "MediaPlacement$EventIngestionUrl": "The event ingestion URL.
", "NotFoundException$Code": null, "NotFoundException$Message": null, "NotFoundException$RequestId": "The request id associated with the call responsible for the exception.
", "ServiceUnavailableException$Code": null, "ServiceUnavailableException$Message": null, "ServiceUnavailableException$RequestId": "The request id associated with the call responsible for the exception.
", "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.
" } }, "TranscribeContentIdentificationType": { "base": null, "refs": { "EngineTranscribeSettings$ContentIdentificationType": "Set this field to PII to identify personally identifiable information in the transcription output.
Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.
You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.
The language code specified for the Amazon Transcribe engine.
" } }, "TranscribeLanguageModelName": { "base": null, "refs": { "EngineTranscribeSettings$LanguageModelName": "The name of the language model used during transcription.
" } }, "TranscribeMedicalContentIdentificationType": { "base": null, "refs": { "EngineTranscribeMedicalSettings$ContentIdentificationType": "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 AWS 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": "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.
" } }, "TranscribePiiEntityTypes": { "base": null, "refs": { "EngineTranscribeSettings$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.
The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.
" } }, "TranscribeVocabularyFilterMethod": { "base": null, "refs": { "EngineTranscribeSettings$VocabularyFilterMethod": "The filtering method passed to Amazon Transcribe.
" } }, "TranscriptionConfiguration": { "base": "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": { } } } }