@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonChimeSDKVoiceClient extends AmazonWebServiceClient implements AmazonChimeSDKVoice
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociatePhoneNumbersWithVoiceConnectorResult |
associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)
Associates phone numbers with the specified Amazon Chime SDK Voice Connector.
|
AssociatePhoneNumbersWithVoiceConnectorGroupResult |
associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest request)
Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.
|
BatchDeletePhoneNumberResult |
batchDeletePhoneNumber(BatchDeletePhoneNumberRequest request)
Moves phone numbers into the Deletion queue.
|
BatchUpdatePhoneNumberResult |
batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest request)
Updates one or more phone numbers.
|
static AmazonChimeSDKVoiceClientBuilder |
builder() |
CreatePhoneNumberOrderResult |
createPhoneNumberOrder(CreatePhoneNumberOrderRequest request)
Creates an order for phone numbers to be provisioned.
|
CreateProxySessionResult |
createProxySession(CreateProxySessionRequest request)
Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone
numbers.
|
CreateSipMediaApplicationResult |
createSipMediaApplication(CreateSipMediaApplicationRequest request)
Creates a SIP media application.
|
CreateSipMediaApplicationCallResult |
createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest request)
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 request)
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 request)
Creates an Amazon Chime SDK Voice Connector.
|
CreateVoiceConnectorGroupResult |
createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest request)
Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account.
|
CreateVoiceProfileResult |
createVoiceProfile(CreateVoiceProfileRequest request)
Creates a voice profile, which consists of an enrolled user and their latest voice print.
|
CreateVoiceProfileDomainResult |
createVoiceProfileDomain(CreateVoiceProfileDomainRequest request)
Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment
audio.
|
DeletePhoneNumberResult |
deletePhoneNumber(DeletePhoneNumberRequest request)
Moves the specified phone number into the Deletion queue.
|
DeleteProxySessionResult |
deleteProxySession(DeleteProxySessionRequest request)
Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.
|
DeleteSipMediaApplicationResult |
deleteSipMediaApplication(DeleteSipMediaApplicationRequest request)
Deletes a SIP media application.
|
DeleteSipRuleResult |
deleteSipRule(DeleteSipRuleRequest request)
Deletes a SIP rule.
|
DeleteVoiceConnectorResult |
deleteVoiceConnector(DeleteVoiceConnectorRequest request)
Deletes an Amazon Chime SDK Voice Connector.
|
DeleteVoiceConnectorEmergencyCallingConfigurationResult |
deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest request)
Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.
|
DeleteVoiceConnectorGroupResult |
deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest request)
Deletes an Amazon Chime SDK Voice Connector group.
|
DeleteVoiceConnectorOriginationResult |
deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest request)
Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.
|
DeleteVoiceConnectorProxyResult |
deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest request)
Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.
|
DeleteVoiceConnectorStreamingConfigurationResult |
deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest request)
Deletes a Voice Connector's streaming configuration.
|
DeleteVoiceConnectorTerminationResult |
deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest request)
Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.
|
DeleteVoiceConnectorTerminationCredentialsResult |
deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest request)
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
|
DeleteVoiceProfileResult |
deleteVoiceProfile(DeleteVoiceProfileRequest request)
Deletes a voice profile, including its voice print and enrollment data.
|
DeleteVoiceProfileDomainResult |
deleteVoiceProfileDomain(DeleteVoiceProfileDomainRequest request)
Deletes all voice profiles in the domain.
|
DisassociatePhoneNumbersFromVoiceConnectorResult |
disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest request)
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.
|
DisassociatePhoneNumbersFromVoiceConnectorGroupResult |
disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest request)
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 request)
Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
|
GetPhoneNumberResult |
getPhoneNumber(GetPhoneNumberRequest request)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
|
GetPhoneNumberOrderResult |
getPhoneNumberOrder(GetPhoneNumberOrderRequest request)
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 request)
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling
name.
|
GetProxySessionResult |
getProxySession(GetProxySessionRequest request)
Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.
|
GetSipMediaApplicationResult |
getSipMediaApplication(GetSipMediaApplicationRequest request)
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
|
GetSipMediaApplicationAlexaSkillConfigurationResult |
getSipMediaApplicationAlexaSkillConfiguration(GetSipMediaApplicationAlexaSkillConfigurationRequest request)
Gets the Alexa Skill configuration for the SIP media application.
|
GetSipMediaApplicationLoggingConfigurationResult |
getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest request)
Retrieves the logging configuration for the specified SIP media application.
|
GetSipRuleResult |
getSipRule(GetSipRuleRequest request)
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
|
GetSpeakerSearchTaskResult |
getSpeakerSearchTask(GetSpeakerSearchTaskRequest request)
Retrieves the details of the specified speaker search task.
|
GetVoiceConnectorResult |
getVoiceConnector(GetVoiceConnectorRequest request)
Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and
encryption requirements.
|
GetVoiceConnectorEmergencyCallingConfigurationResult |
getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest request)
Retrieves the emergency calling configuration details for the specified Voice Connector.
|
GetVoiceConnectorGroupResult |
getVoiceConnectorGroup(GetVoiceConnectorGroupRequest request)
Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and
associated
VoiceConnectorItems . |
GetVoiceConnectorLoggingConfigurationResult |
getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest request)
Retrieves the logging configuration settings for the specified Voice Connector.
|
GetVoiceConnectorOriginationResult |
getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest request)
Retrieves the origination settings for the specified Voice Connector.
|
GetVoiceConnectorProxyResult |
getVoiceConnectorProxy(GetVoiceConnectorProxyRequest request)
Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.
|
GetVoiceConnectorStreamingConfigurationResult |
getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest request)
Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector.
|
GetVoiceConnectorTerminationResult |
getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest request)
Retrieves the termination setting details for the specified Voice Connector.
|
GetVoiceConnectorTerminationHealthResult |
getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest request)
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 request)
Retrieves the details of the specified voice profile.
|
GetVoiceProfileDomainResult |
getVoiceProfileDomain(GetVoiceProfileDomainRequest request)
Retrieves the details of the specified voice profile domain.
|
GetVoiceToneAnalysisTaskResult |
getVoiceToneAnalysisTask(GetVoiceToneAnalysisTaskRequest request)
Retrieves the details of a voice tone analysis task.
|
ListAvailableVoiceConnectorRegionsResult |
listAvailableVoiceConnectorRegions(ListAvailableVoiceConnectorRegionsRequest request)
Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.
|
ListPhoneNumberOrdersResult |
listPhoneNumberOrders(ListPhoneNumberOrdersRequest request)
Lists the phone numbers for an administrator's Amazon Chime SDK account.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest request)
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 request)
Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.
|
ListSipMediaApplicationsResult |
listSipMediaApplications(ListSipMediaApplicationsRequest request)
Lists the SIP media applications under the administrator's AWS account.
|
ListSipRulesResult |
listSipRules(ListSipRulesRequest request)
Lists the SIP rules under the administrator's AWS account.
|
ListSupportedPhoneNumberCountriesResult |
listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest request)
Lists the countries that you can order phone numbers from.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags in a given resource.
|
ListVoiceConnectorGroupsResult |
listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest request)
Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.
|
ListVoiceConnectorsResult |
listVoiceConnectors(ListVoiceConnectorsRequest request)
Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
|
ListVoiceConnectorTerminationCredentialsResult |
listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest request)
Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.
|
ListVoiceProfileDomainsResult |
listVoiceProfileDomains(ListVoiceProfileDomainsRequest request)
Lists the specified voice profile domains in the administrator's AWS account.
|
ListVoiceProfilesResult |
listVoiceProfiles(ListVoiceProfilesRequest request)
Lists the voice profiles in a voice profile domain.
|
PutSipMediaApplicationAlexaSkillConfigurationResult |
putSipMediaApplicationAlexaSkillConfiguration(PutSipMediaApplicationAlexaSkillConfigurationRequest request)
Updates the Alexa Skill configuration for the SIP media application.
|
PutSipMediaApplicationLoggingConfigurationResult |
putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest request)
Updates the logging configuration for the specified SIP media application.
|
PutVoiceConnectorEmergencyCallingConfigurationResult |
putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest request)
Updates a Voice Connector's emergency calling configuration.
|
PutVoiceConnectorLoggingConfigurationResult |
putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest request)
Updates a Voice Connector's logging configuration.
|
PutVoiceConnectorOriginationResult |
putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest request)
Updates a Voice Connector's origination settings.
|
PutVoiceConnectorProxyResult |
putVoiceConnectorProxy(PutVoiceConnectorProxyRequest request)
Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.
|
PutVoiceConnectorStreamingConfigurationResult |
putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest request)
Updates a Voice Connector's streaming configuration settings.
|
PutVoiceConnectorTerminationResult |
putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest request)
Updates a Voice Connector's termination settings.
|
PutVoiceConnectorTerminationCredentialsResult |
putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest request)
Updates a Voice Connector's termination credentials.
|
RestorePhoneNumberResult |
restorePhoneNumber(RestorePhoneNumberRequest request)
Restores a deleted phone number.
|
SearchAvailablePhoneNumbersResult |
searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
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 request)
Starts a speaker search task.
|
StartVoiceToneAnalysisTaskResult |
startVoiceToneAnalysisTask(StartVoiceToneAnalysisTaskRequest request)
Starts a voice tone analysis task.
|
StopSpeakerSearchTaskResult |
stopSpeakerSearchTask(StopSpeakerSearchTaskRequest request)
Stops a speaker search task.
|
StopVoiceToneAnalysisTaskResult |
stopVoiceToneAnalysisTask(StopVoiceToneAnalysisTaskRequest request)
Stops a voice tone analysis task.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds a tag to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a resource.
|
UpdateGlobalSettingsResult |
updateGlobalSettings(UpdateGlobalSettingsRequest request)
Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
|
UpdatePhoneNumberResult |
updatePhoneNumber(UpdatePhoneNumberRequest request)
Updates phone number details, such as product type or calling name, for the specified phone number ID.
|
UpdatePhoneNumberSettingsResult |
updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest request)
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
|
UpdateProxySessionResult |
updateProxySession(UpdateProxySessionRequest request)
Updates the specified proxy session details, such as voice or SMS capabilities.
|
UpdateSipMediaApplicationResult |
updateSipMediaApplication(UpdateSipMediaApplicationRequest request)
Updates the details of the specified SIP media application.
|
UpdateSipMediaApplicationCallResult |
updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest request)
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update
request.
|
UpdateSipRuleResult |
updateSipRule(UpdateSipRuleRequest request)
Updates the details of the specified SIP rule.
|
UpdateVoiceConnectorResult |
updateVoiceConnector(UpdateVoiceConnectorRequest request)
Updates the details for the specified Amazon Chime SDK Voice Connector.
|
UpdateVoiceConnectorGroupResult |
updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest request)
Updates the settings for the specified Amazon Chime SDK Voice Connector group.
|
UpdateVoiceProfileResult |
updateVoiceProfile(UpdateVoiceProfileRequest request)
Updates the specified voice profile’s voice print and refreshes its expiration timestamp.
|
UpdateVoiceProfileDomainResult |
updateVoiceProfileDomain(UpdateVoiceProfileDomainRequest request)
Updates the settings for the specified voice profile domain.
|
ValidateE911AddressResult |
validateE911Address(ValidateE911AddressRequest request)
Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonChimeSDKVoiceClientBuilder builder()
public AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)
Associates phone numbers with the specified Amazon Chime SDK Voice Connector.
associatePhoneNumbersWithVoiceConnector
in interface AmazonChimeSDKVoice
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.public AssociatePhoneNumbersWithVoiceConnectorGroupResult associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest request)
Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.
associatePhoneNumbersWithVoiceConnectorGroup
in interface AmazonChimeSDKVoice
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.public BatchDeletePhoneNumberResult batchDeletePhoneNumber(BatchDeletePhoneNumberRequest request)
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.
batchDeletePhoneNumber
in interface AmazonChimeSDKVoice
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.public BatchUpdatePhoneNumberResult batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest request)
Updates one or more phone numbers.
batchUpdatePhoneNumber
in interface AmazonChimeSDKVoice
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.public CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest request)
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.
createPhoneNumberOrder
in interface AmazonChimeSDKVoice
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.public CreateProxySessionResult createProxySession(CreateProxySessionRequest request)
Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.
createProxySession
in interface AmazonChimeSDKVoice
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.public CreateSipMediaApplicationResult createSipMediaApplication(CreateSipMediaApplicationRequest request)
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.
createSipMediaApplication
in interface AmazonChimeSDKVoice
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.public CreateSipMediaApplicationCallResult createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest request)
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
.
createSipMediaApplicationCall
in interface AmazonChimeSDKVoice
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.public CreateSipRuleResult createSipRule(CreateSipRuleRequest request)
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.
createSipRule
in interface AmazonChimeSDKVoice
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.public CreateVoiceConnectorResult createVoiceConnector(CreateVoiceConnectorRequest request)
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.
createVoiceConnector
in interface AmazonChimeSDKVoice
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.public CreateVoiceConnectorGroupResult createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest request)
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.
createVoiceConnectorGroup
in interface AmazonChimeSDKVoice
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.public CreateVoiceProfileResult createVoiceProfile(CreateVoiceProfileRequest request)
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.
createVoiceProfile
in interface AmazonChimeSDKVoice
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.public CreateVoiceProfileDomainResult createVoiceProfileDomain(CreateVoiceProfileDomainRequest request)
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.
createVoiceProfileDomain
in interface AmazonChimeSDKVoice
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.public DeletePhoneNumberResult deletePhoneNumber(DeletePhoneNumberRequest request)
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.
deletePhoneNumber
in interface AmazonChimeSDKVoice
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.public DeleteProxySessionResult deleteProxySession(DeleteProxySessionRequest request)
Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.
deleteProxySession
in interface AmazonChimeSDKVoice
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.public DeleteSipMediaApplicationResult deleteSipMediaApplication(DeleteSipMediaApplicationRequest request)
Deletes a SIP media application.
deleteSipMediaApplication
in interface AmazonChimeSDKVoice
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.public DeleteSipRuleResult deleteSipRule(DeleteSipRuleRequest request)
Deletes a SIP rule.
deleteSipRule
in interface AmazonChimeSDKVoice
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.public DeleteVoiceConnectorResult deleteVoiceConnector(DeleteVoiceConnectorRequest request)
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.
deleteVoiceConnector
in interface AmazonChimeSDKVoice
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.public DeleteVoiceConnectorEmergencyCallingConfigurationResult deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest request)
Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.
deleteVoiceConnectorEmergencyCallingConfiguration
in interface AmazonChimeSDKVoice
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.public DeleteVoiceConnectorGroupResult deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest request)
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.
deleteVoiceConnectorGroup
in interface AmazonChimeSDKVoice
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.public DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest request)
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.
deleteVoiceConnectorOrigination
in interface AmazonChimeSDKVoice
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.public DeleteVoiceConnectorProxyResult deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest request)
Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.
deleteVoiceConnectorProxy
in interface AmazonChimeSDKVoice
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.public DeleteVoiceConnectorStreamingConfigurationResult deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest request)
Deletes a Voice Connector's streaming configuration.
deleteVoiceConnectorStreamingConfiguration
in interface AmazonChimeSDKVoice
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.public DeleteVoiceConnectorTerminationResult deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest request)
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.
deleteVoiceConnectorTermination
in interface AmazonChimeSDKVoice
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.public DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest request)
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
deleteVoiceConnectorTerminationCredentials
in interface AmazonChimeSDKVoice
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.public DeleteVoiceProfileResult deleteVoiceProfile(DeleteVoiceProfileRequest request)
Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.
deleteVoiceProfile
in interface AmazonChimeSDKVoice
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.public DeleteVoiceProfileDomainResult deleteVoiceProfileDomain(DeleteVoiceProfileDomainRequest request)
Deletes all voice profiles in the domain. WARNING: This action is not reversible.
deleteVoiceProfileDomain
in interface AmazonChimeSDKVoice
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.public DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest request)
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.
disassociatePhoneNumbersFromVoiceConnector
in interface AmazonChimeSDKVoice
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.public DisassociatePhoneNumbersFromVoiceConnectorGroupResult disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest request)
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.
disassociatePhoneNumbersFromVoiceConnectorGroup
in interface AmazonChimeSDKVoice
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.public GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest request)
Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
getGlobalSettings
in interface AmazonChimeSDKVoice
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.public GetPhoneNumberResult getPhoneNumber(GetPhoneNumberRequest request)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
getPhoneNumber
in interface AmazonChimeSDKVoice
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.public GetPhoneNumberOrderResult getPhoneNumberOrder(GetPhoneNumberOrderRequest request)
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.
getPhoneNumberOrder
in interface AmazonChimeSDKVoice
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.public GetPhoneNumberSettingsResult getPhoneNumberSettings(GetPhoneNumberSettingsRequest request)
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
getPhoneNumberSettings
in interface AmazonChimeSDKVoice
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.public GetProxySessionResult getProxySession(GetProxySessionRequest request)
Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.
getProxySession
in interface AmazonChimeSDKVoice
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.public GetSipMediaApplicationResult getSipMediaApplication(GetSipMediaApplicationRequest request)
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
getSipMediaApplication
in interface AmazonChimeSDKVoice
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.public GetSipMediaApplicationAlexaSkillConfigurationResult getSipMediaApplicationAlexaSkillConfiguration(GetSipMediaApplicationAlexaSkillConfigurationRequest request)
Gets the Alexa Skill configuration for the SIP media application.
getSipMediaApplicationAlexaSkillConfiguration
in interface AmazonChimeSDKVoice
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.public GetSipMediaApplicationLoggingConfigurationResult getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest request)
Retrieves the logging configuration for the specified SIP media application.
getSipMediaApplicationLoggingConfiguration
in interface AmazonChimeSDKVoice
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.public GetSipRuleResult getSipRule(GetSipRuleRequest request)
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
getSipRule
in interface AmazonChimeSDKVoice
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.public GetSpeakerSearchTaskResult getSpeakerSearchTask(GetSpeakerSearchTaskRequest request)
Retrieves the details of the specified speaker search task.
getSpeakerSearchTask
in interface AmazonChimeSDKVoice
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.public GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest request)
Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
getVoiceConnector
in interface AmazonChimeSDKVoice
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.public GetVoiceConnectorEmergencyCallingConfigurationResult getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest request)
Retrieves the emergency calling configuration details for the specified Voice Connector.
getVoiceConnectorEmergencyCallingConfiguration
in interface AmazonChimeSDKVoice
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.public GetVoiceConnectorGroupResult getVoiceConnectorGroup(GetVoiceConnectorGroupRequest request)
Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and
associated VoiceConnectorItems
.
getVoiceConnectorGroup
in interface AmazonChimeSDKVoice
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.public GetVoiceConnectorLoggingConfigurationResult getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest request)
Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
getVoiceConnectorLoggingConfiguration
in interface AmazonChimeSDKVoice
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.public GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest request)
Retrieves the origination settings for the specified Voice Connector.
getVoiceConnectorOrigination
in interface AmazonChimeSDKVoice
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.public GetVoiceConnectorProxyResult getVoiceConnectorProxy(GetVoiceConnectorProxyRequest request)
Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.
getVoiceConnectorProxy
in interface AmazonChimeSDKVoice
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.public GetVoiceConnectorStreamingConfigurationResult getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest request)
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.
getVoiceConnectorStreamingConfiguration
in interface AmazonChimeSDKVoice
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.public GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest request)
Retrieves the termination setting details for the specified Voice Connector.
getVoiceConnectorTermination
in interface AmazonChimeSDKVoice
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.public GetVoiceConnectorTerminationHealthResult getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest request)
Retrieves information about the last time a SIP OPTIONS
ping was received from your SIP
infrastructure for the specified Amazon Chime SDK Voice Connector.
getVoiceConnectorTerminationHealth
in interface AmazonChimeSDKVoice
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.public GetVoiceProfileResult getVoiceProfile(GetVoiceProfileRequest request)
Retrieves the details of the specified voice profile.
getVoiceProfile
in interface AmazonChimeSDKVoice
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.public GetVoiceProfileDomainResult getVoiceProfileDomain(GetVoiceProfileDomainRequest request)
Retrieves the details of the specified voice profile domain.
getVoiceProfileDomain
in interface AmazonChimeSDKVoice
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.public GetVoiceToneAnalysisTaskResult getVoiceToneAnalysisTask(GetVoiceToneAnalysisTaskRequest request)
Retrieves the details of a voice tone analysis task.
getVoiceToneAnalysisTask
in interface AmazonChimeSDKVoice
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.public ListAvailableVoiceConnectorRegionsResult listAvailableVoiceConnectorRegions(ListAvailableVoiceConnectorRegionsRequest request)
Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.
listAvailableVoiceConnectorRegions
in interface AmazonChimeSDKVoice
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.public ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest request)
Lists the phone numbers for an administrator's Amazon Chime SDK account.
listPhoneNumberOrders
in interface AmazonChimeSDKVoice
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.public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
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.
listPhoneNumbers
in interface AmazonChimeSDKVoice
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.public ListProxySessionsResult listProxySessions(ListProxySessionsRequest request)
Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.
listProxySessions
in interface AmazonChimeSDKVoice
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.public ListSipMediaApplicationsResult listSipMediaApplications(ListSipMediaApplicationsRequest request)
Lists the SIP media applications under the administrator's AWS account.
listSipMediaApplications
in interface AmazonChimeSDKVoice
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.public ListSipRulesResult listSipRules(ListSipRulesRequest request)
Lists the SIP rules under the administrator's AWS account.
listSipRules
in interface AmazonChimeSDKVoice
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.public ListSupportedPhoneNumberCountriesResult listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest request)
Lists the countries that you can order phone numbers from.
listSupportedPhoneNumberCountries
in interface AmazonChimeSDKVoice
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags in a given resource.
listTagsForResource
in interface AmazonChimeSDKVoice
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.public ListVoiceConnectorGroupsResult listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest request)
Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.
listVoiceConnectorGroups
in interface AmazonChimeSDKVoice
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.public ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest request)
Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.
listVoiceConnectorTerminationCredentials
in interface AmazonChimeSDKVoice
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.public ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest request)
Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
listVoiceConnectors
in interface AmazonChimeSDKVoice
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.public ListVoiceProfileDomainsResult listVoiceProfileDomains(ListVoiceProfileDomainsRequest request)
Lists the specified voice profile domains in the administrator's AWS account.
listVoiceProfileDomains
in interface AmazonChimeSDKVoice
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.public ListVoiceProfilesResult listVoiceProfiles(ListVoiceProfilesRequest request)
Lists the voice profiles in a voice profile domain.
listVoiceProfiles
in interface AmazonChimeSDKVoice
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.public PutSipMediaApplicationAlexaSkillConfigurationResult putSipMediaApplicationAlexaSkillConfiguration(PutSipMediaApplicationAlexaSkillConfigurationRequest request)
Updates the Alexa Skill configuration for the SIP media application.
putSipMediaApplicationAlexaSkillConfiguration
in interface AmazonChimeSDKVoice
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.public PutSipMediaApplicationLoggingConfigurationResult putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest request)
Updates the logging configuration for the specified SIP media application.
putSipMediaApplicationLoggingConfiguration
in interface AmazonChimeSDKVoice
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.public PutVoiceConnectorEmergencyCallingConfigurationResult putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest request)
Updates a Voice Connector's emergency calling configuration.
putVoiceConnectorEmergencyCallingConfiguration
in interface AmazonChimeSDKVoice
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.public PutVoiceConnectorLoggingConfigurationResult putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest request)
Updates a Voice Connector's logging configuration.
putVoiceConnectorLoggingConfiguration
in interface AmazonChimeSDKVoice
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.public PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest request)
Updates a Voice Connector's origination settings.
putVoiceConnectorOrigination
in interface AmazonChimeSDKVoice
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.public PutVoiceConnectorProxyResult putVoiceConnectorProxy(PutVoiceConnectorProxyRequest request)
Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.
putVoiceConnectorProxy
in interface AmazonChimeSDKVoice
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.public PutVoiceConnectorStreamingConfigurationResult putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest request)
Updates a Voice Connector's streaming configuration settings.
putVoiceConnectorStreamingConfiguration
in interface AmazonChimeSDKVoice
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.public PutVoiceConnectorTerminationResult putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest request)
Updates a Voice Connector's termination settings.
putVoiceConnectorTermination
in interface AmazonChimeSDKVoice
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.public PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest request)
Updates a Voice Connector's termination credentials.
putVoiceConnectorTerminationCredentials
in interface AmazonChimeSDKVoice
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.public RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest request)
Restores a deleted phone number.
restorePhoneNumber
in interface AmazonChimeSDKVoice
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.public SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
Searches the provisioned phone numbers in an organization.
searchAvailablePhoneNumbers
in interface AmazonChimeSDKVoice
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.public StartSpeakerSearchTaskResult startSpeakerSearchTask(StartSpeakerSearchTaskRequest request)
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.
startSpeakerSearchTask
in interface AmazonChimeSDKVoice
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.public StartVoiceToneAnalysisTaskResult startVoiceToneAnalysisTask(StartVoiceToneAnalysisTaskRequest request)
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.
startVoiceToneAnalysisTask
in interface AmazonChimeSDKVoice
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.public StopSpeakerSearchTaskResult stopSpeakerSearchTask(StopSpeakerSearchTaskRequest request)
Stops a speaker search task.
stopSpeakerSearchTask
in interface AmazonChimeSDKVoice
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.public StopVoiceToneAnalysisTaskResult stopVoiceToneAnalysisTask(StopVoiceToneAnalysisTaskRequest request)
Stops a voice tone analysis task.
stopVoiceToneAnalysisTask
in interface AmazonChimeSDKVoice
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.public TagResourceResult tagResource(TagResourceRequest request)
Adds a tag to the specified resource.
tagResource
in interface AmazonChimeSDKVoice
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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a resource.
untagResource
in interface AmazonChimeSDKVoice
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.public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)
Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
updateGlobalSettings
in interface AmazonChimeSDKVoice
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.public UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
updatePhoneNumber
in interface AmazonChimeSDKVoice
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.public UpdatePhoneNumberSettingsResult updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest request)
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.
updatePhoneNumberSettings
in interface AmazonChimeSDKVoice
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.public UpdateProxySessionResult updateProxySession(UpdateProxySessionRequest request)
Updates the specified proxy session details, such as voice or SMS capabilities.
updateProxySession
in interface AmazonChimeSDKVoice
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.public UpdateSipMediaApplicationResult updateSipMediaApplication(UpdateSipMediaApplicationRequest request)
Updates the details of the specified SIP media application.
updateSipMediaApplication
in interface AmazonChimeSDKVoice
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.public UpdateSipMediaApplicationCallResult updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest request)
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.
updateSipMediaApplicationCall
in interface AmazonChimeSDKVoice
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.public UpdateSipRuleResult updateSipRule(UpdateSipRuleRequest request)
Updates the details of the specified SIP rule.
updateSipRule
in interface AmazonChimeSDKVoice
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.public UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest request)
Updates the details for the specified Amazon Chime SDK Voice Connector.
updateVoiceConnector
in interface AmazonChimeSDKVoice
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.public UpdateVoiceConnectorGroupResult updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest request)
Updates the settings for the specified Amazon Chime SDK Voice Connector group.
updateVoiceConnectorGroup
in interface AmazonChimeSDKVoice
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.public UpdateVoiceProfileResult updateVoiceProfile(UpdateVoiceProfileRequest request)
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.
updateVoiceProfile
in interface AmazonChimeSDKVoice
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.public UpdateVoiceProfileDomainResult updateVoiceProfileDomain(UpdateVoiceProfileDomainRequest request)
Updates the settings for the specified voice profile domain.
updateVoiceProfileDomain
in interface AmazonChimeSDKVoice
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.public ValidateE911AddressResult validateE911Address(ValidateE911AddressRequest request)
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.
validateE911Address
in interface AmazonChimeSDKVoice
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.public 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 the request.
getCachedResponseMetadata
in interface AmazonChimeSDKVoice
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonChimeSDKVoice
shutdown
in class AmazonWebServiceClient