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":{ "name":"BatchUpdateAttendeeCapabilitiesExcept", "http":{ "method":"PUT", "requestUri":"/meetings/{MeetingId}/attendees/capabilities?operation=batch-update-except", "responseCode":200 }, "input":{"shape":"BatchUpdateAttendeeCapabilitiesExceptRequest"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"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:
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.
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":{ "name":"CreateMeeting", "http":{ "method":"POST", "requestUri":"/meetings" }, "input":{"shape":"CreateMeetingRequest"}, "output":{"shape":"CreateMeetingResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceFailureException"}, {"shape":"ServiceUnavailableException"}, {"shape":"LimitExceededException"} ], "documentation":"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":{ "name":"CreateMeetingWithAttendees", "http":{ "method":"POST", "requestUri":"/meetings?operation=create-attendees" }, "input":{"shape":"CreateMeetingWithAttendeesRequest"}, "output":{"shape":"CreateMeetingWithAttendeesResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceFailureException"}, {"shape":"ServiceUnavailableException"}, {"shape":"LimitExceededException"} ], "documentation":"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":{ "name":"DeleteAttendee", "http":{ "method":"DELETE", "requestUri":"/meetings/{MeetingId}/attendees/{AttendeeId}", "responseCode":204 }, "input":{"shape":"DeleteAttendeeRequest"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"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":{ "name":"GetAttendee", "http":{ "method":"GET", "requestUri":"/meetings/{MeetingId}/attendees/{AttendeeId}" }, "input":{"shape":"GetAttendeeRequest"}, "output":{"shape":"GetAttendeeResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"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":{ "name":"GetMeeting", "http":{ "method":"GET", "requestUri":"/meetings/{MeetingId}" }, "input":{"shape":"GetMeetingRequest"}, "output":{"shape":"GetMeetingResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"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":{ "name":"ListAttendees", "http":{ "method":"GET", "requestUri":"/meetings/{MeetingId}/attendees", "responseCode":200 }, "input":{"shape":"ListAttendeesRequest"}, "output":{"shape":"ListAttendeesResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"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":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a list of the tags available for the specified resource.
" }, "StartMeetingTranscription":{ "name":"StartMeetingTranscription", "http":{ "method":"POST", "requestUri":"/meetings/{MeetingId}/transcription?operation=start", "responseCode":200 }, "input":{"shape":"StartMeetingTranscriptionRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"LimitExceededException"}, {"shape":"UnprocessableEntityException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"Starts transcription for the specified meetingId.
Stops transcription for the specified meetingId.
The resource that supports tags.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/tags?operation=untag-resource", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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 AWS Region for the calling AWS 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 capabilties 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:
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.
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" }, "AttendeeId":{ "shape":"GuidString", "documentation":"The Amazon Chime SDK attendee ID.
" }, "JoinToken":{ "shape":"JoinTokenString", "documentation":"The join token used by the Amazon Chime SDK attendee.
" }, "Capabilities":{ "shape":"AttendeeCapabilities", "documentation":"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.
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 audio capability assigned to an attendee.
" }, "Video":{ "shape":"MediaCapabilities", "documentation":"The video capability assigned to an attendee.
" }, "Content":{ "shape":"MediaCapabilities", "documentation":"The content capability assigned to an attendee.
" } }, "documentation":"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 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.
A list of one or more attendee IDs.
" } }, "documentation":"A structure that contains one or more attendee IDs.
" }, "AttendeeIdsList":{ "type":"list", "member":{"shape":"AttendeeIdItem"}, "max":250, "min":1 }, "AttendeeList":{ "type":"list", "member":{"shape":"Attendee"} }, "AudioFeatures":{ "type":"structure", "members":{ "EchoReduction":{ "shape":"MeetingFeatureStatus", "documentation":"Makes echo reduction available to clients who connect to the meeting.
" } }, "documentation":"An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.
" }, "BadRequestException":{ "type":"structure", "members":{ "Code":{"shape":"String"}, "Message":{"shape":"String"}, "RequestId":{ "shape":"String", "documentation":"The request id associated with the call responsible for the exception.
" } }, "documentation":"The input parameters don't match the service's restrictions.
", "error":{"httpStatusCode":400}, "exception":true }, "BatchCreateAttendeeErrorList":{ "type":"list", "member":{"shape":"CreateAttendeeError"} }, "BatchCreateAttendeeRequest":{ "type":"structure", "required":[ "MeetingId", "Attendees" ], "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The Amazon Chime SDK ID of the meeting to which you're adding attendees.
", "location":"uri", "locationName":"MeetingId" }, "Attendees":{ "shape":"CreateAttendeeRequestItemList", "documentation":"The attendee information, including attendees' IDs and join tokens.
" } } }, "BatchCreateAttendeeResponse":{ "type":"structure", "members":{ "Attendees":{ "shape":"AttendeeList", "documentation":"The attendee information, including attendees' IDs and join tokens.
" }, "Errors":{ "shape":"BatchCreateAttendeeErrorList", "documentation":"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.
" } } }, "BatchUpdateAttendeeCapabilitiesExceptRequest":{ "type":"structure", "required":[ "MeetingId", "ExcludedAttendeeIds", "Capabilities" ], "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The ID of the meeting associated with the update request.
", "location":"uri", "locationName":"MeetingId" }, "ExcludedAttendeeIds":{ "shape":"AttendeeIdsList", "documentation":"The AttendeeIDs that you want to exclude from one or more capabilities.
The capabilities (audio, video, or content) that you want to update.
The ID of the request involved in the conflict.
" } }, "documentation":"Multiple instances of the same request have been made simultaneously.
", "error":{"httpStatusCode":409}, "exception":true }, "CreateAttendeeError":{ "type":"structure", "members":{ "ExternalUserId":{ "shape":"ExternalUserId", "documentation":"The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" }, "ErrorCode":{ "shape":"String", "documentation":"The error code.
" }, "ErrorMessage":{ "shape":"String", "documentation":"The error message.
" } }, "documentation":"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.
" }, "CreateAttendeeRequest":{ "type":"structure", "required":[ "MeetingId", "ExternalUserId" ], "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The unique ID of the meeting.
", "location":"uri", "locationName":"MeetingId" }, "ExternalUserId":{ "shape":"ExternalUserId", "documentation":"The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" }, "Capabilities":{ "shape":"AttendeeCapabilities", "documentation":"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.
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" }, "Capabilities":{ "shape":"AttendeeCapabilities", "documentation":"A list of one or more capabilities.
" } }, "documentation":"The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
" }, "CreateAttendeeRequestItemList":{ "type":"list", "member":{"shape":"CreateAttendeeRequestItem"}, "max":100, "min":1 }, "CreateAttendeeResponse":{ "type":"structure", "members":{ "Attendee":{ "shape":"Attendee", "documentation":"The attendee information, including attendee ID and join token.
" } } }, "CreateMeetingRequest":{ "type":"structure", "required":[ "ClientRequestToken", "MediaRegion", "ExternalMeetingId" ], "members":{ "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"The unique identifier for the client request. Use a different token for different meetings.
", "idempotencyToken":true }, "MediaRegion":{ "shape":"MediaRegion", "documentation":"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.
Reserved.
" }, "ExternalMeetingId":{ "shape":"ExternalMeetingId", "documentation":"The external meeting ID.
" }, "NotificationsConfiguration":{ "shape":"NotificationsConfiguration", "documentation":"The configuration for resource targets to receive notifications when meeting and attendee events occur.
" }, "MeetingFeatures":{ "shape":"MeetingFeaturesConfiguration", "documentation":"Lists the audio and video features enabled for a meeting, such as echo reduction.
" }, "PrimaryMeetingId":{ "shape":"PrimaryMeetingId", "documentation":"When specified, replicates the media from the primary meeting to the new meeting.
" }, "TenantIds":{ "shape":"TenantIdList", "documentation":"A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
" }, "Tags":{ "shape":"TagList", "documentation":"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 AWS Region for the AWS 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 meeting information, including the meeting ID and MediaPlacement.
The unique identifier for the client request. Use a different token for different meetings.
", "idempotencyToken":true }, "MediaRegion":{ "shape":"MediaRegion", "documentation":"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.
Reserved.
" }, "ExternalMeetingId":{ "shape":"ExternalMeetingId", "documentation":"The external meeting ID.
" }, "MeetingFeatures":{ "shape":"MeetingFeaturesConfiguration", "documentation":"Lists the audio and video features enabled for a meeting, such as echo reduction.
" }, "NotificationsConfiguration":{ "shape":"NotificationsConfiguration", "documentation":"The configuration for resource targets to receive notifications when meeting and attendee events occur.
" }, "Attendees":{ "shape":"CreateMeetingWithAttendeesRequestItemList", "documentation":"The attendee information, including attendees' IDs and join tokens.
" }, "PrimaryMeetingId":{ "shape":"PrimaryMeetingId", "documentation":"When specified, replicates the media from the primary meeting to the new meeting.
" }, "TenantIds":{ "shape":"TenantIdList", "documentation":"A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
" }, "Tags":{ "shape":"TagList", "documentation":"The tags in the request.
" } } }, "CreateMeetingWithAttendeesRequestItemList":{ "type":"list", "member":{"shape":"CreateAttendeeRequestItem"}, "max":20, "min":1 }, "CreateMeetingWithAttendeesResponse":{ "type":"structure", "members":{ "Meeting":{ "shape":"Meeting", "documentation":"The meeting information, including the meeting ID and MediaPlacement.
The attendee information, including attendees' IDs and join tokens.
" }, "Errors":{ "shape":"BatchCreateAttendeeErrorList", "documentation":"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.
" } } }, "DeleteAttendeeRequest":{ "type":"structure", "required":[ "MeetingId", "AttendeeId" ], "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The Amazon Chime SDK meeting ID.
", "location":"uri", "locationName":"MeetingId" }, "AttendeeId":{ "shape":"GuidString", "documentation":"The Amazon Chime SDK attendee ID.
", "location":"uri", "locationName":"AttendeeId" } } }, "DeleteMeetingRequest":{ "type":"structure", "required":["MeetingId"], "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The Amazon Chime SDK meeting ID.
", "location":"uri", "locationName":"MeetingId" } } }, "EngineTranscribeMedicalSettings":{ "type":"structure", "required":[ "LanguageCode", "Specialty", "Type" ], "members":{ "LanguageCode":{ "shape":"TranscribeMedicalLanguageCode", "documentation":"The language code specified for the Amazon Transcribe Medical engine.
" }, "Specialty":{ "shape":"TranscribeMedicalSpecialty", "documentation":"The specialty specified for the Amazon Transcribe Medical engine.
" }, "Type":{ "shape":"TranscribeMedicalType", "documentation":"The type of transcription.
" }, "VocabularyName":{ "shape":"String", "documentation":"The name of the vocabulary passed to Amazon Transcribe Medical.
" }, "Region":{ "shape":"TranscribeMedicalRegion", "documentation":"The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
" }, "ContentIdentificationType":{ "shape":"TranscribeMedicalContentIdentificationType", "documentation":"Set this field to PHI to identify personal health information in the transcription output.
Settings specific to the Amazon Transcribe Medical engine.
" }, "EngineTranscribeSettings":{ "type":"structure", "members":{ "LanguageCode":{ "shape":"TranscribeLanguageCode", "documentation":"The language code specified for the Amazon Transcribe engine.
" }, "VocabularyFilterMethod":{ "shape":"TranscribeVocabularyFilterMethod", "documentation":"The filtering method passed to Amazon Transcribe.
" }, "VocabularyFilterName":{ "shape":"String", "documentation":"The name of the vocabulary filter passed to Amazon Transcribe.
" }, "VocabularyName":{ "shape":"String", "documentation":"The name of the vocabulary passed to Amazon Transcribe.
" }, "Region":{ "shape":"TranscribeRegion", "documentation":"The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.
" }, "EnablePartialResultsStabilization":{ "shape":"Boolean", "documentation":"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.
" }, "PartialResultsStability":{ "shape":"TranscribePartialResultsStability", "documentation":"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.
" }, "ContentIdentificationType":{ "shape":"TranscribeContentIdentificationType", "documentation":"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.
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 name of the language model used during transcription.
" }, "IdentifyLanguage":{ "shape":"Boolean", "documentation":"Automatically identifies the language spoken in media files.
" }, "LanguageOptions":{ "shape":"TranscribeLanguageOptions", "documentation":"Language codes for the languages that you want to identify. You must provide at least 2 codes.
" }, "PreferredLanguage":{ "shape":"TranscribeLanguageCode", "documentation":"Language code for the preferred language.
" } }, "documentation":"Settings specific to the Amazon Transcribe engine.
" }, "ExternalMeetingId":{ "type":"string", "max":64, "min":2, "sensitive":true }, "ExternalUserId":{ "type":"string", "max":64, "min":2, "sensitive":true }, "ForbiddenException":{ "type":"structure", "members":{ "Code":{"shape":"String"}, "Message":{"shape":"String"}, "RequestId":{ "shape":"String", "documentation":"The request id associated with the call responsible for the exception.
" } }, "documentation":"The client is permanently forbidden from making the request.
", "error":{"httpStatusCode":403}, "exception":true }, "GetAttendeeRequest":{ "type":"structure", "required":[ "MeetingId", "AttendeeId" ], "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The Amazon Chime SDK meeting ID.
", "location":"uri", "locationName":"MeetingId" }, "AttendeeId":{ "shape":"GuidString", "documentation":"The Amazon Chime SDK attendee ID.
", "location":"uri", "locationName":"AttendeeId" } } }, "GetAttendeeResponse":{ "type":"structure", "members":{ "Attendee":{ "shape":"Attendee", "documentation":"The Amazon Chime SDK attendee information.
" } } }, "GetMeetingRequest":{ "type":"structure", "required":["MeetingId"], "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The Amazon Chime SDK meeting ID.
", "location":"uri", "locationName":"MeetingId" } } }, "GetMeetingResponse":{ "type":"structure", "members":{ "Meeting":{ "shape":"Meeting", "documentation":"The Amazon Chime SDK meeting information.
" } } }, "GuidString":{ "type":"string", "pattern":"[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}" }, "JoinTokenString":{ "type":"string", "max":2048, "min":2, "sensitive":true }, "LimitExceededException":{ "type":"structure", "members":{ "Code":{"shape":"String"}, "Message":{"shape":"String"}, "RequestId":{ "shape":"String", "documentation":"The request id associated with the call responsible for the exception.
" } }, "documentation":"The request exceeds the resource limit.
", "error":{"httpStatusCode":400}, "exception":true }, "ListAttendeesRequest":{ "type":"structure", "required":["MeetingId"], "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The Amazon Chime SDK meeting ID.
", "location":"uri", "locationName":"MeetingId" }, "NextToken":{ "shape":"String", "documentation":"The token to use to retrieve the next page of results.
", "location":"querystring", "locationName":"next-token" }, "MaxResults":{ "shape":"ResultMax", "documentation":"The maximum number of results to return in a single call.
", "location":"querystring", "locationName":"max-results" } } }, "ListAttendeesResponse":{ "type":"structure", "members":{ "Attendees":{ "shape":"AttendeeList", "documentation":"The Amazon Chime SDK attendee information.
" }, "NextToken":{ "shape":"String", "documentation":"The token to use to retrieve the next page of results.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceARN"], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"The ARN of the resource.
", "location":"querystring", "locationName":"arn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"The tags requested for the specified resource.
" } } }, "MediaCapabilities":{ "type":"string", "enum":[ "SendReceive", "Send", "Receive", "None" ] }, "MediaPlacement":{ "type":"structure", "members":{ "AudioHostUrl":{ "shape":"String", "documentation":"The audio host URL.
" }, "AudioFallbackUrl":{ "shape":"String", "documentation":"The audio fallback URL.
" }, "SignalingUrl":{ "shape":"String", "documentation":"The signaling URL.
" }, "TurnControlUrl":{ "shape":"String", "documentation":"The turn control URL.
" }, "ScreenDataUrl":{ "shape":"String", "documentation":"The screen data URL.
" }, "ScreenViewingUrl":{ "shape":"String", "documentation":"The screen viewing URL.
" }, "ScreenSharingUrl":{ "shape":"String", "documentation":"The screen sharing URL.
" }, "EventIngestionUrl":{ "shape":"String", "documentation":"The event ingestion URL.
" } }, "documentation":"A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
" }, "MediaRegion":{ "type":"string", "max":64, "min":2 }, "Meeting":{ "type":"structure", "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The Amazon Chime SDK meeting ID.
" }, "MeetingHostId":{ "shape":"ExternalUserId", "documentation":"Reserved.
" }, "ExternalMeetingId":{ "shape":"ExternalMeetingId", "documentation":"The external meeting ID.
" }, "MediaRegion":{ "shape":"MediaRegion", "documentation":"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.
The media placement for the meeting.
" }, "MeetingFeatures":{ "shape":"MeetingFeaturesConfiguration", "documentation":"The features available to a meeting, such as Amazon Voice Focus.
" }, "PrimaryMeetingId":{ "shape":"PrimaryMeetingId", "documentation":"When specified, replicates the media from the primary meeting to this meeting.
" }, "TenantIds":{ "shape":"TenantIdList", "documentation":"Array of strings.
" }, "MeetingArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the meeting.
" } }, "documentation":"A meeting created using the Amazon Chime SDK.
" }, "MeetingFeatureStatus":{ "type":"string", "enum":[ "AVAILABLE", "UNAVAILABLE" ] }, "MeetingFeaturesConfiguration":{ "type":"structure", "members":{ "Audio":{ "shape":"AudioFeatures", "documentation":"The configuration settings for the audio features available to a meeting.
" } }, "documentation":"The configuration settings of the features available to a meeting.>
" }, "NotFoundException":{ "type":"structure", "members":{ "Code":{"shape":"String"}, "Message":{"shape":"String"}, "RequestId":{ "shape":"String", "documentation":"The request ID associated with the call responsible for the exception.
" } }, "documentation":"One or more of the resources in the request does not exist in the system.
", "error":{"httpStatusCode":404}, "exception":true }, "NotificationsConfiguration":{ "type":"structure", "members":{ "LambdaFunctionArn":{ "shape":"Arn", "documentation":"The ARN of the AWS Lambda function in the notifications configuration.
" }, "SnsTopicArn":{ "shape":"Arn", "documentation":"The ARN of the SNS topic.
" }, "SqsQueueArn":{ "shape":"Arn", "documentation":"The ARN of the SQS queue.
" } }, "documentation":"The configuration for resource targets to receive notifications when meeting and attendee events occur.
" }, "PrimaryMeetingId":{ "type":"string", "max":64, "min":2 }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Code":{"shape":"String"}, "Message":{"shape":"String"}, "RequestId":{ "shape":"String", "documentation":"The ID of the resource that couldn't be found.
" }, "ResourceName":{ "shape":"AmazonResourceName", "documentation":"The name of the resource that couldn't be found.
" } }, "documentation":"The resource that you want to tag couldn't be found.
", "error":{"httpStatusCode":404}, "exception":true }, "ResultMax":{ "type":"integer", "max":100, "min":1 }, "RetryAfterSeconds":{"type":"string"}, "ServiceFailureException":{ "type":"structure", "members":{ "Code":{"shape":"String"}, "Message":{"shape":"String"}, "RequestId":{ "shape":"String", "documentation":"The ID of the failed request.
" } }, "documentation":"The service encountered an unexpected error.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ServiceUnavailableException":{ "type":"structure", "members":{ "Code":{"shape":"String"}, "Message":{"shape":"String"}, "RequestId":{ "shape":"String", "documentation":"The request id associated with the call responsible for the exception.
" }, "RetryAfterSeconds":{ "shape":"RetryAfterSeconds", "documentation":"The number of seconds the caller should wait before retrying.
", "location":"header", "locationName":"Retry-After" } }, "documentation":"The service is currently unavailable.
", "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "StartMeetingTranscriptionRequest":{ "type":"structure", "required":[ "MeetingId", "TranscriptionConfiguration" ], "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The unique ID of the meeting being transcribed.
", "location":"uri", "locationName":"MeetingId" }, "TranscriptionConfiguration":{ "shape":"TranscriptionConfiguration", "documentation":"The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
The unique ID of the meeting for which you stop transcription.
", "location":"uri", "locationName":"MeetingId" } } }, "String":{ "type":"string", "max":4096 }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"The tag's key.
" }, "Value":{ "shape":"TagValue", "documentation":"The tag's value.
" } }, "documentation":"A key-value pair that you define.
" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":0 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "Tags" ], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"The ARN of the resource.
" }, "Tags":{ "shape":"TagList", "documentation":"Lists the requested tags.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"[\\s\\w+-=\\.:/@]*" }, "TenantId":{ "type":"string", "max":256, "min":2, "pattern":"^(?!.*?(.)\\1{3})[-_!@#$a-zA-Z0-9]*$" }, "TenantIdList":{ "type":"list", "member":{"shape":"TenantId"}, "max":5, "min":1 }, "ThrottlingException":{ "type":"structure", "members":{ "Code":{"shape":"String"}, "Message":{"shape":"String"}, "RequestId":{ "shape":"String", "documentation":"The ID of the request that exceeded the throttling limit.
" } }, "documentation":"The number of customer requests exceeds the request rate limit.
", "error":{"httpStatusCode":429}, "exception":true }, "TooManyTagsException":{ "type":"structure", "members":{ "Code":{"shape":"String"}, "Message":{"shape":"String"}, "RequestId":{ "shape":"String", "documentation":"The ID of the request that contains too many tags.
" }, "ResourceName":{ "shape":"AmazonResourceName", "documentation":"The name of the resource that received too many tags.
" } }, "documentation":"Too many tags were added to the specified resource.
", "error":{"httpStatusCode":400}, "exception":true }, "TranscribeContentIdentificationType":{ "type":"string", "enum":["PII"] }, "TranscribeContentRedactionType":{ "type":"string", "enum":["PII"] }, "TranscribeLanguageCode":{ "type":"string", "enum":[ "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN" ] }, "TranscribeLanguageModelName":{ "type":"string", "max":200, "min":1, "pattern":"^[0-9a-zA-Z._-]+" }, "TranscribeLanguageOptions":{ "type":"string", "max":200, "min":1, "pattern":"^[a-zA-Z-,]+" }, "TranscribeMedicalContentIdentificationType":{ "type":"string", "enum":["PHI"] }, "TranscribeMedicalLanguageCode":{ "type":"string", "enum":["en-US"] }, "TranscribeMedicalRegion":{ "type":"string", "enum":[ "us-east-1", "us-east-2", "us-west-2", "ap-southeast-2", "ca-central-1", "eu-west-1", "auto" ] }, "TranscribeMedicalSpecialty":{ "type":"string", "enum":[ "PRIMARYCARE", "CARDIOLOGY", "NEUROLOGY", "ONCOLOGY", "RADIOLOGY", "UROLOGY" ] }, "TranscribeMedicalType":{ "type":"string", "enum":[ "CONVERSATION", "DICTATION" ] }, "TranscribePartialResultsStability":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "TranscribePiiEntityTypes":{ "type":"string", "max":300, "min":1, "pattern":"^[A-Z_, ]+" }, "TranscribeRegion":{ "type":"string", "enum":[ "us-east-2", "us-east-1", "us-west-2", "ap-northeast-2", "ap-southeast-2", "ap-northeast-1", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "sa-east-1", "auto", "us-gov-west-1" ] }, "TranscribeVocabularyFilterMethod":{ "type":"string", "enum":[ "remove", "mask", "tag" ] }, "TranscriptionConfiguration":{ "type":"structure", "members":{ "EngineTranscribeSettings":{ "shape":"EngineTranscribeSettings", "documentation":"The transcription configuration settings passed to Amazon Transcribe.
" }, "EngineTranscribeMedicalSettings":{ "shape":"EngineTranscribeMedicalSettings", "documentation":"The transcription configuration settings passed to Amazon Transcribe Medical.
" } }, "documentation":"The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
The request id associated with the call responsible for the exception.
" } }, "documentation":"The user isn't authorized to request a resource.
", "error":{"httpStatusCode":401}, "exception":true }, "UnprocessableEntityException":{ "type":"structure", "members":{ "Code":{"shape":"String"}, "Message":{"shape":"String"}, "RequestId":{ "shape":"String", "documentation":"The request id associated with the call responsible for the exception.
" } }, "documentation":"The request was well-formed but was unable to be followed due to semantic errors.
", "error":{"httpStatusCode":422}, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "TagKeys" ], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"The ARN of the resource that you're removing tags from.
" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"The tag keys being removed from the resources.
" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateAttendeeCapabilitiesRequest":{ "type":"structure", "required":[ "MeetingId", "AttendeeId", "Capabilities" ], "members":{ "MeetingId":{ "shape":"GuidString", "documentation":"The ID of the meeting associated with the update request.
", "location":"uri", "locationName":"MeetingId" }, "AttendeeId":{ "shape":"GuidString", "documentation":"The ID of the attendee associated with the update request.
", "location":"uri", "locationName":"AttendeeId" }, "Capabilities":{ "shape":"AttendeeCapabilities", "documentation":"The capabilties that you want to update.
" } } }, "UpdateAttendeeCapabilitiesResponse":{ "type":"structure", "members":{ "Attendee":{ "shape":"Attendee", "documentation":"The updated attendee data.
" } } } }, "documentation":"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.
" }