{ "version":"2.0", "metadata":{ "apiVersion":"2022-08-03", "endpointPrefix":"voice-chime", "protocol":"rest-json", "serviceFullName":"Amazon Chime SDK Voice", "serviceId":"Chime SDK Voice", "signatureVersion":"v4", "signingName":"chime", "uid":"chime-sdk-voice-2022-08-03" }, "operations":{ "AssociatePhoneNumbersWithVoiceConnector":{ "name":"AssociatePhoneNumbersWithVoiceConnector", "http":{ "method":"POST", "requestUri":"/voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers", "responseCode":200 }, "input":{"shape":"AssociatePhoneNumbersWithVoiceConnectorRequest"}, "output":{"shape":"AssociatePhoneNumbersWithVoiceConnectorResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

" }, "AssociatePhoneNumbersWithVoiceConnectorGroup":{ "name":"AssociatePhoneNumbersWithVoiceConnectorGroup", "http":{ "method":"POST", "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}?operation=associate-phone-numbers", "responseCode":200 }, "input":{"shape":"AssociatePhoneNumbersWithVoiceConnectorGroupRequest"}, "output":{"shape":"AssociatePhoneNumbersWithVoiceConnectorGroupResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

" }, "BatchDeletePhoneNumber":{ "name":"BatchDeletePhoneNumber", "http":{ "method":"POST", "requestUri":"/phone-numbers?operation=batch-delete", "responseCode":200 }, "input":{"shape":"BatchDeletePhoneNumberRequest"}, "output":{"shape":"BatchDeletePhoneNumberResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

" }, "BatchUpdatePhoneNumber":{ "name":"BatchUpdatePhoneNumber", "http":{ "method":"POST", "requestUri":"/phone-numbers?operation=batch-update", "responseCode":200 }, "input":{"shape":"BatchUpdatePhoneNumberRequest"}, "output":{"shape":"BatchUpdatePhoneNumberResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates one or more phone numbers.

" }, "CreatePhoneNumberOrder":{ "name":"CreatePhoneNumberOrder", "http":{ "method":"POST", "requestUri":"/phone-number-orders", "responseCode":201 }, "input":{"shape":"CreatePhoneNumberOrderRequest"}, "output":{"shape":"CreatePhoneNumberOrderResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ThrottledClientException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

" }, "CreateProxySession":{ "name":"CreateProxySession", "http":{ "method":"POST", "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions", "responseCode":201 }, "input":{"shape":"CreateProxySessionRequest"}, "output":{"shape":"CreateProxySessionResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

" }, "CreateSipMediaApplication":{ "name":"CreateSipMediaApplication", "http":{ "method":"POST", "requestUri":"/sip-media-applications", "responseCode":201 }, "input":{"shape":"CreateSipMediaApplicationRequest"}, "output":{"shape":"CreateSipMediaApplicationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ThrottledClientException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ConflictException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

" }, "CreateSipMediaApplicationCall":{ "name":"CreateSipMediaApplicationCall", "http":{ "method":"POST", "requestUri":"/sip-media-applications/{sipMediaApplicationId}/calls", "responseCode":201 }, "input":{"shape":"CreateSipMediaApplicationCallRequest"}, "output":{"shape":"CreateSipMediaApplicationCallResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ThrottledClientException"}, {"shape":"UnauthorizedClientException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified `sipMediaApplicationId`.

" }, "CreateSipRule":{ "name":"CreateSipRule", "http":{ "method":"POST", "requestUri":"/sip-rules", "responseCode":201 }, "input":{"shape":"CreateSipRuleRequest"}, "output":{"shape":"CreateSipRuleResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ThrottledClientException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ConflictException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

" }, "CreateVoiceConnector":{ "name":"CreateVoiceConnector", "http":{ "method":"POST", "requestUri":"/voice-connectors", "responseCode":201 }, "input":{"shape":"CreateVoiceConnectorRequest"}, "output":{"shape":"CreateVoiceConnectorResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ThrottledClientException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

" }, "CreateVoiceConnectorGroup":{ "name":"CreateVoiceConnectorGroup", "http":{ "method":"POST", "requestUri":"/voice-connector-groups", "responseCode":201 }, "input":{"shape":"CreateVoiceConnectorGroupRequest"}, "output":{"shape":"CreateVoiceConnectorGroupResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ThrottledClientException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including `VoiceConnectorItems` in the request.

You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

" }, "CreateVoiceProfile":{ "name":"CreateVoiceProfile", "http":{ "method":"POST", "requestUri":"/voice-profiles", "responseCode":201 }, "input":{"shape":"CreateVoiceProfileRequest"}, "output":{"shape":"CreateVoiceProfileResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"GoneException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a voice profile, which consists of an enrolled user and their latest voice print.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

" }, "CreateVoiceProfileDomain":{ "name":"CreateVoiceProfileDomain", "http":{ "method":"POST", "requestUri":"/voice-profile-domains", "responseCode":201 }, "input":{"shape":"CreateVoiceProfileDomainRequest"}, "output":{"shape":"CreateVoiceProfileDomainResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ThrottledClientException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

" }, "DeletePhoneNumber":{ "name":"DeletePhoneNumber", "http":{ "method":"DELETE", "requestUri":"/phone-numbers/{phoneNumberId}", "responseCode":204 }, "input":{"shape":"DeletePhoneNumberRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime SDK Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue queue for 7 days before they are deleted permanently.

" }, "DeleteProxySession":{ "name":"DeleteProxySession", "http":{ "method":"DELETE", "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", "responseCode":204 }, "input":{"shape":"DeleteProxySessionRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.

" }, "DeleteSipMediaApplication":{ "name":"DeleteSipMediaApplication", "http":{ "method":"DELETE", "requestUri":"/sip-media-applications/{sipMediaApplicationId}", "responseCode":204 }, "input":{"shape":"DeleteSipMediaApplicationRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes a SIP media application.

" }, "DeleteSipRule":{ "name":"DeleteSipRule", "http":{ "method":"DELETE", "requestUri":"/sip-rules/{sipRuleId}", "responseCode":204 }, "input":{"shape":"DeleteSipRuleRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes a SIP rule.

" }, "DeleteVoiceConnector":{ "name":"DeleteVoiceConnector", "http":{ "method":"DELETE", "requestUri":"/voice-connectors/{voiceConnectorId}", "responseCode":204 }, "input":{"shape":"DeleteVoiceConnectorRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.

" }, "DeleteVoiceConnectorEmergencyCallingConfiguration":{ "name":"DeleteVoiceConnectorEmergencyCallingConfiguration", "http":{ "method":"DELETE", "requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration", "responseCode":204 }, "input":{"shape":"DeleteVoiceConnectorEmergencyCallingConfigurationRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.

" }, "DeleteVoiceConnectorGroup":{ "name":"DeleteVoiceConnectorGroup", "http":{ "method":"DELETE", "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}", "responseCode":204 }, "input":{"shape":"DeleteVoiceConnectorGroupRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes an Amazon Chime SDK Voice Connector group. Any `VoiceConnectorItems` and phone numbers associated with the group must be removed before it can be deleted.

" }, "DeleteVoiceConnectorOrigination":{ "name":"DeleteVoiceConnectorOrigination", "http":{ "method":"DELETE", "requestUri":"/voice-connectors/{voiceConnectorId}/origination", "responseCode":204 }, "input":{"shape":"DeleteVoiceConnectorOriginationRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.

If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.

" }, "DeleteVoiceConnectorProxy":{ "name":"DeleteVoiceConnectorProxy", "http":{ "method":"DELETE", "requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy", "responseCode":204 }, "input":{"shape":"DeleteVoiceConnectorProxyRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.

" }, "DeleteVoiceConnectorStreamingConfiguration":{ "name":"DeleteVoiceConnectorStreamingConfiguration", "http":{ "method":"DELETE", "requestUri":"/voice-connectors/{voiceConnectorId}/streaming-configuration", "responseCode":204 }, "input":{"shape":"DeleteVoiceConnectorStreamingConfigurationRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes a Voice Connector's streaming configuration.

" }, "DeleteVoiceConnectorTermination":{ "name":"DeleteVoiceConnectorTermination", "http":{ "method":"DELETE", "requestUri":"/voice-connectors/{voiceConnectorId}/termination", "responseCode":204 }, "input":{"shape":"DeleteVoiceConnectorTerminationRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.

If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.

" }, "DeleteVoiceConnectorTerminationCredentials":{ "name":"DeleteVoiceConnectorTerminationCredentials", "http":{ "method":"POST", "requestUri":"/voice-connectors/{voiceConnectorId}/termination/credentials?operation=delete", "responseCode":204 }, "input":{"shape":"DeleteVoiceConnectorTerminationCredentialsRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

" }, "DeleteVoiceProfile":{ "name":"DeleteVoiceProfile", "http":{ "method":"DELETE", "requestUri":"/voice-profiles/{VoiceProfileId}", "responseCode":204 }, "input":{"shape":"DeleteVoiceProfileRequest"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

" }, "DeleteVoiceProfileDomain":{ "name":"DeleteVoiceProfileDomain", "http":{ "method":"DELETE", "requestUri":"/voice-profile-domains/{VoiceProfileDomainId}", "responseCode":204 }, "input":{"shape":"DeleteVoiceProfileDomainRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

" }, "DisassociatePhoneNumbersFromVoiceConnector":{ "name":"DisassociatePhoneNumbersFromVoiceConnector", "http":{ "method":"POST", "requestUri":"/voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers", "responseCode":200 }, "input":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorRequest"}, "output":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.

" }, "DisassociatePhoneNumbersFromVoiceConnectorGroup":{ "name":"DisassociatePhoneNumbersFromVoiceConnectorGroup", "http":{ "method":"POST", "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}?operation=disassociate-phone-numbers", "responseCode":200 }, "input":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorGroupRequest"}, "output":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorGroupResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

" }, "GetGlobalSettings":{ "name":"GetGlobalSettings", "http":{ "method":"GET", "requestUri":"/settings", "responseCode":200 }, "output":{"shape":"GetGlobalSettingsResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

" }, "GetPhoneNumber":{ "name":"GetPhoneNumber", "http":{ "method":"GET", "requestUri":"/phone-numbers/{phoneNumberId}" }, "input":{"shape":"GetPhoneNumberRequest"}, "output":{"shape":"GetPhoneNumberResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

" }, "GetPhoneNumberOrder":{ "name":"GetPhoneNumberOrder", "http":{ "method":"GET", "requestUri":"/phone-number-orders/{phoneNumberOrderId}", "responseCode":200 }, "input":{"shape":"GetPhoneNumberOrderRequest"}, "output":{"shape":"GetPhoneNumberOrderResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

" }, "GetPhoneNumberSettings":{ "name":"GetPhoneNumberSettings", "http":{ "method":"GET", "requestUri":"/settings/phone-number", "responseCode":200 }, "output":{"shape":"GetPhoneNumberSettingsResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

" }, "GetProxySession":{ "name":"GetProxySession", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", "responseCode":200 }, "input":{"shape":"GetProxySessionRequest"}, "output":{"shape":"GetProxySessionResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

" }, "GetSipMediaApplication":{ "name":"GetSipMediaApplication", "http":{ "method":"GET", "requestUri":"/sip-media-applications/{sipMediaApplicationId}", "responseCode":200 }, "input":{"shape":"GetSipMediaApplicationRequest"}, "output":{"shape":"GetSipMediaApplicationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

" }, "GetSipMediaApplicationAlexaSkillConfiguration":{ "name":"GetSipMediaApplicationAlexaSkillConfiguration", "http":{ "method":"GET", "requestUri":"/sip-media-applications/{sipMediaApplicationId}/alexa-skill-configuration", "responseCode":200 }, "input":{"shape":"GetSipMediaApplicationAlexaSkillConfigurationRequest"}, "output":{"shape":"GetSipMediaApplicationAlexaSkillConfigurationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Gets the Alexa Skill configuration for the SIP media application.

" }, "GetSipMediaApplicationLoggingConfiguration":{ "name":"GetSipMediaApplicationLoggingConfiguration", "http":{ "method":"GET", "requestUri":"/sip-media-applications/{sipMediaApplicationId}/logging-configuration", "responseCode":200 }, "input":{"shape":"GetSipMediaApplicationLoggingConfigurationRequest"}, "output":{"shape":"GetSipMediaApplicationLoggingConfigurationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the logging configuration for the specified SIP media application.

" }, "GetSipRule":{ "name":"GetSipRule", "http":{ "method":"GET", "requestUri":"/sip-rules/{sipRuleId}", "responseCode":200 }, "input":{"shape":"GetSipRuleRequest"}, "output":{"shape":"GetSipRuleResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

" }, "GetSpeakerSearchTask":{ "name":"GetSpeakerSearchTask", "http":{ "method":"GET", "requestUri":"/voice-connectors/{VoiceConnectorId}/speaker-search-tasks/{SpeakerSearchTaskId}", "responseCode":200 }, "input":{"shape":"GetSpeakerSearchTaskRequest"}, "output":{"shape":"GetSpeakerSearchTaskResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"AccessDeniedException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ServiceFailureException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Retrieves the details of the specified speaker search task.

" }, "GetVoiceConnector":{ "name":"GetVoiceConnector", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}", "responseCode":200 }, "input":{"shape":"GetVoiceConnectorRequest"}, "output":{"shape":"GetVoiceConnectorResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

" }, "GetVoiceConnectorEmergencyCallingConfiguration":{ "name":"GetVoiceConnectorEmergencyCallingConfiguration", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration", "responseCode":200 }, "input":{"shape":"GetVoiceConnectorEmergencyCallingConfigurationRequest"}, "output":{"shape":"GetVoiceConnectorEmergencyCallingConfigurationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the emergency calling configuration details for the specified Voice Connector.

" }, "GetVoiceConnectorGroup":{ "name":"GetVoiceConnectorGroup", "http":{ "method":"GET", "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}", "responseCode":200 }, "input":{"shape":"GetVoiceConnectorGroupRequest"}, "output":{"shape":"GetVoiceConnectorGroupResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated `VoiceConnectorItems`.

