@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonChimeSDKVoice
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonChimeSDKVoice
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociatePhoneNumbersWithVoiceConnectorResult |
associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest associatePhoneNumbersWithVoiceConnectorRequest)
Associates phone numbers with the specified Amazon Chime SDK Voice Connector.
|
AssociatePhoneNumbersWithVoiceConnectorGroupResult |
associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest associatePhoneNumbersWithVoiceConnectorGroupRequest)
Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.
|
BatchDeletePhoneNumberResult |
batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest)
Moves phone numbers into the Deletion queue.
|
BatchUpdatePhoneNumberResult |
batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest)
Updates phone number product types, calling names, or phone number names.
|
CreatePhoneNumberOrderResult |
createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest)
Creates an order for phone numbers to be provisioned.
|
CreateProxySessionResult |
createProxySession(CreateProxySessionRequest createProxySessionRequest)
Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone
numbers.
|
CreateSipMediaApplicationResult |
createSipMediaApplication(CreateSipMediaApplicationRequest createSipMediaApplicationRequest)
Creates a SIP media application.
|
CreateSipMediaApplicationCallResult |
createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest createSipMediaApplicationCallRequest)
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 . |
CreateSipRuleResult |
createSipRule(CreateSipRuleRequest createSipRuleRequest)
Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type.
|
CreateVoiceConnectorResult |
createVoiceConnector(CreateVoiceConnectorRequest createVoiceConnectorRequest)
Creates an Amazon Chime SDK Voice Connector.
|
CreateVoiceConnectorGroupResult |
createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest createVoiceConnectorGroupRequest)
Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account.
|
CreateVoiceProfileResult |
createVoiceProfile(CreateVoiceProfileRequest createVoiceProfileRequest)
Creates a voice profile, which consists of an enrolled user and their latest voice print.
|
CreateVoiceProfileDomainResult |
createVoiceProfileDomain(CreateVoiceProfileDomainRequest createVoiceProfileDomainRequest)
Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment
audio.
|
DeletePhoneNumberResult |
deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest)
Moves the specified phone number into the Deletion queue.
|
DeleteProxySessionResult |
deleteProxySession(DeleteProxySessionRequest deleteProxySessionRequest)
Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.
|
DeleteSipMediaApplicationResult |
deleteSipMediaApplication(DeleteSipMediaApplicationRequest deleteSipMediaApplicationRequest)
Deletes a SIP media application.
|
DeleteSipRuleResult |
deleteSipRule(DeleteSipRuleRequest deleteSipRuleRequest)
Deletes a SIP rule.
|
DeleteVoiceConnectorResult |
deleteVoiceConnector(DeleteVoiceConnectorRequest deleteVoiceConnectorRequest)
Deletes an Amazon Chime SDK Voice Connector.
|
DeleteVoiceConnectorEmergencyCallingConfigurationResult |
deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest deleteVoiceConnectorEmergencyCallingConfigurationRequest)
Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.
|
DeleteVoiceConnectorGroupResult |
deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest deleteVoiceConnectorGroupRequest)
Deletes an Amazon Chime SDK Voice Connector group.
|
DeleteVoiceConnectorOriginationResult |
deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest deleteVoiceConnectorOriginationRequest)
Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.
|
DeleteVoiceConnectorProxyResult |
deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest deleteVoiceConnectorProxyRequest)
Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.
|
DeleteVoiceConnectorStreamingConfigurationResult |
deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest deleteVoiceConnectorStreamingConfigurationRequest)
Deletes a Voice Connector's streaming configuration.
|
DeleteVoiceConnectorTerminationResult |
deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest deleteVoiceConnectorTerminationRequest)
Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.
|
DeleteVoiceConnectorTerminationCredentialsResult |
deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest deleteVoiceConnectorTerminationCredentialsRequest)
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
|
DeleteVoiceProfileResult |
deleteVoiceProfile(DeleteVoiceProfileRequest deleteVoiceProfileRequest)
Deletes a voice profile, including its voice print and enrollment data.
|
DeleteVoiceProfileDomainResult |
deleteVoiceProfileDomain(DeleteVoiceProfileDomainRequest deleteVoiceProfileDomainRequest)
Deletes all voice profiles in the domain.
|
DisassociatePhoneNumbersFromVoiceConnectorResult |
disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest disassociatePhoneNumbersFromVoiceConnectorRequest)
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.
|
DisassociatePhoneNumbersFromVoiceConnectorGroupResult |
disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest disassociatePhoneNumbersFromVoiceConnectorGroupRequest)
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetGlobalSettingsResult |
getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest)
Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
|
GetPhoneNumberResult |
getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
|
GetPhoneNumberOrderResult |
getPhoneNumberOrder(GetPhoneNumberOrderRequest getPhoneNumberOrderRequest)
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.
|
GetPhoneNumberSettingsResult |
getPhoneNumberSettings(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest)
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling
name.
|
GetProxySessionResult |
getProxySession(GetProxySessionRequest getProxySessionRequest)
Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.
|
GetSipMediaApplicationResult |
getSipMediaApplication(GetSipMediaApplicationRequest getSipMediaApplicationRequest)
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
|
GetSipMediaApplicationAlexaSkillConfigurationResult |
getSipMediaApplicationAlexaSkillConfiguration(GetSipMediaApplicationAlexaSkillConfigurationRequest getSipMediaApplicationAlexaSkillConfigurationRequest)
Deprecated.
|
GetSipMediaApplicationLoggingConfigurationResult |
getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest getSipMediaApplicationLoggingConfigurationRequest)
Retrieves the logging configuration for the specified SIP media application.
|
GetSipRuleResult |
getSipRule(GetSipRuleRequest getSipRuleRequest)
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
|
GetSpeakerSearchTaskResult |
getSpeakerSearchTask(GetSpeakerSearchTaskRequest getSpeakerSearchTaskRequest)
Retrieves the details of the specified speaker search task.
|
GetVoiceConnectorResult |
getVoiceConnector(GetVoiceConnectorRequest getVoiceConnectorRequest)
Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and
encryption requirements.
|
GetVoiceConnectorEmergencyCallingConfigurationResult |
getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest getVoiceConnectorEmergencyCallingConfigurationRequest)
Retrieves the emergency calling configuration details for the specified Voice Connector.
|
GetVoiceConnectorGroupResult |
getVoiceConnectorGroup(GetVoiceConnectorGroupRequest getVoiceConnectorGroupRequest)
Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and
associated
VoiceConnectorItems . |
GetVoiceConnectorLoggingConfigurationResult |
getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest getVoiceConnectorLoggingConfigurationRequest)
Retrieves the logging configuration settings for the specified Voice Connector.
|
GetVoiceConnectorOriginationResult |
getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest getVoiceConnectorOriginationRequest)
Retrieves the origination settings for the specified Voice Connector.
|
GetVoiceConnectorProxyResult |
getVoiceConnectorProxy(GetVoiceConnectorProxyRequest getVoiceConnectorProxyRequest)
Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.
|
GetVoiceConnectorStreamingConfigurationResult |
getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest getVoiceConnectorStreamingConfigurationRequest)
Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector.
|
GetVoiceConnectorTerminationResult |
getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest getVoiceConnectorTerminationRequest)
Retrieves the termination setting details for the specified Voice Connector.
|
GetVoiceConnectorTerminationHealthResult |
getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest getVoiceConnectorTerminationHealthRequest)
Retrieves information about the last time a
SIP OPTIONS ping was received from your SIP
infrastructure for the specified Amazon Chime SDK Voice Connector. |
GetVoiceProfileResult |
getVoiceProfile(GetVoiceProfileRequest getVoiceProfileRequest)
Retrieves the details of the specified voice profile.
|
GetVoiceProfileDomainResult |
getVoiceProfileDomain(GetVoiceProfileDomainRequest getVoiceProfileDomainRequest)
Retrieves the details of the specified voice profile domain.
|
GetVoiceToneAnalysisTaskResult |
getVoiceToneAnalysisTask(GetVoiceToneAnalysisTaskRequest getVoiceToneAnalysisTaskRequest)
Retrieves the details of a voice tone analysis task.
|
ListAvailableVoiceConnectorRegionsResult |
listAvailableVoiceConnectorRegions(ListAvailableVoiceConnectorRegionsRequest listAvailableVoiceConnectorRegionsRequest)
Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.
|
ListPhoneNumberOrdersResult |
listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest)
Lists the phone numbers for an administrator's Amazon Chime SDK account.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
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.
|
ListProxySessionsResult |
listProxySessions(ListProxySessionsRequest listProxySessionsRequest)
Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.
|
ListSipMediaApplicationsResult |
listSipMediaApplications(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest)
Lists the SIP media applications under the administrator's AWS account.
|
ListSipRulesResult |
listSipRules(ListSipRulesRequest listSipRulesRequest)
Lists the SIP rules under the administrator's AWS account.
|
ListSupportedPhoneNumberCountriesResult |
listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest)
Lists the countries that you can order phone numbers from.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags in a given resource.
|
ListVoiceConnectorGroupsResult |
listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest)
Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.
|
ListVoiceConnectorsResult |
listVoiceConnectors(ListVoiceConnectorsRequest listVoiceConnectorsRequest)
Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
|
ListVoiceConnectorTerminationCredentialsResult |
listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest listVoiceConnectorTerminationCredentialsRequest)
Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.
|
ListVoiceProfileDomainsResult |
listVoiceProfileDomains(ListVoiceProfileDomainsRequest listVoiceProfileDomainsRequest)
Lists the specified voice profile domains in the administrator's AWS account.
|
ListVoiceProfilesResult |
listVoiceProfiles(ListVoiceProfilesRequest listVoiceProfilesRequest)
Lists the voice profiles in a voice profile domain.
|
PutSipMediaApplicationAlexaSkillConfigurationResult |
putSipMediaApplicationAlexaSkillConfiguration(PutSipMediaApplicationAlexaSkillConfigurationRequest putSipMediaApplicationAlexaSkillConfigurationRequest)
Deprecated.
|
PutSipMediaApplicationLoggingConfigurationResult |
putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest putSipMediaApplicationLoggingConfigurationRequest)
Updates the logging configuration for the specified SIP media application.
|
PutVoiceConnectorEmergencyCallingConfigurationResult |
putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest putVoiceConnectorEmergencyCallingConfigurationRequest)
Updates a Voice Connector's emergency calling configuration.
|
PutVoiceConnectorLoggingConfigurationResult |
putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest putVoiceConnectorLoggingConfigurationRequest)
Updates a Voice Connector's logging configuration.
|
PutVoiceConnectorOriginationResult |
putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest putVoiceConnectorOriginationRequest)
Updates a Voice Connector's origination settings.
|
PutVoiceConnectorProxyResult |
putVoiceConnectorProxy(PutVoiceConnectorProxyRequest putVoiceConnectorProxyRequest)
Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.
|
PutVoiceConnectorStreamingConfigurationResult |
putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest putVoiceConnectorStreamingConfigurationRequest)
Updates a Voice Connector's streaming configuration settings.
|
PutVoiceConnectorTerminationResult |
putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest putVoiceConnectorTerminationRequest)
Updates a Voice Connector's termination settings.
|
PutVoiceConnectorTerminationCredentialsResult |
putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest putVoiceConnectorTerminationCredentialsRequest)
Updates a Voice Connector's termination credentials.
|
RestorePhoneNumberResult |
restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest)
Restores a deleted phone number.
|
SearchAvailablePhoneNumbersResult |
searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
Searches the provisioned phone numbers in an organization.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartSpeakerSearchTaskResult |
startSpeakerSearchTask(StartSpeakerSearchTaskRequest startSpeakerSearchTaskRequest)
Starts a speaker search task.
|
StartVoiceToneAnalysisTaskResult |
startVoiceToneAnalysisTask(StartVoiceToneAnalysisTaskRequest startVoiceToneAnalysisTaskRequest)
Starts a voice tone analysis task.
|
StopSpeakerSearchTaskResult |
stopSpeakerSearchTask(StopSpeakerSearchTaskRequest stopSpeakerSearchTaskRequest)
Stops a speaker search task.
|
StopVoiceToneAnalysisTaskResult |
stopVoiceToneAnalysisTask(StopVoiceToneAnalysisTaskRequest stopVoiceToneAnalysisTaskRequest)
Stops a voice tone analysis task.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds a tag to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource.
|
UpdateGlobalSettingsResult |
updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
|
UpdatePhoneNumberResult |
updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)
Updates phone number details, such as product type, calling name, or phone number name for the specified phone
number ID.
|
UpdatePhoneNumberSettingsResult |
updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest)
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
|
UpdateProxySessionResult |
updateProxySession(UpdateProxySessionRequest updateProxySessionRequest)
Updates the specified proxy session details, such as voice or SMS capabilities.
|
UpdateSipMediaApplicationResult |
updateSipMediaApplication(UpdateSipMediaApplicationRequest updateSipMediaApplicationRequest)
Updates the details of the specified SIP media application.
|
UpdateSipMediaApplicationCallResult |
updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest updateSipMediaApplicationCallRequest)
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update
request.
|
UpdateSipRuleResult |
updateSipRule(UpdateSipRuleRequest updateSipRuleRequest)
Updates the details of the specified SIP rule.
|
UpdateVoiceConnectorResult |
updateVoiceConnector(UpdateVoiceConnectorRequest updateVoiceConnectorRequest)
Updates the details for the specified Amazon Chime SDK Voice Connector.
|
UpdateVoiceConnectorGroupResult |
updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest updateVoiceConnectorGroupRequest)
Updates the settings for the specified Amazon Chime SDK Voice Connector group.
|
UpdateVoiceProfileResult |
updateVoiceProfile(UpdateVoiceProfileRequest updateVoiceProfileRequest)
Updates the specified voice profile’s voice print and refreshes its expiration timestamp.
|
UpdateVoiceProfileDomainResult |
updateVoiceProfileDomain(UpdateVoiceProfileDomainRequest updateVoiceProfileDomainRequest)
Updates the settings for the specified voice profile domain.
|
ValidateE911AddressResult |
validateE911Address(ValidateE911AddressRequest validateE911AddressRequest)
Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors.
|
static final String ENDPOINT_PREFIX
AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest associatePhoneNumbersWithVoiceConnectorRequest)
Associates phone numbers with the specified Amazon Chime SDK Voice Connector.
associatePhoneNumbersWithVoiceConnectorRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.AccessDeniedException
- You don't have the permissions needed to run this action.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.AssociatePhoneNumbersWithVoiceConnectorGroupResult associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest associatePhoneNumbersWithVoiceConnectorGroupRequest)
Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.
associatePhoneNumbersWithVoiceConnectorGroupRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.AccessDeniedException
- You don't have the permissions needed to run this action.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.BatchDeletePhoneNumberResult batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest)
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.
batchDeletePhoneNumberRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.BatchUpdatePhoneNumberResult batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest)
Updates phone number product types, calling names, or phone number names. You can update one attribute at a time
for each UpdatePhoneNumberRequestItem
. For example, you can update the product type, the calling
name, or phone name.
You cannot have a duplicate phoneNumberId
in a request.
batchUpdatePhoneNumberRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest)
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.
createPhoneNumberOrderRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.UnauthorizedClientException
- The client isn't authorized to request a resource.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ResourceLimitExceededException
- The request exceeds the resource limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.CreateProxySessionResult createProxySession(CreateProxySessionRequest createProxySessionRequest)
Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.
createProxySessionRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.CreateSipMediaApplicationResult createSipMediaApplication(CreateSipMediaApplicationRequest createSipMediaApplicationRequest)
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.
createSipMediaApplicationRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.UnauthorizedClientException
- The client isn't authorized to request a resource.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ResourceLimitExceededException
- The request exceeds the resource limit.ConflictException
- Multiple instances of the same request were made simultaneously.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.CreateSipMediaApplicationCallResult createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest createSipMediaApplicationCallRequest)
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
.
createSipMediaApplicationCallRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.ResourceLimitExceededException
- The request exceeds the resource limit.ThrottledClientException
- The number of customer requests exceeds the request rate limit.UnauthorizedClientException
- The client isn't authorized to request a resource.AccessDeniedException
- You don't have the permissions needed to run this action.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.CreateSipRuleResult createSipRule(CreateSipRuleRequest createSipRuleRequest)
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.
createSipRuleRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.UnauthorizedClientException
- The client isn't authorized to request a resource.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ResourceLimitExceededException
- The request exceeds the resource limit.ConflictException
- Multiple instances of the same request were made simultaneously.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.CreateVoiceConnectorResult createVoiceConnector(CreateVoiceConnectorRequest createVoiceConnectorRequest)
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.
createVoiceConnectorRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.UnauthorizedClientException
- The client isn't authorized to request a resource.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ResourceLimitExceededException
- The request exceeds the resource limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.CreateVoiceConnectorGroupResult createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest createVoiceConnectorGroupRequest)
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.
createVoiceConnectorGroupRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.UnauthorizedClientException
- The client isn't authorized to request a resource.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ResourceLimitExceededException
- The request exceeds the resource limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.CreateVoiceProfileResult createVoiceProfile(CreateVoiceProfileRequest createVoiceProfileRequest)
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.
createVoiceProfileRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ResourceLimitExceededException
- The request exceeds the resource limit.UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.NotFoundException
- The requested resource couldn't be found.ConflictException
- Multiple instances of the same request were made simultaneously.GoneException
- Access to the target resource is no longer available at the origin server. This condition is likely to be
permanent.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.CreateVoiceProfileDomainResult createVoiceProfileDomain(CreateVoiceProfileDomainRequest createVoiceProfileDomainRequest)
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.
createVoiceProfileDomainRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.ConflictException
- Multiple instances of the same request were made simultaneously.UnauthorizedClientException
- The client isn't authorized to request a resource.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ResourceLimitExceededException
- The request exceeds the resource limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeletePhoneNumberResult deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest)
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.
deletePhoneNumberRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteProxySessionResult deleteProxySession(DeleteProxySessionRequest deleteProxySessionRequest)
Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.
deleteProxySessionRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteSipMediaApplicationResult deleteSipMediaApplication(DeleteSipMediaApplicationRequest deleteSipMediaApplicationRequest)
Deletes a SIP media application.
deleteSipMediaApplicationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteSipRuleResult deleteSipRule(DeleteSipRuleRequest deleteSipRuleRequest)
Deletes a SIP rule.
deleteSipRuleRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteVoiceConnectorResult deleteVoiceConnector(DeleteVoiceConnectorRequest deleteVoiceConnectorRequest)
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.
deleteVoiceConnectorRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteVoiceConnectorEmergencyCallingConfigurationResult deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest deleteVoiceConnectorEmergencyCallingConfigurationRequest)
Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.
deleteVoiceConnectorEmergencyCallingConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteVoiceConnectorGroupResult deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest deleteVoiceConnectorGroupRequest)
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.
deleteVoiceConnectorGroupRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest deleteVoiceConnectorOriginationRequest)
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.
deleteVoiceConnectorOriginationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteVoiceConnectorProxyResult deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest deleteVoiceConnectorProxyRequest)
Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.
deleteVoiceConnectorProxyRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteVoiceConnectorStreamingConfigurationResult deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest deleteVoiceConnectorStreamingConfigurationRequest)
Deletes a Voice Connector's streaming configuration.
deleteVoiceConnectorStreamingConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteVoiceConnectorTerminationResult deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest deleteVoiceConnectorTerminationRequest)
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.
deleteVoiceConnectorTerminationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest deleteVoiceConnectorTerminationCredentialsRequest)
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
deleteVoiceConnectorTerminationCredentialsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteVoiceProfileResult deleteVoiceProfile(DeleteVoiceProfileRequest deleteVoiceProfileRequest)
Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.
deleteVoiceProfileRequest
- BadRequestException
- The input parameters don't match the service's restrictions.UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.NotFoundException
- The requested resource couldn't be found.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DeleteVoiceProfileDomainResult deleteVoiceProfileDomain(DeleteVoiceProfileDomainRequest deleteVoiceProfileDomainRequest)
Deletes all voice profiles in the domain. WARNING: This action is not reversible.
deleteVoiceProfileDomainRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.BadRequestException
- The input parameters don't match the service's restrictions.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest disassociatePhoneNumbersFromVoiceConnectorRequest)
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.
disassociatePhoneNumbersFromVoiceConnectorRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.DisassociatePhoneNumbersFromVoiceConnectorGroupResult disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest disassociatePhoneNumbersFromVoiceConnectorGroupRequest)
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.
disassociatePhoneNumbersFromVoiceConnectorGroupRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest)
Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
getGlobalSettingsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetPhoneNumberResult getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
getPhoneNumberRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetPhoneNumberOrderResult getPhoneNumberOrder(GetPhoneNumberOrderRequest getPhoneNumberOrderRequest)
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.
getPhoneNumberOrderRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetPhoneNumberSettingsResult getPhoneNumberSettings(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest)
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
getPhoneNumberSettingsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetProxySessionResult getProxySession(GetProxySessionRequest getProxySessionRequest)
Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.
getProxySessionRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetSipMediaApplicationResult getSipMediaApplication(GetSipMediaApplicationRequest getSipMediaApplicationRequest)
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
getSipMediaApplicationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.@Deprecated GetSipMediaApplicationAlexaSkillConfigurationResult getSipMediaApplicationAlexaSkillConfiguration(GetSipMediaApplicationAlexaSkillConfigurationRequest getSipMediaApplicationAlexaSkillConfigurationRequest)
Gets the Alexa Skill configuration for the SIP media application.
Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.
getSipMediaApplicationAlexaSkillConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetSipMediaApplicationLoggingConfigurationResult getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest getSipMediaApplicationLoggingConfigurationRequest)
Retrieves the logging configuration for the specified SIP media application.
getSipMediaApplicationLoggingConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetSipRuleResult getSipRule(GetSipRuleRequest getSipRuleRequest)
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
getSipRuleRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetSpeakerSearchTaskResult getSpeakerSearchTask(GetSpeakerSearchTaskRequest getSpeakerSearchTaskRequest)
Retrieves the details of the specified speaker search task.
getSpeakerSearchTaskRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.NotFoundException
- The requested resource couldn't be found.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.AccessDeniedException
- You don't have the permissions needed to run this action.UnauthorizedClientException
- The client isn't authorized to request a resource.ServiceFailureException
- The service encountered an unexpected error.ServiceUnavailableException
- The service is currently unavailable.GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest getVoiceConnectorRequest)
Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
getVoiceConnectorRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceConnectorEmergencyCallingConfigurationResult getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest getVoiceConnectorEmergencyCallingConfigurationRequest)
Retrieves the emergency calling configuration details for the specified Voice Connector.
getVoiceConnectorEmergencyCallingConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceConnectorGroupResult getVoiceConnectorGroup(GetVoiceConnectorGroupRequest getVoiceConnectorGroupRequest)
Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and
associated VoiceConnectorItems
.
getVoiceConnectorGroupRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceConnectorLoggingConfigurationResult getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest getVoiceConnectorLoggingConfigurationRequest)
Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
getVoiceConnectorLoggingConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest getVoiceConnectorOriginationRequest)
Retrieves the origination settings for the specified Voice Connector.
getVoiceConnectorOriginationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceConnectorProxyResult getVoiceConnectorProxy(GetVoiceConnectorProxyRequest getVoiceConnectorProxyRequest)
Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.
getVoiceConnectorProxyRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceConnectorStreamingConfigurationResult getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest getVoiceConnectorStreamingConfigurationRequest)
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.
getVoiceConnectorStreamingConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest getVoiceConnectorTerminationRequest)
Retrieves the termination setting details for the specified Voice Connector.
getVoiceConnectorTerminationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceConnectorTerminationHealthResult getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest getVoiceConnectorTerminationHealthRequest)
Retrieves information about the last time a SIP OPTIONS
ping was received from your SIP
infrastructure for the specified Amazon Chime SDK Voice Connector.
getVoiceConnectorTerminationHealthRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceProfileResult getVoiceProfile(GetVoiceProfileRequest getVoiceProfileRequest)
Retrieves the details of the specified voice profile.
getVoiceProfileRequest
- BadRequestException
- The input parameters don't match the service's restrictions.UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.NotFoundException
- The requested resource couldn't be found.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceProfileDomainResult getVoiceProfileDomain(GetVoiceProfileDomainRequest getVoiceProfileDomainRequest)
Retrieves the details of the specified voice profile domain.
getVoiceProfileDomainRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.GetVoiceToneAnalysisTaskResult getVoiceToneAnalysisTask(GetVoiceToneAnalysisTaskRequest getVoiceToneAnalysisTaskRequest)
Retrieves the details of a voice tone analysis task.
getVoiceToneAnalysisTaskRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.NotFoundException
- The requested resource couldn't be found.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.AccessDeniedException
- You don't have the permissions needed to run this action.UnauthorizedClientException
- The client isn't authorized to request a resource.ServiceFailureException
- The service encountered an unexpected error.ServiceUnavailableException
- The service is currently unavailable.ListAvailableVoiceConnectorRegionsResult listAvailableVoiceConnectorRegions(ListAvailableVoiceConnectorRegionsRequest listAvailableVoiceConnectorRegionsRequest)
Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.
listAvailableVoiceConnectorRegionsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest)
Lists the phone numbers for an administrator's Amazon Chime SDK account.
listPhoneNumberOrdersRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
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.
listPhoneNumbersRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.NotFoundException
- The requested resource couldn't be found.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListProxySessionsResult listProxySessions(ListProxySessionsRequest listProxySessionsRequest)
Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.
listProxySessionsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListSipMediaApplicationsResult listSipMediaApplications(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest)
Lists the SIP media applications under the administrator's AWS account.
listSipMediaApplicationsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListSipRulesResult listSipRules(ListSipRulesRequest listSipRulesRequest)
Lists the SIP rules under the administrator's AWS account.
listSipRulesRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListSupportedPhoneNumberCountriesResult listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest)
Lists the countries that you can order phone numbers from.
listSupportedPhoneNumberCountriesRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.UnauthorizedClientException
- The client isn't authorized to request a resource.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags in a given resource.
listTagsForResourceRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.NotFoundException
- The requested resource couldn't be found.UnauthorizedClientException
- The client isn't authorized to request a resource.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListVoiceConnectorGroupsResult listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest)
Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.
listVoiceConnectorGroupsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest listVoiceConnectorTerminationCredentialsRequest)
Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.
listVoiceConnectorTerminationCredentialsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest listVoiceConnectorsRequest)
Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
listVoiceConnectorsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListVoiceProfileDomainsResult listVoiceProfileDomains(ListVoiceProfileDomainsRequest listVoiceProfileDomainsRequest)
Lists the specified voice profile domains in the administrator's AWS account.
listVoiceProfileDomainsRequest
- NotFoundException
- The requested resource couldn't be found.UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ListVoiceProfilesResult listVoiceProfiles(ListVoiceProfilesRequest listVoiceProfilesRequest)
Lists the voice profiles in a voice profile domain.
listVoiceProfilesRequest
- NotFoundException
- The requested resource couldn't be found.UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.@Deprecated PutSipMediaApplicationAlexaSkillConfigurationResult putSipMediaApplicationAlexaSkillConfiguration(PutSipMediaApplicationAlexaSkillConfigurationRequest putSipMediaApplicationAlexaSkillConfigurationRequest)
Updates the Alexa Skill configuration for the SIP media application.
Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.
putSipMediaApplicationAlexaSkillConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.PutSipMediaApplicationLoggingConfigurationResult putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest putSipMediaApplicationLoggingConfigurationRequest)
Updates the logging configuration for the specified SIP media application.
putSipMediaApplicationLoggingConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.PutVoiceConnectorEmergencyCallingConfigurationResult putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest putVoiceConnectorEmergencyCallingConfigurationRequest)
Updates a Voice Connector's emergency calling configuration.
putVoiceConnectorEmergencyCallingConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.PutVoiceConnectorLoggingConfigurationResult putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest putVoiceConnectorLoggingConfigurationRequest)
Updates a Voice Connector's logging configuration.
putVoiceConnectorLoggingConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest putVoiceConnectorOriginationRequest)
Updates a Voice Connector's origination settings.
putVoiceConnectorOriginationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.PutVoiceConnectorProxyResult putVoiceConnectorProxy(PutVoiceConnectorProxyRequest putVoiceConnectorProxyRequest)
Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.
putVoiceConnectorProxyRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.AccessDeniedException
- You don't have the permissions needed to run this action.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.PutVoiceConnectorStreamingConfigurationResult putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest putVoiceConnectorStreamingConfigurationRequest)
Updates a Voice Connector's streaming configuration settings.
putVoiceConnectorStreamingConfigurationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.PutVoiceConnectorTerminationResult putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest putVoiceConnectorTerminationRequest)
Updates a Voice Connector's termination settings.
putVoiceConnectorTerminationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.AccessDeniedException
- You don't have the permissions needed to run this action.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest putVoiceConnectorTerminationCredentialsRequest)
Updates a Voice Connector's termination credentials.
putVoiceConnectorTerminationCredentialsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest)
Restores a deleted phone number.
restorePhoneNumberRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ResourceLimitExceededException
- The request exceeds the resource limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
Searches the provisioned phone numbers in an organization.
searchAvailablePhoneNumbersRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.UnauthorizedClientException
- The client isn't authorized to request a resource.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.StartSpeakerSearchTaskResult startSpeakerSearchTask(StartSpeakerSearchTaskRequest startSpeakerSearchTaskRequest)
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.
startSpeakerSearchTaskRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ResourceLimitExceededException
- The request exceeds the resource limit.UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.NotFoundException
- The requested resource couldn't be found.ConflictException
- Multiple instances of the same request were made simultaneously.GoneException
- Access to the target resource is no longer available at the origin server. This condition is likely to be
permanent.UnprocessableEntityException
- A well-formed request couldn't be followed due to semantic errors.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.StartVoiceToneAnalysisTaskResult startVoiceToneAnalysisTask(StartVoiceToneAnalysisTaskRequest startVoiceToneAnalysisTaskRequest)
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.
startVoiceToneAnalysisTaskRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ResourceLimitExceededException
- The request exceeds the resource limit.UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.NotFoundException
- The requested resource couldn't be found.ConflictException
- Multiple instances of the same request were made simultaneously.GoneException
- Access to the target resource is no longer available at the origin server. This condition is likely to be
permanent.UnprocessableEntityException
- A well-formed request couldn't be followed due to semantic errors.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.StopSpeakerSearchTaskResult stopSpeakerSearchTask(StopSpeakerSearchTaskRequest stopSpeakerSearchTaskRequest)
Stops a speaker search task.
stopSpeakerSearchTaskRequest
- BadRequestException
- The input parameters don't match the service's restrictions.UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.NotFoundException
- The requested resource couldn't be found.ConflictException
- Multiple instances of the same request were made simultaneously.UnprocessableEntityException
- A well-formed request couldn't be followed due to semantic errors.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.StopVoiceToneAnalysisTaskResult stopVoiceToneAnalysisTask(StopVoiceToneAnalysisTaskRequest stopVoiceToneAnalysisTaskRequest)
Stops a voice tone analysis task.
stopVoiceToneAnalysisTaskRequest
- BadRequestException
- The input parameters don't match the service's restrictions.UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.NotFoundException
- The requested resource couldn't be found.ConflictException
- Multiple instances of the same request were made simultaneously.UnprocessableEntityException
- A well-formed request couldn't be followed due to semantic errors.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds a tag to the specified resource.
tagResourceRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.NotFoundException
- The requested resource couldn't be found.ResourceLimitExceededException
- The request exceeds the resource limit.UnauthorizedClientException
- The client isn't authorized to request a resource.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource.
untagResourceRequest
- BadRequestException
- The input parameters don't match the service's restrictions.ForbiddenException
- The client is permanently forbidden from making the request.NotFoundException
- The requested resource couldn't be found.UnauthorizedClientException
- The client isn't authorized to request a resource.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
updateGlobalSettingsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)
Updates phone number details, such as product type, calling name, or phone number 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, calling name, or phone number 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.
updatePhoneNumberRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ConflictException
- Multiple instances of the same request were made simultaneously.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdatePhoneNumberSettingsResult updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest)
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.
updatePhoneNumberSettingsRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdateProxySessionResult updateProxySession(UpdateProxySessionRequest updateProxySessionRequest)
Updates the specified proxy session details, such as voice or SMS capabilities.
updateProxySessionRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdateSipMediaApplicationResult updateSipMediaApplication(UpdateSipMediaApplicationRequest updateSipMediaApplicationRequest)
Updates the details of the specified SIP media application.
updateSipMediaApplicationRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdateSipMediaApplicationCallResult updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest updateSipMediaApplicationCallRequest)
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.
updateSipMediaApplicationCallRequest
- BadRequestException
- The input parameters don't match the service's restrictions.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.ResourceLimitExceededException
- The request exceeds the resource limit.ThrottledClientException
- The number of customer requests exceeds the request rate limit.UnauthorizedClientException
- The client isn't authorized to request a resource.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdateSipRuleResult updateSipRule(UpdateSipRuleRequest updateSipRuleRequest)
Updates the details of the specified SIP rule.
updateSipRuleRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ResourceLimitExceededException
- The request exceeds the resource limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest updateVoiceConnectorRequest)
Updates the details for the specified Amazon Chime SDK Voice Connector.
updateVoiceConnectorRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdateVoiceConnectorGroupResult updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest updateVoiceConnectorGroupRequest)
Updates the settings for the specified Amazon Chime SDK Voice Connector group.
updateVoiceConnectorGroupRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ConflictException
- Multiple instances of the same request were made simultaneously.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdateVoiceProfileResult updateVoiceProfile(UpdateVoiceProfileRequest updateVoiceProfileRequest)
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.
updateVoiceProfileRequest
- BadRequestException
- The input parameters don't match the service's restrictions.UnauthorizedClientException
- The client isn't authorized to request a resource.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.NotFoundException
- The requested resource couldn't be found.ConflictException
- Multiple instances of the same request were made simultaneously.GoneException
- Access to the target resource is no longer available at the origin server. This condition is likely to be
permanent.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.UpdateVoiceProfileDomainResult updateVoiceProfileDomain(UpdateVoiceProfileDomainRequest updateVoiceProfileDomainRequest)
Updates the settings for the specified voice profile domain.
updateVoiceProfileDomainRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.AccessDeniedException
- You don't have the permissions needed to run this action.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.ValidateE911AddressResult validateE911Address(ValidateE911AddressRequest validateE911AddressRequest)
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.
validateE911AddressRequest
- UnauthorizedClientException
- The client isn't authorized to request a resource.NotFoundException
- The requested resource couldn't be found.ForbiddenException
- The client is permanently forbidden from making the request.BadRequestException
- The input parameters don't match the service's restrictions.ThrottledClientException
- The number of customer requests exceeds the request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.