" }, "GetVoiceConnectorLoggingConfiguration":{ "name":"GetVoiceConnectorLoggingConfiguration", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}/logging-configuration", "responseCode":200 }, "input":{"shape":"GetVoiceConnectorLoggingConfigurationRequest"}, "output":{"shape":"GetVoiceConnectorLoggingConfigurationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

" }, "GetVoiceConnectorOrigination":{ "name":"GetVoiceConnectorOrigination", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}/origination", "responseCode":200 }, "input":{"shape":"GetVoiceConnectorOriginationRequest"}, "output":{"shape":"GetVoiceConnectorOriginationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the origination settings for the specified Voice Connector.

" }, "GetVoiceConnectorProxy":{ "name":"GetVoiceConnectorProxy", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy", "responseCode":200 }, "input":{"shape":"GetVoiceConnectorProxyRequest"}, "output":{"shape":"GetVoiceConnectorProxyResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

" }, "GetVoiceConnectorStreamingConfiguration":{ "name":"GetVoiceConnectorStreamingConfiguration", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}/streaming-configuration", "responseCode":200 }, "input":{"shape":"GetVoiceConnectorStreamingConfigurationRequest"}, "output":{"shape":"GetVoiceConnectorStreamingConfigurationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

" }, "GetVoiceConnectorTermination":{ "name":"GetVoiceConnectorTermination", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}/termination", "responseCode":200 }, "input":{"shape":"GetVoiceConnectorTerminationRequest"}, "output":{"shape":"GetVoiceConnectorTerminationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the termination setting details for the specified Voice Connector.

" }, "GetVoiceConnectorTerminationHealth":{ "name":"GetVoiceConnectorTerminationHealth", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}/termination/health", "responseCode":200 }, "input":{"shape":"GetVoiceConnectorTerminationHealthRequest"}, "output":{"shape":"GetVoiceConnectorTerminationHealthResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves information about the last time a `SIP OPTIONS` ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.

" }, "GetVoiceProfile":{ "name":"GetVoiceProfile", "http":{ "method":"GET", "requestUri":"/voice-profiles/{VoiceProfileId}", "responseCode":200 }, "input":{"shape":"GetVoiceProfileRequest"}, "output":{"shape":"GetVoiceProfileResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the details of the specified voice profile.

" }, "GetVoiceProfileDomain":{ "name":"GetVoiceProfileDomain", "http":{ "method":"GET", "requestUri":"/voice-profile-domains/{VoiceProfileDomainId}", "responseCode":200 }, "input":{"shape":"GetVoiceProfileDomainRequest"}, "output":{"shape":"GetVoiceProfileDomainResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the details of the specified voice profile domain.

" }, "GetVoiceToneAnalysisTask":{ "name":"GetVoiceToneAnalysisTask", "http":{ "method":"GET", "requestUri":"/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}", "responseCode":200 }, "input":{"shape":"GetVoiceToneAnalysisTaskRequest"}, "output":{"shape":"GetVoiceToneAnalysisTaskResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"AccessDeniedException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ServiceFailureException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Retrieves the details of a voice tone analysis task.

" }, "ListAvailableVoiceConnectorRegions":{ "name":"ListAvailableVoiceConnectorRegions", "http":{ "method":"GET", "requestUri":"/voice-connector-regions", "responseCode":200 }, "output":{"shape":"ListAvailableVoiceConnectorRegionsResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

" }, "ListPhoneNumberOrders":{ "name":"ListPhoneNumberOrders", "http":{ "method":"GET", "requestUri":"/phone-number-orders", "responseCode":200 }, "input":{"shape":"ListPhoneNumberOrdersRequest"}, "output":{"shape":"ListPhoneNumberOrdersResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the phone numbers for an administrator's Amazon Chime SDK account.

" }, "ListPhoneNumbers":{ "name":"ListPhoneNumbers", "http":{ "method":"GET", "requestUri":"/phone-numbers" }, "input":{"shape":"ListPhoneNumbersRequest"}, "output":{"shape":"ListPhoneNumbersResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

" }, "ListProxySessions":{ "name":"ListProxySessions", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions", "responseCode":200 }, "input":{"shape":"ListProxySessionsRequest"}, "output":{"shape":"ListProxySessionsResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

" }, "ListSipMediaApplications":{ "name":"ListSipMediaApplications", "http":{ "method":"GET", "requestUri":"/sip-media-applications", "responseCode":200 }, "input":{"shape":"ListSipMediaApplicationsRequest"}, "output":{"shape":"ListSipMediaApplicationsResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the SIP media applications under the administrator's AWS account.

" }, "ListSipRules":{ "name":"ListSipRules", "http":{ "method":"GET", "requestUri":"/sip-rules", "responseCode":200 }, "input":{"shape":"ListSipRulesRequest"}, "output":{"shape":"ListSipRulesResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the SIP rules under the administrator's AWS account.

" }, "ListSupportedPhoneNumberCountries":{ "name":"ListSupportedPhoneNumberCountries", "http":{ "method":"GET", "requestUri":"/phone-number-countries", "responseCode":200 }, "input":{"shape":"ListSupportedPhoneNumberCountriesRequest"}, "output":{"shape":"ListSupportedPhoneNumberCountriesResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the countries that you can order phone numbers from.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Returns a list of the tags in a given resource.

" }, "ListVoiceConnectorGroups":{ "name":"ListVoiceConnectorGroups", "http":{ "method":"GET", "requestUri":"/voice-connector-groups", "responseCode":200 }, "input":{"shape":"ListVoiceConnectorGroupsRequest"}, "output":{"shape":"ListVoiceConnectorGroupsResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.

" }, "ListVoiceConnectorTerminationCredentials":{ "name":"ListVoiceConnectorTerminationCredentials", "http":{ "method":"GET", "requestUri":"/voice-connectors/{voiceConnectorId}/termination/credentials", "responseCode":200 }, "input":{"shape":"ListVoiceConnectorTerminationCredentialsRequest"}, "output":{"shape":"ListVoiceConnectorTerminationCredentialsResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.

" }, "ListVoiceConnectors":{ "name":"ListVoiceConnectors", "http":{ "method":"GET", "requestUri":"/voice-connectors", "responseCode":200 }, "input":{"shape":"ListVoiceConnectorsRequest"}, "output":{"shape":"ListVoiceConnectorsResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

" }, "ListVoiceProfileDomains":{ "name":"ListVoiceProfileDomains", "http":{ "method":"GET", "requestUri":"/voice-profile-domains", "responseCode":200 }, "input":{"shape":"ListVoiceProfileDomainsRequest"}, "output":{"shape":"ListVoiceProfileDomainsResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the specified voice profile domains in the administrator's AWS account.

" }, "ListVoiceProfiles":{ "name":"ListVoiceProfiles", "http":{ "method":"GET", "requestUri":"/voice-profiles", "responseCode":200 }, "input":{"shape":"ListVoiceProfilesRequest"}, "output":{"shape":"ListVoiceProfilesResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the voice profiles in a voice profile domain.

" }, "PutSipMediaApplicationAlexaSkillConfiguration":{ "name":"PutSipMediaApplicationAlexaSkillConfiguration", "http":{ "method":"PUT", "requestUri":"/sip-media-applications/{sipMediaApplicationId}/alexa-skill-configuration", "responseCode":200 }, "input":{"shape":"PutSipMediaApplicationAlexaSkillConfigurationRequest"}, "output":{"shape":"PutSipMediaApplicationAlexaSkillConfigurationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the Alexa Skill configuration for the SIP media application.

" }, "PutSipMediaApplicationLoggingConfiguration":{ "name":"PutSipMediaApplicationLoggingConfiguration", "http":{ "method":"PUT", "requestUri":"/sip-media-applications/{sipMediaApplicationId}/logging-configuration", "responseCode":200 }, "input":{"shape":"PutSipMediaApplicationLoggingConfigurationRequest"}, "output":{"shape":"PutSipMediaApplicationLoggingConfigurationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the logging configuration for the specified SIP media application.

" }, "PutVoiceConnectorEmergencyCallingConfiguration":{ "name":"PutVoiceConnectorEmergencyCallingConfiguration", "http":{ "method":"PUT", "requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration", "responseCode":200 }, "input":{"shape":"PutVoiceConnectorEmergencyCallingConfigurationRequest"}, "output":{"shape":"PutVoiceConnectorEmergencyCallingConfigurationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates a Voice Connector's emergency calling configuration.

" }, "PutVoiceConnectorLoggingConfiguration":{ "name":"PutVoiceConnectorLoggingConfiguration", "http":{ "method":"PUT", "requestUri":"/voice-connectors/{voiceConnectorId}/logging-configuration", "responseCode":200 }, "input":{"shape":"PutVoiceConnectorLoggingConfigurationRequest"}, "output":{"shape":"PutVoiceConnectorLoggingConfigurationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates a Voice Connector's logging configuration.

" }, "PutVoiceConnectorOrigination":{ "name":"PutVoiceConnectorOrigination", "http":{ "method":"PUT", "requestUri":"/voice-connectors/{voiceConnectorId}/origination", "responseCode":200 }, "input":{"shape":"PutVoiceConnectorOriginationRequest"}, "output":{"shape":"PutVoiceConnectorOriginationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates a Voice Connector's origination settings.

" }, "PutVoiceConnectorProxy":{ "name":"PutVoiceConnectorProxy", "http":{ "method":"PUT", "requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy" }, "input":{"shape":"PutVoiceConnectorProxyRequest"}, "output":{"shape":"PutVoiceConnectorProxyResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

" }, "PutVoiceConnectorStreamingConfiguration":{ "name":"PutVoiceConnectorStreamingConfiguration", "http":{ "method":"PUT", "requestUri":"/voice-connectors/{voiceConnectorId}/streaming-configuration", "responseCode":200 }, "input":{"shape":"PutVoiceConnectorStreamingConfigurationRequest"}, "output":{"shape":"PutVoiceConnectorStreamingConfigurationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates a Voice Connector's streaming configuration settings.

" }, "PutVoiceConnectorTermination":{ "name":"PutVoiceConnectorTermination", "http":{ "method":"PUT", "requestUri":"/voice-connectors/{voiceConnectorId}/termination", "responseCode":200 }, "input":{"shape":"PutVoiceConnectorTerminationRequest"}, "output":{"shape":"PutVoiceConnectorTerminationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates a Voice Connector's termination settings.

" }, "PutVoiceConnectorTerminationCredentials":{ "name":"PutVoiceConnectorTerminationCredentials", "http":{ "method":"POST", "requestUri":"/voice-connectors/{voiceConnectorId}/termination/credentials?operation=put", "responseCode":204 }, "input":{"shape":"PutVoiceConnectorTerminationCredentialsRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates a Voice Connector's termination credentials.

" }, "RestorePhoneNumber":{ "name":"RestorePhoneNumber", "http":{ "method":"POST", "requestUri":"/phone-numbers/{phoneNumberId}?operation=restore", "responseCode":200 }, "input":{"shape":"RestorePhoneNumberRequest"}, "output":{"shape":"RestorePhoneNumberResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Restores a deleted phone number.

" }, "SearchAvailablePhoneNumbers":{ "name":"SearchAvailablePhoneNumbers", "http":{ "method":"GET", "requestUri":"/search?type=phone-numbers" }, "input":{"shape":"SearchAvailablePhoneNumbersRequest"}, "output":{"shape":"SearchAvailablePhoneNumbersResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Searches the provisioned phone numbers in an organization.

" }, "StartSpeakerSearchTask":{ "name":"StartSpeakerSearchTask", "http":{ "method":"POST", "requestUri":"/voice-connectors/{VoiceConnectorId}/speaker-search-tasks", "responseCode":201 }, "input":{"shape":"StartSpeakerSearchTaskRequest"}, "output":{"shape":"StartSpeakerSearchTaskResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"GoneException"}, {"shape":"UnprocessableEntityException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Starts a speaker search task.

Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

" }, "StartVoiceToneAnalysisTask":{ "name":"StartVoiceToneAnalysisTask", "http":{ "method":"POST", "requestUri":"/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks", "responseCode":201 }, "input":{"shape":"StartVoiceToneAnalysisTaskRequest"}, "output":{"shape":"StartVoiceToneAnalysisTaskResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"GoneException"}, {"shape":"UnprocessableEntityException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

" }, "StopSpeakerSearchTask":{ "name":"StopSpeakerSearchTask", "http":{ "method":"POST", "requestUri":"/voice-connectors/{VoiceConnectorId}/speaker-search-tasks/{SpeakerSearchTaskId}?operation=stop", "responseCode":204 }, "input":{"shape":"StopSpeakerSearchTaskRequest"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"UnprocessableEntityException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Stops a speaker search task.

" }, "StopVoiceToneAnalysisTask":{ "name":"StopVoiceToneAnalysisTask", "http":{ "method":"POST", "requestUri":"/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}?operation=stop", "responseCode":204 }, "input":{"shape":"StopVoiceToneAnalysisTaskRequest"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"UnprocessableEntityException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Stops a voice tone analysis task.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags?operation=tag-resource", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"NotFoundException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Adds a tag to the specified resource.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/tags?operation=untag-resource", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Removes tags from a resource.

" }, "UpdateGlobalSettings":{ "name":"UpdateGlobalSettings", "http":{ "method":"PUT", "requestUri":"/settings", "responseCode":204 }, "input":{"shape":"UpdateGlobalSettingsRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

" }, "UpdatePhoneNumber":{ "name":"UpdatePhoneNumber", "http":{ "method":"POST", "requestUri":"/phone-numbers/{phoneNumberId}", "responseCode":200 }, "input":{"shape":"UpdatePhoneNumberRequest"}, "output":{"shape":"UpdatePhoneNumberResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ConflictException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

" }, "UpdatePhoneNumberSettings":{ "name":"UpdatePhoneNumberSettings", "http":{ "method":"PUT", "requestUri":"/settings/phone-number", "responseCode":204 }, "input":{"shape":"UpdatePhoneNumberSettingsRequest"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

" }, "UpdateProxySession":{ "name":"UpdateProxySession", "http":{ "method":"POST", "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", "responseCode":201 }, "input":{"shape":"UpdateProxySessionRequest"}, "output":{"shape":"UpdateProxySessionResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the specified proxy session details, such as voice or SMS capabilities.

" }, "UpdateSipMediaApplication":{ "name":"UpdateSipMediaApplication", "http":{ "method":"PUT", "requestUri":"/sip-media-applications/{sipMediaApplicationId}", "responseCode":200 }, "input":{"shape":"UpdateSipMediaApplicationRequest"}, "output":{"shape":"UpdateSipMediaApplicationResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the details of the specified SIP media application.

" }, "UpdateSipMediaApplicationCall":{ "name":"UpdateSipMediaApplicationCall", "http":{ "method":"POST", "requestUri":"/sip-media-applications/{sipMediaApplicationId}/calls/{transactionId}", "responseCode":202 }, "input":{"shape":"UpdateSipMediaApplicationCallRequest"}, "output":{"shape":"UpdateSipMediaApplicationCallResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ThrottledClientException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

" }, "UpdateSipRule":{ "name":"UpdateSipRule", "http":{ "method":"PUT", "requestUri":"/sip-rules/{sipRuleId}", "responseCode":202 }, "input":{"shape":"UpdateSipRuleRequest"}, "output":{"shape":"UpdateSipRuleResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the details of the specified SIP rule.

" }, "UpdateVoiceConnector":{ "name":"UpdateVoiceConnector", "http":{ "method":"PUT", "requestUri":"/voice-connectors/{voiceConnectorId}", "responseCode":200 }, "input":{"shape":"UpdateVoiceConnectorRequest"}, "output":{"shape":"UpdateVoiceConnectorResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the details for the specified Amazon Chime SDK Voice Connector.

" }, "UpdateVoiceConnectorGroup":{ "name":"UpdateVoiceConnectorGroup", "http":{ "method":"PUT", "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}", "responseCode":202 }, "input":{"shape":"UpdateVoiceConnectorGroupRequest"}, "output":{"shape":"UpdateVoiceConnectorGroupResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

" }, "UpdateVoiceProfile":{ "name":"UpdateVoiceProfile", "http":{ "method":"PUT", "requestUri":"/voice-profiles/{VoiceProfileId}", "responseCode":200 }, "input":{"shape":"UpdateVoiceProfileRequest"}, "output":{"shape":"UpdateVoiceProfileResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"GoneException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws.

You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

" }, "UpdateVoiceProfileDomain":{ "name":"UpdateVoiceProfileDomain", "http":{ "method":"PUT", "requestUri":"/voice-profile-domains/{VoiceProfileDomainId}", "responseCode":200 }, "input":{"shape":"UpdateVoiceProfileDomainRequest"}, "output":{"shape":"UpdateVoiceProfileDomainResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the settings for the specified voice profile domain.

" }, "ValidateE911Address":{ "name":"ValidateE911Address", "http":{ "method":"POST", "requestUri":"/emergency-calling/address", "responseCode":202 }, "input":{"shape":"ValidateE911AddressRequest"}, "output":{"shape":"ValidateE911AddressResponse"}, "errors":[ {"shape":"UnauthorizedClientException"}, {"shape":"NotFoundException"}, {"shape":"ForbiddenException"}, {"shape":"BadRequestException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ }, "documentation":"

You don't have the permissions needed to run this action.

", "error":{"httpStatusCode":403}, "exception":true }, "Address":{ "type":"structure", "members":{ "streetName":{ "shape":"SensitiveNonEmptyString", "documentation":"

The address street, such as `8th Avenue`.

" }, "streetSuffix":{ "shape":"SensitiveNonEmptyString", "documentation":"

The address suffix, such as the `N` in `8th Avenue N`.

" }, "postDirectional":{ "shape":"SensitiveNonEmptyString", "documentation":"

An address suffix location, such as the `S. Unit A` in `Central Park S. Unit A`.

" }, "preDirectional":{ "shape":"SensitiveNonEmptyString", "documentation":"

An address prefix location, such as the `N` in `N. Third St.`

" }, "streetNumber":{ "shape":"SensitiveNonEmptyString", "documentation":"

The numeric portion of an address.

" }, "city":{ "shape":"SensitiveNonEmptyString", "documentation":"

The city of an address.

" }, "state":{ "shape":"SensitiveNonEmptyString", "documentation":"

The state of an address.

" }, "postalCode":{ "shape":"SensitiveNonEmptyString", "documentation":"

The postal code of an address.

" }, "postalCodePlus4":{ "shape":"SensitiveNonEmptyString", "documentation":"

The zip + 4 or postal code + 4 of an address.

" }, "country":{ "shape":"SensitiveNonEmptyString", "documentation":"

The country of an address.

" } }, "documentation":"

A validated address.

" }, "AlexaSkillId":{ "type":"string", "max":64, "pattern":"amzn1\\.application-oa2-client\\.[0-9a-fA-F]{32}", "sensitive":true }, "AlexaSkillIdList":{ "type":"list", "member":{"shape":"AlexaSkillId"}, "max":1, "min":1 }, "AlexaSkillStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "Alpha2CountryCode":{ "type":"string", "pattern":"[A-Z]{2}" }, "AreaCode":{ "type":"string", "pattern":"^$|^[0-9]{3,3}$" }, "Arn":{ "type":"string", "max":1024, "min":1, "pattern":"^arn[\\/\\:\\-\\_\\.a-zA-Z0-9]+$", "sensitive":true }, "AssociatePhoneNumbersWithVoiceConnectorGroupRequest":{ "type":"structure", "required":[ "VoiceConnectorGroupId", "E164PhoneNumbers" ], "members":{ "VoiceConnectorGroupId":{ "shape":"NonEmptyString", "documentation":"

The Amazon Chime SDK Voice Connector group ID.

", "location":"uri", "locationName":"voiceConnectorGroupId" }, "E164PhoneNumbers":{ "shape":"E164PhoneNumberList", "documentation":"

List of phone numbers, in E.164 format.

" }, "ForceAssociate":{ "shape":"NullableBoolean", "documentation":"

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

" } } }, "AssociatePhoneNumbersWithVoiceConnectorGroupResponse":{ "type":"structure", "members":{ "PhoneNumberErrors":{ "shape":"PhoneNumberErrorList", "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" } } }, "AssociatePhoneNumbersWithVoiceConnectorRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "E164PhoneNumbers" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "E164PhoneNumbers":{ "shape":"E164PhoneNumberList", "documentation":"

List of phone numbers, in E.164 format.

" }, "ForceAssociate":{ "shape":"NullableBoolean", "documentation":"

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

" } } }, "AssociatePhoneNumbersWithVoiceConnectorResponse":{ "type":"structure", "members":{ "PhoneNumberErrors":{ "shape":"PhoneNumberErrorList", "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" } } }, "BadRequestException":{ "type":"structure", "members":{ }, "documentation":"

The input parameters don't match the service's restrictions.

", "error":{"httpStatusCode":400}, "exception":true }, "BatchDeletePhoneNumberRequest":{ "type":"structure", "required":["PhoneNumberIds"], "members":{ "PhoneNumberIds":{ "shape":"NonEmptyStringList", "documentation":"

List of phone number IDs.

" } } }, "BatchDeletePhoneNumberResponse":{ "type":"structure", "members":{ "PhoneNumberErrors":{ "shape":"PhoneNumberErrorList", "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" } } }, "BatchUpdatePhoneNumberRequest":{ "type":"structure", "required":["UpdatePhoneNumberRequestItems"], "members":{ "UpdatePhoneNumberRequestItems":{ "shape":"UpdatePhoneNumberRequestItemList", "documentation":"

Lists the phone numbers in the update request.

" } } }, "BatchUpdatePhoneNumberResponse":{ "type":"structure", "members":{ "PhoneNumberErrors":{ "shape":"PhoneNumberErrorList", "documentation":"

A list of failed phone numbers and their error messages.

" } } }, "Boolean":{"type":"boolean"}, "CallDetails":{ "type":"structure", "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

" }, "TransactionId":{ "shape":"NonEmptyString256", "documentation":"

The transaction ID of a Voice Connector call.

" }, "IsCaller":{ "shape":"Boolean", "documentation":"

Identifies a person as the caller or the callee.

" } }, "documentation":"

The details of an Amazon Chime SDK Voice Connector call.

" }, "CallLegType":{ "type":"string", "enum":[ "Caller", "Callee" ] }, "CallingName":{ "type":"string", "pattern":"^$|^[a-zA-Z0-9 ]{2,15}$", "sensitive":true }, "CallingNameStatus":{ "type":"string", "enum":[ "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed" ] }, "CallingRegion":{"type":"string"}, "CallingRegionList":{ "type":"list", "member":{"shape":"CallingRegion"} }, "CandidateAddress":{ "type":"structure", "members":{ "streetInfo":{ "shape":"SensitiveNonEmptyString", "documentation":"

The street information of the candidate address.

" }, "streetNumber":{ "shape":"SensitiveNonEmptyString", "documentation":"

The numeric portion of the candidate address.

" }, "city":{ "shape":"SensitiveNonEmptyString", "documentation":"

The city of the candidate address.

" }, "state":{ "shape":"SensitiveNonEmptyString", "documentation":"

The state of the candidate address.

" }, "postalCode":{ "shape":"SensitiveNonEmptyString", "documentation":"

The postal code of the candidate address.

" }, "postalCodePlus4":{ "shape":"SensitiveNonEmptyString", "documentation":"

The zip + 4 or postal code +4 of the candidate address.

" }, "country":{ "shape":"SensitiveNonEmptyString", "documentation":"

The country of the candidate address.

" } }, "documentation":"

A suggested address.

" }, "CandidateAddressList":{ "type":"list", "member":{"shape":"CandidateAddress"} }, "Capability":{ "type":"string", "enum":[ "Voice", "SMS" ] }, "CapabilityList":{ "type":"list", "member":{"shape":"Capability"} }, "ClientRequestId":{ "type":"string", "pattern":"^[-_a-zA-Z0-9]*${2,64}$" }, "ConfidenceScore":{ "type":"float", "max":1, "min":0 }, "ConflictException":{ "type":"structure", "members":{ }, "documentation":"

Multiple instances of the same request were made simultaneously.

", "error":{"httpStatusCode":409}, "exception":true }, "Country":{ "type":"string", "pattern":"^$|^[A-Z]{2,2}$" }, "CountryList":{ "type":"list", "member":{"shape":"Country"}, "max":100, "min":1 }, "CpsLimit":{ "type":"integer", "min":1 }, "CreatePhoneNumberOrderRequest":{ "type":"structure", "required":[ "ProductType", "E164PhoneNumbers" ], "members":{ "ProductType":{ "shape":"PhoneNumberProductType", "documentation":"

The phone number product type.

" }, "E164PhoneNumbers":{ "shape":"E164PhoneNumberList", "documentation":"

List of phone numbers, in E.164 format.

" }, "Name":{ "shape":"PhoneNumberName", "documentation":"

Specifies the name assigned to one or more phone numbers.

" } } }, "CreatePhoneNumberOrderResponse":{ "type":"structure", "members":{ "PhoneNumberOrder":{ "shape":"PhoneNumberOrder", "documentation":"

The phone number order details.

" } } }, "CreateProxySessionRequest":{ "type":"structure", "required":[ "ParticipantPhoneNumbers", "Capabilities", "VoiceConnectorId" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "ParticipantPhoneNumbers":{ "shape":"ParticipantPhoneNumberList", "documentation":"

The participant phone numbers.

" }, "Name":{ "shape":"ProxySessionNameString", "documentation":"

The name of the proxy session.

" }, "ExpiryMinutes":{ "shape":"PositiveInteger", "documentation":"

The number of minutes allowed for the proxy session.

" }, "Capabilities":{ "shape":"CapabilityList", "documentation":"

The proxy session's capabilities.

" }, "NumberSelectionBehavior":{ "shape":"NumberSelectionBehavior", "documentation":"

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

" }, "GeoMatchLevel":{ "shape":"GeoMatchLevel", "documentation":"

The preference for matching the country or area code of the proxy phone number with that of the first participant.

" }, "GeoMatchParams":{ "shape":"GeoMatchParams", "documentation":"

The country and area code for the proxy phone number.

" } } }, "CreateProxySessionResponse":{ "type":"structure", "members":{ "ProxySession":{ "shape":"ProxySession", "documentation":"

The proxy session details.

" } } }, "CreateSipMediaApplicationCallRequest":{ "type":"structure", "required":[ "FromPhoneNumber", "ToPhoneNumber", "SipMediaApplicationId" ], "members":{ "FromPhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory.

" }, "ToPhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The phone number that the service should call.

" }, "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The ID of the SIP media application.

", "location":"uri", "locationName":"sipMediaApplicationId" }, "SipHeaders":{ "shape":"SipHeadersMap", "documentation":"

The SIP headers added to an outbound call leg.

" }, "ArgumentsMap":{ "shape":"SMACreateCallArgumentsMap", "documentation":"

Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: `\"FirstName\": \"John\", \"LastName\": \"Doe\"`

" } } }, "CreateSipMediaApplicationCallResponse":{ "type":"structure", "members":{ "SipMediaApplicationCall":{ "shape":"SipMediaApplicationCall", "documentation":"

The actual call.

" } } }, "CreateSipMediaApplicationRequest":{ "type":"structure", "required":[ "AwsRegion", "Name", "Endpoints" ], "members":{ "AwsRegion":{ "shape":"String", "documentation":"

The AWS Region assigned to the SIP media application.

" }, "Name":{ "shape":"SipMediaApplicationName", "documentation":"

The SIP media application's name.

" }, "Endpoints":{ "shape":"SipMediaApplicationEndpointList", "documentation":"

List of endpoints (Lambda ARNs) specified for the SIP media application.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags assigned to the SIP media application.

" } } }, "CreateSipMediaApplicationResponse":{ "type":"structure", "members":{ "SipMediaApplication":{ "shape":"SipMediaApplication", "documentation":"

The SIP media application details.

" } } }, "CreateSipRuleRequest":{ "type":"structure", "required":[ "Name", "TriggerType", "TriggerValue" ], "members":{ "Name":{ "shape":"SipRuleName", "documentation":"

The name of the SIP rule.

" }, "TriggerType":{ "shape":"SipRuleTriggerType", "documentation":"

The type of trigger assigned to the SIP rule in `TriggerValue`, currently `RequestUriHostname` or `ToPhoneNumber`.

" }, "TriggerValue":{ "shape":"NonEmptyString", "documentation":"

If `TriggerType` is `RequestUriHostname`, the value can be the outbound host name of a Voice Connector. If `TriggerType` is `ToPhoneNumber`, the value can be a customer-owned phone number in the E164 format. The `SipMediaApplication` specified in the `SipRule` is triggered if the request URI in an incoming SIP request matches the `RequestUriHostname`, or if the `To` header in the incoming SIP request matches the `ToPhoneNumber` value.

" }, "Disabled":{ "shape":"NullableBoolean", "documentation":"

Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

" }, "TargetApplications":{ "shape":"SipRuleTargetApplicationList", "documentation":"

List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

" } } }, "CreateSipRuleResponse":{ "type":"structure", "members":{ "SipRule":{ "shape":"SipRule", "documentation":"

The SIP rule information, including the rule ID, triggers, and target applications.

" } } }, "CreateVoiceConnectorGroupRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"VoiceConnectorGroupName", "documentation":"

The name of the Voice Connector group.

" }, "VoiceConnectorItems":{ "shape":"VoiceConnectorItemList", "documentation":"

Lists the Voice Connectors that inbound calls are routed to.

" } } }, "CreateVoiceConnectorGroupResponse":{ "type":"structure", "members":{ "VoiceConnectorGroup":{ "shape":"VoiceConnectorGroup", "documentation":"

The details of the Voice Connector group.

" } } }, "CreateVoiceConnectorRequest":{ "type":"structure", "required":[ "Name", "RequireEncryption" ], "members":{ "Name":{ "shape":"VoiceConnectorName", "documentation":"

The name of the Voice Connector.

" }, "AwsRegion":{ "shape":"VoiceConnectorAwsRegion", "documentation":"

The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: `us-east-1` .

" }, "RequireEncryption":{ "shape":"Boolean", "documentation":"

Enables or disables encryption for the Voice Connector.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags assigned to the Voice Connector.

" } } }, "CreateVoiceConnectorResponse":{ "type":"structure", "members":{ "VoiceConnector":{ "shape":"VoiceConnector", "documentation":"

The details of the Voice Connector.

" } } }, "CreateVoiceProfileDomainRequest":{ "type":"structure", "required":[ "Name", "ServerSideEncryptionConfiguration" ], "members":{ "Name":{ "shape":"VoiceProfileDomainName", "documentation":"

The name of the voice profile domain.

" }, "Description":{ "shape":"VoiceProfileDomainDescription", "documentation":"

A description of the voice profile domain.

" }, "ServerSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", "documentation":"

The server-side encryption configuration for the request.

" }, "ClientRequestToken":{ "shape":"ClientRequestId", "documentation":"

The unique identifier for the client request. Use a different token for different domain creation requests.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags assigned to the domain.

" } } }, "CreateVoiceProfileDomainResponse":{ "type":"structure", "members":{ "VoiceProfileDomain":{ "shape":"VoiceProfileDomain", "documentation":"

The requested voice profile domain.

" } } }, "CreateVoiceProfileRequest":{ "type":"structure", "required":["SpeakerSearchTaskId"], "members":{ "SpeakerSearchTaskId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the speaker search task.

" } } }, "CreateVoiceProfileResponse":{ "type":"structure", "members":{ "VoiceProfile":{ "shape":"VoiceProfile", "documentation":"

The requested voice profile.

" } } }, "Credential":{ "type":"structure", "members":{ "Username":{ "shape":"SensitiveString", "documentation":"

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

" }, "Password":{ "shape":"SensitiveString", "documentation":"

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

" } }, "documentation":"

The SIP credentials used to authenticate requests to an Amazon Chime SDK Voice Connector.

" }, "CredentialList":{ "type":"list", "member":{"shape":"Credential"} }, "DNISEmergencyCallingConfiguration":{ "type":"structure", "required":[ "EmergencyPhoneNumber", "CallingCountry" ], "members":{ "EmergencyPhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The DNIS phone number that you route emergency calls to, in E.164 format.

" }, "TestPhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The DNIS phone number for routing test emergency calls to, in E.164 format.

" }, "CallingCountry":{ "shape":"Alpha2CountryCode", "documentation":"

The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

" } }, "documentation":"

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime SDK Voice Connector's emergency calling configuration.

" }, "DNISEmergencyCallingConfigurationList":{ "type":"list", "member":{"shape":"DNISEmergencyCallingConfiguration"} }, "DataRetentionInHours":{ "type":"integer", "min":0 }, "DeletePhoneNumberRequest":{ "type":"structure", "required":["PhoneNumberId"], "members":{ "PhoneNumberId":{ "shape":"SensitiveNonEmptyString", "documentation":"

The phone number ID.

", "location":"uri", "locationName":"phoneNumberId" } } }, "DeleteProxySessionRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "ProxySessionId" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "ProxySessionId":{ "shape":"NonEmptyString128", "documentation":"

The proxy session ID.

", "location":"uri", "locationName":"proxySessionId" } } }, "DeleteSipMediaApplicationRequest":{ "type":"structure", "required":["SipMediaApplicationId"], "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The SIP media application ID.

", "location":"uri", "locationName":"sipMediaApplicationId" } } }, "DeleteSipRuleRequest":{ "type":"structure", "required":["SipRuleId"], "members":{ "SipRuleId":{ "shape":"NonEmptyString", "documentation":"

The SIP rule ID.

", "location":"uri", "locationName":"sipRuleId" } } }, "DeleteVoiceConnectorEmergencyCallingConfigurationRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "DeleteVoiceConnectorGroupRequest":{ "type":"structure", "required":["VoiceConnectorGroupId"], "members":{ "VoiceConnectorGroupId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector Group ID.

", "location":"uri", "locationName":"voiceConnectorGroupId" } } }, "DeleteVoiceConnectorOriginationRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "DeleteVoiceConnectorProxyRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "DeleteVoiceConnectorRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "DeleteVoiceConnectorStreamingConfigurationRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "DeleteVoiceConnectorTerminationCredentialsRequest":{ "type":"structure", "required":[ "Usernames", "VoiceConnectorId" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "Usernames":{ "shape":"SensitiveStringList", "documentation":"

The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

" } } }, "DeleteVoiceConnectorTerminationRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "DeleteVoiceProfileDomainRequest":{ "type":"structure", "required":["VoiceProfileDomainId"], "members":{ "VoiceProfileDomainId":{ "shape":"NonEmptyString256", "documentation":"

The voice profile domain ID.

", "location":"uri", "locationName":"VoiceProfileDomainId" } } }, "DeleteVoiceProfileRequest":{ "type":"structure", "required":["VoiceProfileId"], "members":{ "VoiceProfileId":{ "shape":"NonEmptyString256", "documentation":"

The voice profile ID.

", "location":"uri", "locationName":"VoiceProfileId" } } }, "DisassociatePhoneNumbersFromVoiceConnectorGroupRequest":{ "type":"structure", "required":[ "VoiceConnectorGroupId", "E164PhoneNumbers" ], "members":{ "VoiceConnectorGroupId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector group ID.

", "location":"uri", "locationName":"voiceConnectorGroupId" }, "E164PhoneNumbers":{ "shape":"E164PhoneNumberList", "documentation":"

The list of phone numbers, in E.164 format.

" } } }, "DisassociatePhoneNumbersFromVoiceConnectorGroupResponse":{ "type":"structure", "members":{ "PhoneNumberErrors":{ "shape":"PhoneNumberErrorList", "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" } } }, "DisassociatePhoneNumbersFromVoiceConnectorRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "E164PhoneNumbers" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "E164PhoneNumbers":{ "shape":"E164PhoneNumberList", "documentation":"

List of phone numbers, in E.164 format.

" } } }, "DisassociatePhoneNumbersFromVoiceConnectorResponse":{ "type":"structure", "members":{ "PhoneNumberErrors":{ "shape":"PhoneNumberErrorList", "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" } } }, "E164PhoneNumber":{ "type":"string", "pattern":"^\\+?[1-9]\\d{1,14}$", "sensitive":true }, "E164PhoneNumberList":{ "type":"list", "member":{"shape":"E164PhoneNumber"} }, "EmergencyCallingConfiguration":{ "type":"structure", "members":{ "DNIS":{ "shape":"DNISEmergencyCallingConfigurationList", "documentation":"

The Dialed Number Identification Service (DNIS) emergency calling configuration details.

" } }, "documentation":"

The emergency calling configuration details associated with an Amazon Chime SDK Voice Connector.

" }, "ErrorCode":{ "type":"string", "enum":[ "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist", "Gone" ] }, "ForbiddenException":{ "type":"structure", "members":{ }, "documentation":"

The client is permanently forbidden from making the request.

", "error":{"httpStatusCode":403}, "exception":true }, "FunctionArn":{ "type":"string", "max":10000, "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?", "sensitive":true }, "GeoMatchLevel":{ "type":"string", "enum":[ "Country", "AreaCode" ] }, "GeoMatchParams":{ "type":"structure", "required":[ "Country", "AreaCode" ], "members":{ "Country":{ "shape":"Country", "documentation":"

The country.

" }, "AreaCode":{ "shape":"AreaCode", "documentation":"

The area code.

" } }, "documentation":"

The country and area code for a proxy phone number in a proxy phone session.

" }, "GetGlobalSettingsResponse":{ "type":"structure", "members":{ "VoiceConnector":{ "shape":"VoiceConnectorSettings", "documentation":"

The Voice Connector settings.

" } } }, "GetPhoneNumberOrderRequest":{ "type":"structure", "required":["PhoneNumberOrderId"], "members":{ "PhoneNumberOrderId":{ "shape":"GuidString", "documentation":"

The ID of the phone number order .

", "location":"uri", "locationName":"phoneNumberOrderId" } } }, "GetPhoneNumberOrderResponse":{ "type":"structure", "members":{ "PhoneNumberOrder":{ "shape":"PhoneNumberOrder", "documentation":"

The phone number order details.

" } } }, "GetPhoneNumberRequest":{ "type":"structure", "required":["PhoneNumberId"], "members":{ "PhoneNumberId":{ "shape":"SensitiveNonEmptyString", "documentation":"

The phone number ID.

", "location":"uri", "locationName":"phoneNumberId" } } }, "GetPhoneNumberResponse":{ "type":"structure", "members":{ "PhoneNumber":{ "shape":"PhoneNumber", "documentation":"

The phone number details.

" } } }, "GetPhoneNumberSettingsResponse":{ "type":"structure", "members":{ "CallingName":{ "shape":"CallingName", "documentation":"

The default outbound calling name for the account.

" }, "CallingNameUpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The updated outbound calling name timestamp, in ISO 8601 format.

" } } }, "GetProxySessionRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "ProxySessionId" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "ProxySessionId":{ "shape":"NonEmptyString128", "documentation":"

The proxy session ID.

", "location":"uri", "locationName":"proxySessionId" } } }, "GetProxySessionResponse":{ "type":"structure", "members":{ "ProxySession":{ "shape":"ProxySession", "documentation":"

The proxy session details.

" } } }, "GetSipMediaApplicationAlexaSkillConfigurationRequest":{ "type":"structure", "required":["SipMediaApplicationId"], "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The SIP media application ID.

", "location":"uri", "locationName":"sipMediaApplicationId" } } }, "GetSipMediaApplicationAlexaSkillConfigurationResponse":{ "type":"structure", "members":{ "SipMediaApplicationAlexaSkillConfiguration":{ "shape":"SipMediaApplicationAlexaSkillConfiguration", "documentation":"

Returns the Alexa Skill configuration.

" } } }, "GetSipMediaApplicationLoggingConfigurationRequest":{ "type":"structure", "required":["SipMediaApplicationId"], "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The SIP media application ID.

", "location":"uri", "locationName":"sipMediaApplicationId" } } }, "GetSipMediaApplicationLoggingConfigurationResponse":{ "type":"structure", "members":{ "SipMediaApplicationLoggingConfiguration":{ "shape":"SipMediaApplicationLoggingConfiguration", "documentation":"

The actual logging configuration.

" } } }, "GetSipMediaApplicationRequest":{ "type":"structure", "required":["SipMediaApplicationId"], "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The SIP media application ID .

", "location":"uri", "locationName":"sipMediaApplicationId" } } }, "GetSipMediaApplicationResponse":{ "type":"structure", "members":{ "SipMediaApplication":{ "shape":"SipMediaApplication", "documentation":"

The details of the SIP media application.

" } } }, "GetSipRuleRequest":{ "type":"structure", "required":["SipRuleId"], "members":{ "SipRuleId":{ "shape":"NonEmptyString", "documentation":"

The SIP rule ID.

", "location":"uri", "locationName":"sipRuleId" } } }, "GetSipRuleResponse":{ "type":"structure", "members":{ "SipRule":{ "shape":"SipRule", "documentation":"

The SIP rule details.

" } } }, "GetSpeakerSearchTaskRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "SpeakerSearchTaskId" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"VoiceConnectorId" }, "SpeakerSearchTaskId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the speaker search task.

", "location":"uri", "locationName":"SpeakerSearchTaskId" } } }, "GetSpeakerSearchTaskResponse":{ "type":"structure", "members":{ "SpeakerSearchTask":{ "shape":"SpeakerSearchTask", "documentation":"

The details of the speaker search task.

" } } }, "GetVoiceConnectorEmergencyCallingConfigurationRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "GetVoiceConnectorEmergencyCallingConfigurationResponse":{ "type":"structure", "members":{ "EmergencyCallingConfiguration":{ "shape":"EmergencyCallingConfiguration", "documentation":"

The details of the emergency calling configuration.

" } } }, "GetVoiceConnectorGroupRequest":{ "type":"structure", "required":["VoiceConnectorGroupId"], "members":{ "VoiceConnectorGroupId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector group ID.

", "location":"uri", "locationName":"voiceConnectorGroupId" } } }, "GetVoiceConnectorGroupResponse":{ "type":"structure", "members":{ "VoiceConnectorGroup":{ "shape":"VoiceConnectorGroup", "documentation":"

The details of the Voice Connector group.

" } } }, "GetVoiceConnectorLoggingConfigurationRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "GetVoiceConnectorLoggingConfigurationResponse":{ "type":"structure", "members":{ "LoggingConfiguration":{ "shape":"LoggingConfiguration", "documentation":"

The logging configuration details .

" } } }, "GetVoiceConnectorOriginationRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "GetVoiceConnectorOriginationResponse":{ "type":"structure", "members":{ "Origination":{ "shape":"Origination", "documentation":"

The origination setting details.

" } } }, "GetVoiceConnectorProxyRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "GetVoiceConnectorProxyResponse":{ "type":"structure", "members":{ "Proxy":{ "shape":"Proxy", "documentation":"

The proxy configuration details.

" } } }, "GetVoiceConnectorRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "GetVoiceConnectorResponse":{ "type":"structure", "members":{ "VoiceConnector":{ "shape":"VoiceConnector", "documentation":"

The Voice Connector details.

" } } }, "GetVoiceConnectorStreamingConfigurationRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "GetVoiceConnectorStreamingConfigurationResponse":{ "type":"structure", "members":{ "StreamingConfiguration":{ "shape":"StreamingConfiguration", "documentation":"

The details of the streaming configuration.

" } } }, "GetVoiceConnectorTerminationHealthRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "GetVoiceConnectorTerminationHealthResponse":{ "type":"structure", "members":{ "TerminationHealth":{ "shape":"TerminationHealth", "documentation":"

The termination health details.

" } } }, "GetVoiceConnectorTerminationRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "GetVoiceConnectorTerminationResponse":{ "type":"structure", "members":{ "Termination":{ "shape":"Termination", "documentation":"

The termination setting details.

" } } }, "GetVoiceProfileDomainRequest":{ "type":"structure", "required":["VoiceProfileDomainId"], "members":{ "VoiceProfileDomainId":{ "shape":"NonEmptyString256", "documentation":"

The voice profile domain ID.

", "location":"uri", "locationName":"VoiceProfileDomainId" } } }, "GetVoiceProfileDomainResponse":{ "type":"structure", "members":{ "VoiceProfileDomain":{ "shape":"VoiceProfileDomain", "documentation":"

The details of the voice profile domain.

" } } }, "GetVoiceProfileRequest":{ "type":"structure", "required":["VoiceProfileId"], "members":{ "VoiceProfileId":{ "shape":"NonEmptyString256", "documentation":"

The voice profile ID.

", "location":"uri", "locationName":"VoiceProfileId" } } }, "GetVoiceProfileResponse":{ "type":"structure", "members":{ "VoiceProfile":{ "shape":"VoiceProfile", "documentation":"

The voice profile details.

" } } }, "GetVoiceToneAnalysisTaskRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "VoiceToneAnalysisTaskId", "IsCaller" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"VoiceConnectorId" }, "VoiceToneAnalysisTaskId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the voice tone anlysis task.

", "location":"uri", "locationName":"VoiceToneAnalysisTaskId" }, "IsCaller":{ "shape":"Boolean", "documentation":"

Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

", "location":"querystring", "locationName":"isCaller" } } }, "GetVoiceToneAnalysisTaskResponse":{ "type":"structure", "members":{ "VoiceToneAnalysisTask":{ "shape":"VoiceToneAnalysisTask", "documentation":"

The details of the voice tone analysis task.

" } } }, "GoneException":{ "type":"structure", "members":{ }, "documentation":"

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

", "error":{"httpStatusCode":410}, "exception":true }, "GuidString":{ "type":"string", "pattern":"[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}" }, "Integer":{"type":"integer"}, "Iso8601Timestamp":{ "type":"timestamp", "timestampFormat":"iso8601" }, "LanguageCode":{ "type":"string", "enum":["en-US"] }, "ListAvailableVoiceConnectorRegionsResponse":{ "type":"structure", "members":{ "VoiceConnectorRegions":{ "shape":"VoiceConnectorAwsRegionList", "documentation":"

The list of AWS Regions.

" } } }, "ListPhoneNumberOrdersRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token used 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" } } }, "ListPhoneNumberOrdersResponse":{ "type":"structure", "members":{ "PhoneNumberOrders":{ "shape":"PhoneNumberOrderList", "documentation":"

The phone number order details.

" }, "NextToken":{ "shape":"String", "documentation":"

The token used to retrieve the next page of results.

" } } }, "ListPhoneNumbersRequest":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

The status of your organization's phone numbers.

", "location":"querystring", "locationName":"status" }, "ProductType":{ "shape":"PhoneNumberProductType", "documentation":"

The phone number product types.

", "location":"querystring", "locationName":"product-type" }, "FilterName":{ "shape":"PhoneNumberAssociationName", "documentation":"

The filter to limit the number of results.

", "location":"querystring", "locationName":"filter-name" }, "FilterValue":{ "shape":"String", "documentation":"

The filter value.

", "location":"querystring", "locationName":"filter-value" }, "MaxResults":{ "shape":"ResultMax", "documentation":"

The maximum number of results to return in a single call.

", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"String", "documentation":"

The token used to return the next page of results.

", "location":"querystring", "locationName":"next-token" } } }, "ListPhoneNumbersResponse":{ "type":"structure", "members":{ "PhoneNumbers":{ "shape":"PhoneNumberList", "documentation":"

The phone number details.

" }, "NextToken":{ "shape":"String", "documentation":"

The token used to return the next page of results.

" } } }, "ListProxySessionsRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "Status":{ "shape":"ProxySessionStatus", "documentation":"

The proxy session status.

", "location":"querystring", "locationName":"status" }, "NextToken":{ "shape":"NextTokenString", "documentation":"

The token used 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" } } }, "ListProxySessionsResponse":{ "type":"structure", "members":{ "ProxySessions":{ "shape":"ProxySessions", "documentation":"

The proxy sessions' details.

" }, "NextToken":{ "shape":"NextTokenString", "documentation":"

The token used to retrieve the next page of results.

" } } }, "ListSipMediaApplicationsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ResultMax", "documentation":"

The maximum number of results to return in a single call. Defaults to 100.

", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"NextTokenString", "documentation":"

The token used to return the next page of results.

", "location":"querystring", "locationName":"next-token" } } }, "ListSipMediaApplicationsResponse":{ "type":"structure", "members":{ "SipMediaApplications":{ "shape":"SipMediaApplicationList", "documentation":"

The list of SIP media applications and application details.

" }, "NextToken":{ "shape":"NextTokenString", "documentation":"

The token used to return the next page of results.

" } } }, "ListSipRulesRequest":{ "type":"structure", "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The SIP media application ID.

", "location":"querystring", "locationName":"sip-media-application" }, "MaxResults":{ "shape":"ResultMax", "documentation":"

The maximum number of results to return in a single call. Defaults to 100.

", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"NextTokenString", "documentation":"

The token used to return the next page of results.

", "location":"querystring", "locationName":"next-token" } } }, "ListSipRulesResponse":{ "type":"structure", "members":{ "SipRules":{ "shape":"SipRuleList", "documentation":"

The list of SIP rules and details.

" }, "NextToken":{ "shape":"NextTokenString", "documentation":"

The token used to return the next page of results.

" } } }, "ListSupportedPhoneNumberCountriesRequest":{ "type":"structure", "required":["ProductType"], "members":{ "ProductType":{ "shape":"PhoneNumberProductType", "documentation":"

The phone number product type.

", "location":"querystring", "locationName":"product-type" } } }, "ListSupportedPhoneNumberCountriesResponse":{ "type":"structure", "members":{ "PhoneNumberCountries":{ "shape":"PhoneNumberCountriesList", "documentation":"

The supported phone number countries.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceARN"], "members":{ "ResourceARN":{ "shape":"Arn", "documentation":"

The resource ARN.

", "location":"querystring", "locationName":"arn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

The tags in the list.

" } } }, "ListVoiceConnectorGroupsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token used to return 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" } } }, "ListVoiceConnectorGroupsResponse":{ "type":"structure", "members":{ "VoiceConnectorGroups":{ "shape":"VoiceConnectorGroupList", "documentation":"

The details of the Voice Connector groups.

" }, "NextToken":{ "shape":"String", "documentation":"

The token used to return the next page of results.

" } } }, "ListVoiceConnectorTerminationCredentialsRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" } } }, "ListVoiceConnectorTerminationCredentialsResponse":{ "type":"structure", "members":{ "Usernames":{ "shape":"SensitiveStringList", "documentation":"

A list of user names.

" } } }, "ListVoiceConnectorsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token used to return 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" } } }, "ListVoiceConnectorsResponse":{ "type":"structure", "members":{ "VoiceConnectors":{ "shape":"VoiceConnectorList", "documentation":"

The details of the Voice Connectors.

" }, "NextToken":{ "shape":"String", "documentation":"

The token used to return the next page of results.

" } } }, "ListVoiceProfileDomainsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token used to return 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" } } }, "ListVoiceProfileDomainsResponse":{ "type":"structure", "members":{ "VoiceProfileDomains":{ "shape":"VoiceProfileDomainSummaryList", "documentation":"

The list of voice profile domains.

" }, "NextToken":{ "shape":"String", "documentation":"

The token used to return the next page of results.

" } } }, "ListVoiceProfilesRequest":{ "type":"structure", "required":["VoiceProfileDomainId"], "members":{ "VoiceProfileDomainId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the voice profile domain.

", "location":"querystring", "locationName":"voice-profile-domain-id" }, "NextToken":{ "shape":"String", "documentation":"

The token used to retrieve the next page of results.

", "location":"querystring", "locationName":"next-token" }, "MaxResults":{ "shape":"ResultMax", "documentation":"

The maximum number of results in the request.

", "location":"querystring", "locationName":"max-results" } } }, "ListVoiceProfilesResponse":{ "type":"structure", "members":{ "VoiceProfiles":{ "shape":"VoiceProfileSummaryList", "documentation":"

The list of voice profiles.

" }, "NextToken":{ "shape":"String", "documentation":"

The token used to retrieve the next page of results.

" } } }, "LoggingConfiguration":{ "type":"structure", "members":{ "EnableSIPLogs":{ "shape":"Boolean", "documentation":"

Boolean that enables sending SIP message logs to Amazon CloudWatch.

" }, "EnableMediaMetricLogs":{ "shape":"Boolean", "documentation":"

Enables or disables media metrics logging.

" } }, "documentation":"

The logging configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether SIP message logs can be sent to Amazon CloudWatch Logs.

" }, "MediaInsightsConfiguration":{ "type":"structure", "members":{ "Disabled":{ "shape":"Boolean", "documentation":"

Denotes the configration as enabled or disabled.

" }, "ConfigurationArn":{ "shape":"Arn", "documentation":"

The configuration's ARN.

" } }, "documentation":"

The configuration for a call analytics task.

" }, "NextTokenString":{ "type":"string", "max":65535 }, "NonEmptyString":{ "type":"string", "pattern":".*\\S.*" }, "NonEmptyString128":{ "type":"string", "max":128, "min":1, "pattern":".*\\S.*" }, "NonEmptyString256":{ "type":"string", "max":256, "min":1, "pattern":".*\\S.*" }, "NonEmptyStringList":{ "type":"list", "member":{"shape":"String"}, "min":1 }, "NotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The requested resource couldn't be found.

", "error":{"httpStatusCode":404}, "exception":true }, "NotificationTarget":{ "type":"string", "enum":[ "EventBridge", "SNS", "SQS" ] }, "NullableBoolean":{"type":"boolean"}, "NumberSelectionBehavior":{ "type":"string", "enum":[ "PreferSticky", "AvoidSticky" ] }, "OrderedPhoneNumber":{ "type":"structure", "members":{ "E164PhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The phone number, in E.164 format.

" }, "Status":{ "shape":"OrderedPhoneNumberStatus", "documentation":"

The phone number status.

" } }, "documentation":"

A phone number for which an order has been placed.

" }, "OrderedPhoneNumberList":{ "type":"list", "member":{"shape":"OrderedPhoneNumber"} }, "OrderedPhoneNumberStatus":{ "type":"string", "enum":[ "Processing", "Acquired", "Failed" ] }, "Origination":{ "type":"structure", "members":{ "Routes":{ "shape":"OriginationRouteList", "documentation":"

The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or `Disabled`.

" }, "Disabled":{ "shape":"Boolean", "documentation":"

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or `Routes`.

" } }, "documentation":"

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime SDK Voice Connector.

The parameters listed below are not required, but you must use at least one.

" }, "OriginationRoute":{ "type":"structure", "members":{ "Host":{ "shape":"String", "documentation":"

The FQDN or IP address to contact for origination traffic.

" }, "Port":{ "shape":"Port", "documentation":"

The designated origination route port. Defaults to 5060.

" }, "Protocol":{ "shape":"OriginationRouteProtocol", "documentation":"

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

" }, "Priority":{ "shape":"OriginationRoutePriority", "documentation":"

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

" }, "Weight":{ "shape":"OriginationRouteWeight", "documentation":"

The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

" } }, "documentation":"

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector.

The parameters listed below are not required, but you must use at least one.

" }, "OriginationRouteList":{ "type":"list", "member":{"shape":"OriginationRoute"} }, "OriginationRoutePriority":{ "type":"integer", "max":100, "min":1 }, "OriginationRouteProtocol":{ "type":"string", "enum":[ "TCP", "UDP" ] }, "OriginationRouteWeight":{ "type":"integer", "max":100, "min":1 }, "Participant":{ "type":"structure", "members":{ "PhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The participant's phone number.

" }, "ProxyPhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The participant's proxy phone number.

" } }, "documentation":"

The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session.

" }, "ParticipantPhoneNumberList":{ "type":"list", "member":{"shape":"E164PhoneNumber"}, "max":2, "min":2 }, "Participants":{ "type":"list", "member":{"shape":"Participant"} }, "PhoneNumber":{ "type":"structure", "members":{ "PhoneNumberId":{ "shape":"SensitiveNonEmptyString", "documentation":"

The phone number's ID.

" }, "E164PhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The phone number, in E.164 format.

" }, "Country":{ "shape":"Alpha2CountryCode", "documentation":"

The phone number's country. Format: ISO 3166-1 alpha-2.

" }, "Type":{ "shape":"PhoneNumberType", "documentation":"

The phone number's type.

" }, "ProductType":{ "shape":"PhoneNumberProductType", "documentation":"

The phone number's product type.

" }, "Status":{ "shape":"PhoneNumberStatus", "documentation":"

The phone number's status.

" }, "Capabilities":{ "shape":"PhoneNumberCapabilities", "documentation":"

The phone number's capabilities.

" }, "Associations":{ "shape":"PhoneNumberAssociationList", "documentation":"

The phone number's associations.

" }, "CallingName":{ "shape":"CallingName", "documentation":"

The outbound calling name associated with the phone number.

" }, "CallingNameStatus":{ "shape":"CallingNameStatus", "documentation":"

The outbound calling name status.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The phone number creation timestamp, in ISO 8601 format.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The updated phone number timestamp, in ISO 8601 format.

" }, "DeletionTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The deleted phone number timestamp, in ISO 8601 format.

" }, "OrderId":{ "shape":"GuidString", "documentation":"

The phone number's order ID.

" }, "Name":{ "shape":"PhoneNumberName", "documentation":"

The name of the phone number.

" } }, "documentation":"

A phone number used to call an Amazon Chime SDK Voice Connector.

" }, "PhoneNumberAssociation":{ "type":"structure", "members":{ "Value":{ "shape":"String", "documentation":"

Contains the ID for the entity specified in Name.

" }, "Name":{ "shape":"PhoneNumberAssociationName", "documentation":"

Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

" }, "AssociatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The timestamp of the phone number association, in ISO 8601 format.

" } }, "documentation":"

The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

" }, "PhoneNumberAssociationList":{ "type":"list", "member":{"shape":"PhoneNumberAssociation"} }, "PhoneNumberAssociationName":{ "type":"string", "enum":[ "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId" ] }, "PhoneNumberCapabilities":{ "type":"structure", "members":{ "InboundCall":{ "shape":"NullableBoolean", "documentation":"

Allows or denies inbound calling for the specified phone number.

" }, "OutboundCall":{ "shape":"NullableBoolean", "documentation":"

Allows or denies outbound calling for the specified phone number.

" }, "InboundSMS":{ "shape":"NullableBoolean", "documentation":"

Allows or denies inbound SMS messaging for the specified phone number.

" }, "OutboundSMS":{ "shape":"NullableBoolean", "documentation":"

Allows or denies outbound SMS messaging for the specified phone number.

" }, "InboundMMS":{ "shape":"NullableBoolean", "documentation":"

Allows or denies inbound MMS messaging for the specified phone number.

" }, "OutboundMMS":{ "shape":"NullableBoolean", "documentation":"

Allows or denies inbound MMS messaging for the specified phone number.

" } }, "documentation":"

The phone number capabilities for Amazon Chime SDK phone numbers, such as enabled inbound and outbound calling, and text messaging.

" }, "PhoneNumberCountriesList":{ "type":"list", "member":{"shape":"PhoneNumberCountry"} }, "PhoneNumberCountry":{ "type":"structure", "members":{ "CountryCode":{ "shape":"Alpha2CountryCode", "documentation":"

The phone number country code. Format: ISO 3166-1 alpha-2.

" }, "SupportedPhoneNumberTypes":{ "shape":"PhoneNumberTypeList", "documentation":"

The supported phone number types.

" } }, "documentation":"

The phone number's country.

" }, "PhoneNumberError":{ "type":"structure", "members":{ "PhoneNumberId":{ "shape":"SensitiveNonEmptyString", "documentation":"

The phone number ID for which the action failed.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code.

" }, "ErrorMessage":{ "shape":"String", "documentation":"

The error message.

" } }, "documentation":"

If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages.

" }, "PhoneNumberErrorList":{ "type":"list", "member":{"shape":"PhoneNumberError"} }, "PhoneNumberList":{ "type":"list", "member":{"shape":"PhoneNumber"} }, "PhoneNumberMaxResults":{ "type":"integer", "max":500, "min":1 }, "PhoneNumberName":{ "type":"string", "max":256, "min":0, "pattern":"^$|^[a-zA-Z0-9\\,\\.\\_\\-]+(\\s+[a-zA-Z0-9\\,\\.\\_\\-]+)*$", "sensitive":true }, "PhoneNumberOrder":{ "type":"structure", "members":{ "PhoneNumberOrderId":{ "shape":"GuidString", "documentation":"

The ID of the phone order.

" }, "ProductType":{ "shape":"PhoneNumberProductType", "documentation":"

The phone number order product type.

" }, "Status":{ "shape":"PhoneNumberOrderStatus", "documentation":"

The status of the phone number order.

" }, "OrderType":{ "shape":"PhoneNumberOrderType", "documentation":"

The type of phone number being ordered, local or toll-free.

" }, "OrderedPhoneNumbers":{ "shape":"OrderedPhoneNumberList", "documentation":"

The ordered phone number details, such as the phone number in E.164 format and the phone number status.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The phone number order creation time stamp, in ISO 8601 format.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The updated phone number order time stamp, in ISO 8601 format.

" } }, "documentation":"

The details of an Amazon Chime SDK phone number order.

" }, "PhoneNumberOrderList":{ "type":"list", "member":{"shape":"PhoneNumberOrder"} }, "PhoneNumberOrderStatus":{ "type":"string", "enum":[ "Processing", "Successful", "Failed", "Partial", "PendingDocuments", "Submitted", "FOC", "ChangeRequested", "Exception", "CancelRequested", "Cancelled" ] }, "PhoneNumberOrderType":{ "type":"string", "enum":[ "New", "Porting" ] }, "PhoneNumberProductType":{ "type":"string", "enum":[ "VoiceConnector", "SipMediaApplicationDialIn" ] }, "PhoneNumberStatus":{ "type":"string", "enum":[ "Cancelled", "PortinCancelRequested", "PortinInProgress", "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed" ] }, "PhoneNumberType":{ "type":"string", "enum":[ "Local", "TollFree" ] }, "PhoneNumberTypeList":{ "type":"list", "member":{"shape":"PhoneNumberType"} }, "Port":{ "type":"integer", "max":65535, "min":0 }, "PositiveInteger":{ "type":"integer", "min":1 }, "Proxy":{ "type":"structure", "members":{ "DefaultSessionExpiryMinutes":{ "shape":"Integer", "documentation":"

The default number of minutes allowed for proxy sessions.

" }, "Disabled":{ "shape":"Boolean", "documentation":"

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

" }, "FallBackPhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The phone number to route calls to after a proxy session expires.

" }, "PhoneNumberCountries":{ "shape":"StringList", "documentation":"

The countries for proxy phone numbers to be selected from.

" } }, "documentation":"

The proxy configuration for an Amazon Chime SDK Voice Connector.

" }, "ProxySession":{ "type":"structure", "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

" }, "ProxySessionId":{ "shape":"NonEmptyString128", "documentation":"

The proxy session ID.

" }, "Name":{ "shape":"String128", "documentation":"

The proxy session name.

" }, "Status":{ "shape":"ProxySessionStatus", "documentation":"

The proxy session status.

" }, "ExpiryMinutes":{ "shape":"PositiveInteger", "documentation":"

The number of minutes allowed for the proxy session.

" }, "Capabilities":{ "shape":"CapabilityList", "documentation":"

The proxy session capabilities.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The created time stamp, in ISO 8601 format.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The updated time stamp, in ISO 8601 format.

" }, "EndedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The ended time stamp, in ISO 8601 format.

" }, "Participants":{ "shape":"Participants", "documentation":"

The proxy session participants.

" }, "NumberSelectionBehavior":{ "shape":"NumberSelectionBehavior", "documentation":"

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

" }, "GeoMatchLevel":{ "shape":"GeoMatchLevel", "documentation":"

The preference for matching the country or area code of the proxy phone number with that of the first participant.

" }, "GeoMatchParams":{ "shape":"GeoMatchParams", "documentation":"

The country and area code for the proxy phone number.

" } }, "documentation":"

The proxy session for an Amazon Chime SDK Voice Connector.

" }, "ProxySessionNameString":{ "type":"string", "pattern":"^$|^[a-zA-Z0-9 ]{0,30}$", "sensitive":true }, "ProxySessionStatus":{ "type":"string", "enum":[ "Open", "InProgress", "Closed" ] }, "ProxySessions":{ "type":"list", "member":{"shape":"ProxySession"} }, "PutSipMediaApplicationAlexaSkillConfigurationRequest":{ "type":"structure", "required":["SipMediaApplicationId"], "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The SIP media application ID.

", "location":"uri", "locationName":"sipMediaApplicationId" }, "SipMediaApplicationAlexaSkillConfiguration":{ "shape":"SipMediaApplicationAlexaSkillConfiguration", "documentation":"

The Alexa Skill configuration.

" } } }, "PutSipMediaApplicationAlexaSkillConfigurationResponse":{ "type":"structure", "members":{ "SipMediaApplicationAlexaSkillConfiguration":{ "shape":"SipMediaApplicationAlexaSkillConfiguration", "documentation":"

Returns the Alexa Skill configuration.

" } } }, "PutSipMediaApplicationLoggingConfigurationRequest":{ "type":"structure", "required":["SipMediaApplicationId"], "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The SIP media application ID.

", "location":"uri", "locationName":"sipMediaApplicationId" }, "SipMediaApplicationLoggingConfiguration":{ "shape":"SipMediaApplicationLoggingConfiguration", "documentation":"

The logging configuration for the specified SIP media application.

" } } }, "PutSipMediaApplicationLoggingConfigurationResponse":{ "type":"structure", "members":{ "SipMediaApplicationLoggingConfiguration":{ "shape":"SipMediaApplicationLoggingConfiguration", "documentation":"

The updated logging configuration for the specified SIP media application.

" } } }, "PutVoiceConnectorEmergencyCallingConfigurationRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "EmergencyCallingConfiguration" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "EmergencyCallingConfiguration":{ "shape":"EmergencyCallingConfiguration", "documentation":"

The configuration being updated.

" } } }, "PutVoiceConnectorEmergencyCallingConfigurationResponse":{ "type":"structure", "members":{ "EmergencyCallingConfiguration":{ "shape":"EmergencyCallingConfiguration", "documentation":"

The updated configuration.

" } } }, "PutVoiceConnectorLoggingConfigurationRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "LoggingConfiguration" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "LoggingConfiguration":{ "shape":"LoggingConfiguration", "documentation":"

The logging configuration being updated.

" } } }, "PutVoiceConnectorLoggingConfigurationResponse":{ "type":"structure", "members":{ "LoggingConfiguration":{ "shape":"LoggingConfiguration", "documentation":"

The updated logging configuration.

" } } }, "PutVoiceConnectorOriginationRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "Origination" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "Origination":{ "shape":"Origination", "documentation":"

The origination settings being updated.

" } } }, "PutVoiceConnectorOriginationResponse":{ "type":"structure", "members":{ "Origination":{ "shape":"Origination", "documentation":"

The updated origination settings.

" } } }, "PutVoiceConnectorProxyRequest":{ "type":"structure", "required":[ "DefaultSessionExpiryMinutes", "PhoneNumberPoolCountries", "VoiceConnectorId" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "DefaultSessionExpiryMinutes":{ "shape":"Integer", "documentation":"

The default number of minutes allowed for proxy session.

" }, "PhoneNumberPoolCountries":{ "shape":"CountryList", "documentation":"

The countries for proxy phone numbers to be selected from.

" }, "FallBackPhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The phone number to route calls to after a proxy session expires.

" }, "Disabled":{ "shape":"Boolean", "documentation":"

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

" } } }, "PutVoiceConnectorProxyResponse":{ "type":"structure", "members":{ "Proxy":{ "shape":"Proxy", "documentation":"

The proxy configuration details.

" } } }, "PutVoiceConnectorStreamingConfigurationRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "StreamingConfiguration" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "StreamingConfiguration":{ "shape":"StreamingConfiguration", "documentation":"

The streaming settings being updated.

" } } }, "PutVoiceConnectorStreamingConfigurationResponse":{ "type":"structure", "members":{ "StreamingConfiguration":{ "shape":"StreamingConfiguration", "documentation":"

The updated streaming settings.

" } } }, "PutVoiceConnectorTerminationCredentialsRequest":{ "type":"structure", "required":["VoiceConnectorId"], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "Credentials":{ "shape":"CredentialList", "documentation":"

The termination credentials being updated.

" } } }, "PutVoiceConnectorTerminationRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "Termination" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "Termination":{ "shape":"Termination", "documentation":"

The termination settings to be updated.

" } } }, "PutVoiceConnectorTerminationResponse":{ "type":"structure", "members":{ "Termination":{ "shape":"Termination", "documentation":"

The updated termination settings.

" } } }, "ResourceLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The request exceeds the resource limit.

", "error":{"httpStatusCode":400}, "exception":true }, "RestorePhoneNumberRequest":{ "type":"structure", "required":["PhoneNumberId"], "members":{ "PhoneNumberId":{ "shape":"SensitiveNonEmptyString", "documentation":"

The ID of the phone number being restored.

", "location":"uri", "locationName":"phoneNumberId" } } }, "RestorePhoneNumberResponse":{ "type":"structure", "members":{ "PhoneNumber":{ "shape":"PhoneNumber", "documentation":"

The restored phone number.

" } } }, "ResultMax":{ "type":"integer", "max":100, "min":1 }, "SMACreateCallArgumentsMap":{ "type":"map", "key":{"shape":"SensitiveString"}, "value":{"shape":"SensitiveString"}, "max":20, "min":0 }, "SMAUpdateCallArgumentsMap":{ "type":"map", "key":{"shape":"SensitiveString"}, "value":{"shape":"SensitiveString"}, "max":20, "min":0 }, "SearchAvailablePhoneNumbersRequest":{ "type":"structure", "members":{ "AreaCode":{ "shape":"String", "documentation":"

Confines a search to just the phone numbers associated with the specified area code.

", "location":"querystring", "locationName":"area-code" }, "City":{ "shape":"String", "documentation":"

Confines a search to just the phone numbers associated with the specified city.

", "location":"querystring", "locationName":"city" }, "Country":{ "shape":"Alpha2CountryCode", "documentation":"

Confines a search to just the phone numbers associated with the specified country.

", "location":"querystring", "locationName":"country" }, "State":{ "shape":"String", "documentation":"

Confines a search to just the phone numbers associated with the specified state.

", "location":"querystring", "locationName":"state" }, "TollFreePrefix":{ "shape":"TollFreePrefix", "documentation":"

Confines a search to just the phone numbers associated with the specified toll-free prefix.

", "location":"querystring", "locationName":"toll-free-prefix" }, "PhoneNumberType":{ "shape":"PhoneNumberType", "documentation":"

Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

", "location":"querystring", "locationName":"phone-number-type" }, "MaxResults":{ "shape":"PhoneNumberMaxResults", "documentation":"

The maximum number of results to return.

", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"String", "documentation":"

The token used to return the next page of results.

", "location":"querystring", "locationName":"next-token" } } }, "SearchAvailablePhoneNumbersResponse":{ "type":"structure", "members":{ "E164PhoneNumbers":{ "shape":"E164PhoneNumberList", "documentation":"

Confines a search to just the phone numbers in the E.164 format.

" }, "NextToken":{ "shape":"String", "documentation":"

The token used to return the next page of results.

" } } }, "SensitiveNonEmptyString":{ "type":"string", "pattern":".*\\S.*", "sensitive":true }, "SensitiveString":{ "type":"string", "sensitive":true }, "SensitiveStringList":{ "type":"list", "member":{"shape":"SensitiveString"} }, "ServerSideEncryptionConfiguration":{ "type":"structure", "required":["KmsKeyArn"], "members":{ "KmsKeyArn":{ "shape":"Arn", "documentation":"

The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.

" } }, "documentation":"

A structure that contains the configuration settings for server-side encryption.

We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS aliases.

" }, "ServiceFailureException":{ "type":"structure", "members":{ }, "documentation":"

The service encountered an unexpected error.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ServiceUnavailableException":{ "type":"structure", "members":{ }, "documentation":"

The service is currently unavailable.

", "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "SipApplicationPriority":{ "type":"integer", "min":1 }, "SipHeadersMap":{ "type":"map", "key":{"shape":"SensitiveString"}, "value":{"shape":"SensitiveString"}, "max":20, "min":0 }, "SipMediaApplication":{ "type":"structure", "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

A SIP media application's ID.

" }, "AwsRegion":{ "shape":"String", "documentation":"

The AWS Region in which the SIP media application is created.

" }, "Name":{ "shape":"SipMediaApplicationName", "documentation":"

The SIP media application's name.

" }, "Endpoints":{ "shape":"SipMediaApplicationEndpointList", "documentation":"

List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The SIP media application creation timestamp, in ISO 8601 format.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which the SIP media application was updated.

" }, "SipMediaApplicationArn":{ "shape":"NonEmptyString", "documentation":"

The ARN of the SIP media application.

" } }, "documentation":"

The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.

" }, "SipMediaApplicationAlexaSkillConfiguration":{ "type":"structure", "required":[ "AlexaSkillStatus", "AlexaSkillIds" ], "members":{ "AlexaSkillStatus":{ "shape":"AlexaSkillStatus", "documentation":"

The status of the Alexa Skill configuration.

" }, "AlexaSkillIds":{ "shape":"AlexaSkillIdList", "documentation":"

The ID of the Alexa Skill configuration.

" } }, "documentation":"

The Alexa Skill configuration of a SIP media application.

" }, "SipMediaApplicationCall":{ "type":"structure", "members":{ "TransactionId":{ "shape":"GuidString", "documentation":"

The call's transaction ID.

" } }, "documentation":"

A `Call` instance for a SIP media application.

" }, "SipMediaApplicationEndpoint":{ "type":"structure", "members":{ "LambdaArn":{ "shape":"FunctionArn", "documentation":"

Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

" } }, "documentation":"

The endpoint assigned to a SIP media application.

" }, "SipMediaApplicationEndpointList":{ "type":"list", "member":{"shape":"SipMediaApplicationEndpoint"}, "max":1, "min":1 }, "SipMediaApplicationList":{ "type":"list", "member":{"shape":"SipMediaApplication"} }, "SipMediaApplicationLoggingConfiguration":{ "type":"structure", "members":{ "EnableSipMediaApplicationMessageLogs":{ "shape":"Boolean", "documentation":"

Enables message logging for the specified SIP media application.

" } }, "documentation":"

The logging configuration of a SIP media application.

" }, "SipMediaApplicationName":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9 _.-]+" }, "SipRule":{ "type":"structure", "members":{ "SipRuleId":{ "shape":"NonEmptyString", "documentation":"

A SIP rule's ID.

" }, "Name":{ "shape":"SipRuleName", "documentation":"

A SIP rule's name.

" }, "Disabled":{ "shape":"Boolean", "documentation":"

Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

" }, "TriggerType":{ "shape":"SipRuleTriggerType", "documentation":"

The type of trigger set for a SIP rule, either a phone number or a URI request host name.

" }, "TriggerValue":{ "shape":"NonEmptyString", "documentation":"

The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.

" }, "TargetApplications":{ "shape":"SipRuleTargetApplicationList", "documentation":"

The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which the SIP rule was created, in ISO 8601 format.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which the SIP rule was updated, in ISO 8601 format.

" } }, "documentation":"

The details of a SIP rule, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

" }, "SipRuleList":{ "type":"list", "member":{"shape":"SipRule"} }, "SipRuleName":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9 _.-]+" }, "SipRuleTargetApplication":{ "type":"structure", "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The ID of a rule's target SIP media application.

" }, "Priority":{ "shape":"SipApplicationPriority", "documentation":"

The priority setting of a rule's target SIP media application.

" }, "AwsRegion":{ "shape":"String", "documentation":"

The AWS Region of a rule's target SIP media application.

" } }, "documentation":"

A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

" }, "SipRuleTargetApplicationList":{ "type":"list", "member":{"shape":"SipRuleTargetApplication"}, "max":25, "min":1 }, "SipRuleTriggerType":{ "type":"string", "enum":[ "ToPhoneNumber", "RequestUriHostname" ] }, "SpeakerSearchDetails":{ "type":"structure", "members":{ "Results":{ "shape":"SpeakerSearchResultList", "documentation":"

The result value in the speaker search details.

" }, "VoiceprintGenerationStatus":{ "shape":"NonEmptyString256", "documentation":"

The status of a voice print generation operation, `VoiceprintGenerationSuccess` or `VoiceprintGenerationFailure`..

" } }, "documentation":"

The details of a speaker search task.

" }, "SpeakerSearchResult":{ "type":"structure", "members":{ "ConfidenceScore":{ "shape":"ConfidenceScore", "documentation":"

The confidence score in the speaker search analysis.

" }, "VoiceProfileId":{ "shape":"NonEmptyString256", "documentation":"

The voice profile ID.

" } }, "documentation":"

The result of a speaker search analysis.

" }, "SpeakerSearchResultList":{ "type":"list", "member":{"shape":"SpeakerSearchResult"} }, "SpeakerSearchTask":{ "type":"structure", "members":{ "SpeakerSearchTaskId":{ "shape":"NonEmptyString256", "documentation":"

The speaker search task ID.

" }, "SpeakerSearchTaskStatus":{ "shape":"NonEmptyString", "documentation":"

The status of the speaker search task, `IN_QUEUE`, `IN_PROGRESS`, `PARTIAL_SUCCESS`, `SUCCEEDED`, `FAILED`, or `STOPPED`.

" }, "CallDetails":{ "shape":"CallDetails", "documentation":"

The call details of a speaker search task.

" }, "SpeakerSearchDetails":{ "shape":"SpeakerSearchDetails", "documentation":"

The details of a speaker search task.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which a speaker search task was created.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which a speaker search task was updated.

" }, "StartedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which the speaker search task began.

" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed message about the status of a speaker search.

" } }, "documentation":"

A representation of an asynchronous request to perform speaker search analysis on a Voice Connector call.

" }, "StartSpeakerSearchTaskRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "TransactionId", "VoiceProfileDomainId" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"VoiceConnectorId" }, "TransactionId":{ "shape":"NonEmptyString256", "documentation":"

The transaction ID of the call being analyzed.

" }, "VoiceProfileDomainId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the voice profile domain that will store the voice profile.

" }, "ClientRequestToken":{ "shape":"ClientRequestId", "documentation":"

The unique identifier for the client request. Use a different token for different speaker search tasks.

" }, "CallLeg":{ "shape":"CallLegType", "documentation":"

Specifies which call leg to stream for speaker search.

" } } }, "StartSpeakerSearchTaskResponse":{ "type":"structure", "members":{ "SpeakerSearchTask":{ "shape":"SpeakerSearchTask", "documentation":"

The details of the speaker search task.

" } } }, "StartVoiceToneAnalysisTaskRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "TransactionId", "LanguageCode" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"VoiceConnectorId" }, "TransactionId":{ "shape":"NonEmptyString256", "documentation":"

The transaction ID.

" }, "LanguageCode":{ "shape":"LanguageCode", "documentation":"

The language code.

" }, "ClientRequestToken":{ "shape":"ClientRequestId", "documentation":"

The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

" } } }, "StartVoiceToneAnalysisTaskResponse":{ "type":"structure", "members":{ "VoiceToneAnalysisTask":{ "shape":"VoiceToneAnalysisTask", "documentation":"

The details of the voice tone analysis task.

" } } }, "StopSpeakerSearchTaskRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "SpeakerSearchTaskId" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"VoiceConnectorId" }, "SpeakerSearchTaskId":{ "shape":"NonEmptyString256", "documentation":"

The speaker search task ID.

", "location":"uri", "locationName":"SpeakerSearchTaskId" } } }, "StopVoiceToneAnalysisTaskRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "VoiceToneAnalysisTaskId" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"VoiceConnectorId" }, "VoiceToneAnalysisTaskId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the voice tone analysis task.

", "location":"uri", "locationName":"VoiceToneAnalysisTaskId" } } }, "StreamingConfiguration":{ "type":"structure", "required":[ "DataRetentionInHours", "Disabled" ], "members":{ "DataRetentionInHours":{ "shape":"DataRetentionInHours", "documentation":"

The amount of time, in hours, to the Kinesis data.

" }, "Disabled":{ "shape":"Boolean", "documentation":"

When true, streaming to Kinesis is off.

" }, "StreamingNotificationTargets":{ "shape":"StreamingNotificationTargetList", "documentation":"

The streaming notification targets.

" }, "MediaInsightsConfiguration":{ "shape":"MediaInsightsConfiguration", "documentation":"

The call analytics configuration.

" } }, "documentation":"

The streaming configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.

" }, "StreamingNotificationTarget":{ "type":"structure", "members":{ "NotificationTarget":{ "shape":"NotificationTarget", "documentation":"

The streaming notification target.

" } }, "documentation":"

The target recipient for a streaming configuration notification.

" }, "StreamingNotificationTargetList":{ "type":"list", "member":{"shape":"StreamingNotificationTarget"}, "max":3, "min":1 }, "String":{"type":"string"}, "String128":{ "type":"string", "max":128 }, "StringList":{ "type":"list", "member":{"shape":"String"} }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The tag's key.

" }, "Value":{ "shape":"TagValue", "documentation":"

The tag's value.

" } }, "documentation":"

Describes a tag applied to a resource.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "sensitive":true }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "Tags" ], "members":{ "ResourceARN":{ "shape":"Arn", "documentation":"

The ARN of the resource being tagged.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of the tags being added to the resource.

" } } }, "TagValue":{ "type":"string", "max":256, "min":0, "sensitive":true }, "Termination":{ "type":"structure", "members":{ "CpsLimit":{ "shape":"CpsLimit", "documentation":"

The limit on calls per second. Max value based on account service quota. Default value of 1.

" }, "DefaultPhoneNumber":{ "shape":"E164PhoneNumber", "documentation":"

The default outbound calling number.

" }, "CallingRegions":{ "shape":"CallingRegionList", "documentation":"

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

" }, "CidrAllowedList":{ "shape":"StringList", "documentation":"

The IP addresses allowed to make calls, in CIDR format.

" }, "Disabled":{ "shape":"Boolean", "documentation":"

When termination is disabled, outbound calls cannot be made.

" } }, "documentation":"

Termination settings enable SIP hosts to make outbound calls using an Amazon Chime SDK Voice Connector.

" }, "TerminationHealth":{ "type":"structure", "members":{ "Timestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The timestamp, in ISO 8601 format.

" }, "Source":{ "shape":"String", "documentation":"

The source IP address.

" } }, "documentation":"

The termination health details, including the source IP address and timestamp of the last successful `SIP OPTIONS` message from your SIP infrastructure.

" }, "ThrottledClientException":{ "type":"structure", "members":{ }, "documentation":"

The number of customer requests exceeds the request rate limit.

", "error":{"httpStatusCode":429}, "exception":true }, "TollFreePrefix":{ "type":"string", "max":3, "min":3, "pattern":"^8(00|33|44|55|66|77|88)$" }, "UnauthorizedClientException":{ "type":"structure", "members":{ }, "documentation":"

The client isn't authorized to request a resource.

", "error":{"httpStatusCode":401}, "exception":true }, "UnprocessableEntityException":{ "type":"structure", "members":{ }, "documentation":"

A well-formed request couldn't be followed due to semantic errors.

", "error":{"httpStatusCode":422}, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "TagKeys" ], "members":{ "ResourceARN":{ "shape":"Arn", "documentation":"

The ARN of the resource having its tags removed.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

The keys of the tags being removed from the resource.

" } } }, "UpdateGlobalSettingsRequest":{ "type":"structure", "members":{ "VoiceConnector":{ "shape":"VoiceConnectorSettings", "documentation":"

The Voice Connector settings.

" } } }, "UpdatePhoneNumberRequest":{ "type":"structure", "required":["PhoneNumberId"], "members":{ "PhoneNumberId":{ "shape":"SensitiveNonEmptyString", "documentation":"

The phone number ID.

", "location":"uri", "locationName":"phoneNumberId" }, "ProductType":{ "shape":"PhoneNumberProductType", "documentation":"

The product type.

" }, "CallingName":{ "shape":"CallingName", "documentation":"

The outbound calling name associated with the phone number.

" }, "Name":{ "shape":"PhoneNumberName", "documentation":"

Specifies the name assigned to one or more phone numbers.

" } } }, "UpdatePhoneNumberRequestItem":{ "type":"structure", "required":["PhoneNumberId"], "members":{ "PhoneNumberId":{ "shape":"SensitiveNonEmptyString", "documentation":"

The phone number ID to update.

" }, "ProductType":{ "shape":"PhoneNumberProductType", "documentation":"

The product type to update.

" }, "CallingName":{ "shape":"CallingName", "documentation":"

The outbound calling name to update.

" }, "Name":{ "shape":"PhoneNumberName", "documentation":"

The name of the phone number.

" } }, "documentation":"

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

" }, "UpdatePhoneNumberRequestItemList":{ "type":"list", "member":{"shape":"UpdatePhoneNumberRequestItem"} }, "UpdatePhoneNumberResponse":{ "type":"structure", "members":{ "PhoneNumber":{ "shape":"PhoneNumber", "documentation":"

The updated phone number details.

" } } }, "UpdatePhoneNumberSettingsRequest":{ "type":"structure", "required":["CallingName"], "members":{ "CallingName":{ "shape":"CallingName", "documentation":"

The default outbound calling name for the account.

" } } }, "UpdateProxySessionRequest":{ "type":"structure", "required":[ "Capabilities", "VoiceConnectorId", "ProxySessionId" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString128", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "ProxySessionId":{ "shape":"NonEmptyString128", "documentation":"

The proxy session ID.

", "location":"uri", "locationName":"proxySessionId" }, "Capabilities":{ "shape":"CapabilityList", "documentation":"

The proxy session capabilities.

" }, "ExpiryMinutes":{ "shape":"PositiveInteger", "documentation":"

The number of minutes allowed for the proxy session.

" } } }, "UpdateProxySessionResponse":{ "type":"structure", "members":{ "ProxySession":{ "shape":"ProxySession", "documentation":"

The updated proxy session details.

" } } }, "UpdateSipMediaApplicationCallRequest":{ "type":"structure", "required":[ "SipMediaApplicationId", "TransactionId", "Arguments" ], "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The ID of the SIP media application handling the call.

", "location":"uri", "locationName":"sipMediaApplicationId" }, "TransactionId":{ "shape":"NonEmptyString", "documentation":"

The ID of the call transaction.

", "location":"uri", "locationName":"transactionId" }, "Arguments":{ "shape":"SMAUpdateCallArgumentsMap", "documentation":"

Arguments made available to the Lambda function as part of the `CALL_UPDATE_REQUESTED` event. Can contain 0-20 key-value pairs.

" } } }, "UpdateSipMediaApplicationCallResponse":{ "type":"structure", "members":{ "SipMediaApplicationCall":{ "shape":"SipMediaApplicationCall", "documentation":"

A `Call` instance for a SIP media application.

" } } }, "UpdateSipMediaApplicationRequest":{ "type":"structure", "required":["SipMediaApplicationId"], "members":{ "SipMediaApplicationId":{ "shape":"NonEmptyString", "documentation":"

The SIP media application ID.

", "location":"uri", "locationName":"sipMediaApplicationId" }, "Name":{ "shape":"SipMediaApplicationName", "documentation":"

The new name for the specified SIP media application.

" }, "Endpoints":{ "shape":"SipMediaApplicationEndpointList", "documentation":"

The new set of endpoints for the specified SIP media application.

" } } }, "UpdateSipMediaApplicationResponse":{ "type":"structure", "members":{ "SipMediaApplication":{ "shape":"SipMediaApplication", "documentation":"

The updated SIP media application’s details.

" } } }, "UpdateSipRuleRequest":{ "type":"structure", "required":[ "SipRuleId", "Name" ], "members":{ "SipRuleId":{ "shape":"NonEmptyString", "documentation":"

The SIP rule ID.

", "location":"uri", "locationName":"sipRuleId" }, "Name":{ "shape":"SipRuleName", "documentation":"

The new name for the specified SIP rule.

" }, "Disabled":{ "shape":"NullableBoolean", "documentation":"

The new value that indicates whether the rule is disabled.

" }, "TargetApplications":{ "shape":"SipRuleTargetApplicationList", "documentation":"

The new list of target applications.

" } } }, "UpdateSipRuleResponse":{ "type":"structure", "members":{ "SipRule":{ "shape":"SipRule", "documentation":"

The updated SIP rule details.

" } } }, "UpdateVoiceConnectorGroupRequest":{ "type":"structure", "required":[ "VoiceConnectorGroupId", "Name", "VoiceConnectorItems" ], "members":{ "VoiceConnectorGroupId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorGroupId" }, "Name":{ "shape":"VoiceConnectorGroupName", "documentation":"

The name of the Voice Connector group.

" }, "VoiceConnectorItems":{ "shape":"VoiceConnectorItemList", "documentation":"

The `VoiceConnectorItems` to associate with the Voice Connector group.

" } } }, "UpdateVoiceConnectorGroupResponse":{ "type":"structure", "members":{ "VoiceConnectorGroup":{ "shape":"VoiceConnectorGroup", "documentation":"

The updated Voice Connector group.

" } } }, "UpdateVoiceConnectorRequest":{ "type":"structure", "required":[ "VoiceConnectorId", "Name", "RequireEncryption" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

", "location":"uri", "locationName":"voiceConnectorId" }, "Name":{ "shape":"VoiceConnectorName", "documentation":"

The name of the Voice Connector.

" }, "RequireEncryption":{ "shape":"Boolean", "documentation":"

When enabled, requires encryption for the Voice Connector.

" } } }, "UpdateVoiceConnectorResponse":{ "type":"structure", "members":{ "VoiceConnector":{ "shape":"VoiceConnector", "documentation":"

The updated Voice Connector details.

" } } }, "UpdateVoiceProfileDomainRequest":{ "type":"structure", "required":["VoiceProfileDomainId"], "members":{ "VoiceProfileDomainId":{ "shape":"NonEmptyString256", "documentation":"

The domain ID.

", "location":"uri", "locationName":"VoiceProfileDomainId" }, "Name":{ "shape":"VoiceProfileDomainName", "documentation":"

The name of the voice profile domain.

" }, "Description":{ "shape":"VoiceProfileDomainDescription", "documentation":"

The description of the voice profile domain.

" } } }, "UpdateVoiceProfileDomainResponse":{ "type":"structure", "members":{ "VoiceProfileDomain":{ "shape":"VoiceProfileDomain", "documentation":"

The updated details of the voice profile domain.

" } } }, "UpdateVoiceProfileRequest":{ "type":"structure", "required":[ "VoiceProfileId", "SpeakerSearchTaskId" ], "members":{ "VoiceProfileId":{ "shape":"NonEmptyString256", "documentation":"

The profile ID.

", "location":"uri", "locationName":"VoiceProfileId" }, "SpeakerSearchTaskId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the speaker search task.

" } } }, "UpdateVoiceProfileResponse":{ "type":"structure", "members":{ "VoiceProfile":{ "shape":"VoiceProfile", "documentation":"

The updated voice profile settings.

" } } }, "ValidateE911AddressRequest":{ "type":"structure", "required":[ "AwsAccountId", "StreetNumber", "StreetInfo", "City", "State", "Country", "PostalCode" ], "members":{ "AwsAccountId":{ "shape":"NonEmptyString", "documentation":"

The AWS account ID.

" }, "StreetNumber":{ "shape":"SensitiveNonEmptyString", "documentation":"

The address street number, such as `200` or `2121`.

" }, "StreetInfo":{ "shape":"SensitiveNonEmptyString", "documentation":"

The address street information, such as `8th Avenue`.

" }, "City":{ "shape":"SensitiveNonEmptyString", "documentation":"

The address city, such as `Portland`.

" }, "State":{ "shape":"SensitiveNonEmptyString", "documentation":"

The address state, such as `ME`.

" }, "Country":{ "shape":"SensitiveNonEmptyString", "documentation":"

The country in the address being validated.

" }, "PostalCode":{ "shape":"SensitiveNonEmptyString", "documentation":"

The dress postal code, such `04352`.

" } } }, "ValidateE911AddressResponse":{ "type":"structure", "members":{ "ValidationResult":{ "shape":"ValidationResult", "documentation":"

Number indicating the result of address validation. `0` means the address was perfect as-is and successfully validated. `1` means the address was corrected. `2` means the address sent was not close enough and was not validated.

" }, "AddressExternalId":{ "shape":"String", "documentation":"

The ID that represents the address.

" }, "Address":{ "shape":"Address", "documentation":"

The validated address.

" }, "CandidateAddressList":{ "shape":"CandidateAddressList", "documentation":"

The list of address suggestions..

" } } }, "ValidationResult":{ "type":"integer", "max":2, "min":0 }, "VoiceConnector":{ "type":"structure", "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector's ID.

" }, "AwsRegion":{ "shape":"VoiceConnectorAwsRegion", "documentation":"

The AWS Region in which the Voice Connector is created. Default: us-east-1.

" }, "Name":{ "shape":"VoiceConnectorName", "documentation":"

The Voice Connector's name.

" }, "OutboundHostName":{ "shape":"String", "documentation":"

The outbound host name for the Voice Connector.

" }, "RequireEncryption":{ "shape":"Boolean", "documentation":"

Enables or disables encryption for the Voice Connector.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The Voice Connector's creation timestamp, in ISO 8601 format.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The Voice Connector's updated timestamp, in ISO 8601 format.

" }, "VoiceConnectorArn":{ "shape":"NonEmptyString", "documentation":"

The ARN of the Voice Connector.

" } }, "documentation":"

The Amazon Chime SDK Voice Connector configuration, including outbound host name and encryption settings.

" }, "VoiceConnectorAwsRegion":{ "type":"string", "enum":[ "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2" ] }, "VoiceConnectorAwsRegionList":{ "type":"list", "member":{"shape":"VoiceConnectorAwsRegion"} }, "VoiceConnectorGroup":{ "type":"structure", "members":{ "VoiceConnectorGroupId":{ "shape":"NonEmptyString", "documentation":"

The ID of a Voice Connector group.

" }, "Name":{ "shape":"VoiceConnectorGroupName", "documentation":"

The name of a Voice Connector group.

" }, "VoiceConnectorItems":{ "shape":"VoiceConnectorItemList", "documentation":"

The Voice Connectors to which you route inbound calls.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The Voice Connector group's creation time stamp, in ISO 8601 format.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The Voice Connector group's creation time stamp, in ISO 8601 format.

" }, "VoiceConnectorGroupArn":{ "shape":"NonEmptyString", "documentation":"

The ARN of the Voice Connector group.

" } }, "documentation":"

The Amazon Chime SDK Voice Connector group configuration, including associated Voice Connectors. You can include Voice Connectors from different AWS Regions in a group. This creates a fault tolerant mechanism for fallback in case of availability events.

" }, "VoiceConnectorGroupList":{ "type":"list", "member":{"shape":"VoiceConnectorGroup"} }, "VoiceConnectorGroupName":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9 _.-]+" }, "VoiceConnectorItem":{ "type":"structure", "required":[ "VoiceConnectorId", "Priority" ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", "documentation":"

The Voice Connector ID.

" }, "Priority":{ "shape":"VoiceConnectorItemPriority", "documentation":"

The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

" } }, "documentation":"

For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

" }, "VoiceConnectorItemList":{ "type":"list", "member":{"shape":"VoiceConnectorItem"} }, "VoiceConnectorItemPriority":{ "type":"integer", "max":99, "min":1 }, "VoiceConnectorList":{ "type":"list", "member":{"shape":"VoiceConnector"} }, "VoiceConnectorName":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9 _.-]+" }, "VoiceConnectorSettings":{ "type":"structure", "members":{ "CdrBucket":{ "shape":"String", "documentation":"

The S3 bucket that stores the Voice Connector's call detail records.

" } }, "documentation":"

The Amazon Chime SDK Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.

" }, "VoiceProfile":{ "type":"structure", "members":{ "VoiceProfileId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the voice profile.

" }, "VoiceProfileArn":{ "shape":"Arn", "documentation":"

The ARN of the voice profile.

" }, "VoiceProfileDomainId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the domain that contains the voice profile.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which the voice profile was created and enrolled.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which the voice profile was last updated.

" }, "ExpirationTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which a voice profile expires unless you re-enroll the caller via the `UpdateVoiceProfile` API.

" } }, "documentation":"

The combination of a voice print and caller ID.

" }, "VoiceProfileDomain":{ "type":"structure", "members":{ "VoiceProfileDomainId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the voice profile domain.

" }, "VoiceProfileDomainArn":{ "shape":"Arn", "documentation":"

The voice profile domain's Amazon Resource Number (ARN).

" }, "Name":{ "shape":"VoiceProfileDomainName", "documentation":"

The name of the voice profile domain.

" }, "Description":{ "shape":"VoiceProfileDomainDescription", "documentation":"

The description of the voice profile domain.

" }, "ServerSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", "documentation":"

A structure that contains the configuration settings for server-side encryption.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which the voice profile domain was created.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which the voice profile was last updated.

" } }, "documentation":"

A collection of voice profiles.

" }, "VoiceProfileDomainDescription":{ "type":"string", "max":1024, "min":0 }, "VoiceProfileDomainName":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9 _.-]+" }, "VoiceProfileDomainSummary":{ "type":"structure", "members":{ "VoiceProfileDomainId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the voice profile domain summary.

" }, "VoiceProfileDomainArn":{ "shape":"Arn", "documentation":"

The ARN of a voice profile in a voice profile domain summary.

" }, "Name":{ "shape":"VoiceProfileDomainName", "documentation":"

The name of the voice profile domain summary.

" }, "Description":{ "shape":"VoiceProfileDomainDescription", "documentation":"

Describes the voice profile domain summary.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which the voice profile domain summary was created.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which the voice profile domain summary was last updated.

" } }, "documentation":"

A high-level overview of a voice profile domain.

" }, "VoiceProfileDomainSummaryList":{ "type":"list", "member":{"shape":"VoiceProfileDomainSummary"} }, "VoiceProfileSummary":{ "type":"structure", "members":{ "VoiceProfileId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the voice profile in a voice profile summary.

" }, "VoiceProfileArn":{ "shape":"Arn", "documentation":"

The ARN of the voice profile in a voice profile summary.

" }, "VoiceProfileDomainId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the voice profile domain in a voice profile summary.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which a voice profile summary was created.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which a voice profile summary was last updated.

" }, "ExpirationTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

Extends the life of the voice profile. You can use `UpdateVoiceProfile` to refresh an existing voice profile's voice print and extend the life of the summary.

" } }, "documentation":"

A high-level summary of a voice profile.

" }, "VoiceProfileSummaryList":{ "type":"list", "member":{"shape":"VoiceProfileSummary"} }, "VoiceToneAnalysisTask":{ "type":"structure", "members":{ "VoiceToneAnalysisTaskId":{ "shape":"NonEmptyString256", "documentation":"

The ID of the voice tone analysis task.

" }, "VoiceToneAnalysisTaskStatus":{ "shape":"NonEmptyString", "documentation":"

The status of a voice tone analysis task, `IN_QUEUE`, `IN_PROGRESS`, `PARTIAL_SUCCESS`, `SUCCEEDED`, `FAILED`, or `STOPPED`.

" }, "CallDetails":{ "shape":"CallDetails", "documentation":"

The call details of a voice tone analysis task.

" }, "CreatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which a voice tone analysis task was created.

" }, "UpdatedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which a voice tone analysis task was updated.

" }, "StartedTimestamp":{ "shape":"Iso8601Timestamp", "documentation":"

The time at which a voice tone analysis task started.

" }, "StatusMessage":{ "shape":"String", "documentation":"

The status of a voice tone analysis task.

" } }, "documentation":"

A representation of an asynchronous request to perform voice tone analysis on a Voice Connector call.

" } }, "documentation":"

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.

" }