ChimeSDKVoice ************* Client ====== class ChimeSDKVoice.Client A low-level client representing Amazon Chime SDK Voice 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. import boto3 client = boto3.client('chime-sdk-voice') These are the available methods: * associate_phone_numbers_with_voice_connector * associate_phone_numbers_with_voice_connector_group * batch_delete_phone_number * batch_update_phone_number * can_paginate * close * create_phone_number_order * create_proxy_session * create_sip_media_application * create_sip_media_application_call * create_sip_rule * create_voice_connector * create_voice_connector_group * create_voice_profile * create_voice_profile_domain * delete_phone_number * delete_proxy_session * delete_sip_media_application * delete_sip_rule * delete_voice_connector * delete_voice_connector_emergency_calling_configuration * delete_voice_connector_external_systems_configuration * delete_voice_connector_group * delete_voice_connector_origination * delete_voice_connector_proxy * delete_voice_connector_streaming_configuration * delete_voice_connector_termination * delete_voice_connector_termination_credentials * delete_voice_profile * delete_voice_profile_domain * disassociate_phone_numbers_from_voice_connector * disassociate_phone_numbers_from_voice_connector_group * get_global_settings * get_paginator * get_phone_number * get_phone_number_order * get_phone_number_settings * get_proxy_session * get_sip_media_application * get_sip_media_application_alexa_skill_configuration * get_sip_media_application_logging_configuration * get_sip_rule * get_speaker_search_task * get_voice_connector * get_voice_connector_emergency_calling_configuration * get_voice_connector_external_systems_configuration * get_voice_connector_group * get_voice_connector_logging_configuration * get_voice_connector_origination * get_voice_connector_proxy * get_voice_connector_streaming_configuration * get_voice_connector_termination * get_voice_connector_termination_health * get_voice_profile * get_voice_profile_domain * get_voice_tone_analysis_task * get_waiter * list_available_voice_connector_regions * list_phone_number_orders * list_phone_numbers * list_proxy_sessions * list_sip_media_applications * list_sip_rules * list_supported_phone_number_countries * list_tags_for_resource * list_voice_connector_groups * list_voice_connector_termination_credentials * list_voice_connectors * list_voice_profile_domains * list_voice_profiles * put_sip_media_application_alexa_skill_configuration * put_sip_media_application_logging_configuration * put_voice_connector_emergency_calling_configuration * put_voice_connector_external_systems_configuration * put_voice_connector_logging_configuration * put_voice_connector_origination * put_voice_connector_proxy * put_voice_connector_streaming_configuration * put_voice_connector_termination * put_voice_connector_termination_credentials * restore_phone_number * search_available_phone_numbers * start_speaker_search_task * start_voice_tone_analysis_task * stop_speaker_search_task * stop_voice_tone_analysis_task * tag_resource * untag_resource * update_global_settings * update_phone_number * update_phone_number_settings * update_proxy_session * update_sip_media_application * update_sip_media_application_call * update_sip_rule * update_voice_connector * update_voice_connector_group * update_voice_profile * update_voice_profile_domain * validate_e911_address Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListSipMediaApplications * ListSipRules ChimeSDKVoice / Paginator / ListSipMediaApplications ListSipMediaApplications ************************ class ChimeSDKVoice.Paginator.ListSipMediaApplications paginator = client.get_paginator('list_sip_media_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "ChimeSDKVoice.Client.list_sip_media_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SipMediaApplications': [ { 'SipMediaApplicationId': 'string', 'AwsRegion': 'string', 'Name': 'string', 'Endpoints': [ { 'LambdaArn': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'SipMediaApplicationArn': 'string' }, ], } **Response Structure** * *(dict) --* * **SipMediaApplications** *(list) --* The list of SIP media applications and application details. * *(dict) --* The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications. * **SipMediaApplicationId** *(string) --* A SIP media application's ID. * **AwsRegion** *(string) --* The AWS Region in which the SIP media application is created. * **Name** *(string) --* The SIP media application's name. * **Endpoints** *(list) --* List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted. * *(dict) --* The endpoint assigned to a SIP media application. * **LambdaArn** *(string) --* Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application. * **CreatedTimestamp** *(datetime) --* The SIP media application creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The time at which the SIP media application was updated. * **SipMediaApplicationArn** *(string) --* The ARN of the SIP media application. ChimeSDKVoice / Paginator / ListSipRules ListSipRules ************ class ChimeSDKVoice.Paginator.ListSipRules paginator = client.get_paginator('list_sip_rules') paginate(**kwargs) Creates an iterator that will paginate through responses from "ChimeSDKVoice.Client.list_sip_rules()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( SipMediaApplicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **SipMediaApplicationId** (*string*) -- The SIP media application ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SipRules': [ { 'SipRuleId': 'string', 'Name': 'string', 'Disabled': True|False, 'TriggerType': 'ToPhoneNumber'|'RequestUriHostname', 'TriggerValue': 'string', 'TargetApplications': [ { 'SipMediaApplicationId': 'string', 'Priority': 123, 'AwsRegion': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **SipRules** *(list) --* The list of SIP rules and details. * *(dict) --* The details of a SIP rule, including name, triggers, and target applications. An AWS account can have multiple SIP rules. * **SipRuleId** *(string) --* A SIP rule's ID. * **Name** *(string) --* A SIP rule's name. * **Disabled** *(boolean) --* Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it. * **TriggerType** *(string) --* The type of trigger set for a SIP rule, either a phone number or a URI request host name. * **TriggerValue** *(string) --* The value set for a SIP rule's trigger type. Either a phone number or a URI hostname. * **TargetApplications** *(list) --* The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * *(dict) --* A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * **SipMediaApplicationId** *(string) --* The ID of a rule's target SIP media application. * **Priority** *(integer) --* The priority setting of a rule's target SIP media application. * **AwsRegion** *(string) --* The AWS Region of a rule's target SIP media application. * **CreatedTimestamp** *(datetime) --* The time at which the SIP rule was created, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The time at which the SIP rule was updated, in ISO 8601 format. ChimeSDKVoice / Client / list_phone_numbers list_phone_numbers ****************** ChimeSDKVoice.Client.list_phone_numbers(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_phone_numbers( Status='string', ProductType='VoiceConnector'|'SipMediaApplicationDialIn', FilterName='VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId', FilterValue='string', MaxResults=123, NextToken='string' ) Parameters: * **Status** (*string*) -- The status of your organization's phone numbers. * **ProductType** (*string*) -- The phone number product types. * **FilterName** (*string*) -- The filter to limit the number of results. * **FilterValue** (*string*) -- The filter value. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. * **NextToken** (*string*) -- The token used to return the next page of results. Return type: dict Returns: **Response Syntax** { 'PhoneNumbers': [ { 'PhoneNumberId': 'string', 'E164PhoneNumber': 'string', 'Country': 'string', 'Type': 'Local'|'TollFree', 'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed', 'Capabilities': { 'InboundCall': True|False, 'OutboundCall': True|False, 'InboundSMS': True|False, 'OutboundSMS': True|False, 'InboundMMS': True|False, 'OutboundMMS': True|False }, 'Associations': [ { 'Value': 'string', 'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId', 'AssociatedTimestamp': datetime(2015, 1, 1) }, ], 'CallingName': 'string', 'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'DeletionTimestamp': datetime(2015, 1, 1), 'OrderId': 'string', 'Name': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PhoneNumbers** *(list) --* The phone number details. * *(dict) --* A phone number used to call an Amazon Chime SDK Voice Connector. * **PhoneNumberId** *(string) --* The phone number's ID. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Country** *(string) --* The phone number's country. Format: ISO 3166-1 alpha-2. * **Type** *(string) --* The phone number's type. * **ProductType** *(string) --* The phone number's product type. * **Status** *(string) --* The phone number's status. * **Capabilities** *(dict) --* The phone number's capabilities. * **InboundCall** *(boolean) --* Allows or denies inbound calling for the specified phone number. * **OutboundCall** *(boolean) --* Allows or denies outbound calling for the specified phone number. * **InboundSMS** *(boolean) --* Allows or denies inbound SMS messaging for the specified phone number. * **OutboundSMS** *(boolean) --* Allows or denies outbound SMS messaging for the specified phone number. * **InboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **OutboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **Associations** *(list) --* The phone number's associations. * *(dict) --* The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID. * **Value** *(string) --* Contains the ID for the entity specified in Name. * **Name** *(string) --* Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID. * **AssociatedTimestamp** *(datetime) --* The timestamp of the phone number association, in ISO 8601 format. * **CallingName** *(string) --* The outbound calling name associated with the phone number. * **CallingNameStatus** *(string) --* The outbound calling name status. * **CreatedTimestamp** *(datetime) --* The phone number creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number timestamp, in ISO 8601 format. * **DeletionTimestamp** *(datetime) --* The deleted phone number timestamp, in ISO 8601 format. * **OrderId** *(string) --* The phone number's order ID. * **Name** *(string) --* The name of the phone number. * **NextToken** *(string) --* The token used to return the next page of results. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / put_voice_connector_emergency_calling_configuration put_voice_connector_emergency_calling_configuration *************************************************** ChimeSDKVoice.Client.put_voice_connector_emergency_calling_configuration(**kwargs) Updates a Voice Connector's emergency calling configuration. See also: AWS API Documentation **Request Syntax** response = client.put_voice_connector_emergency_calling_configuration( VoiceConnectorId='string', EmergencyCallingConfiguration={ 'DNIS': [ { 'EmergencyPhoneNumber': 'string', 'TestPhoneNumber': 'string', 'CallingCountry': 'string' }, ] } ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **EmergencyCallingConfiguration** (*dict*) -- **[REQUIRED]** The configuration being updated. * **DNIS** *(list) --* The Dialed Number Identification Service (DNIS) emergency calling configuration details. * *(dict) --* The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime SDK Voice Connector's emergency calling configuration. * **EmergencyPhoneNumber** *(string) --* **[REQUIRED]** The DNIS phone number that you route emergency calls to, in E.164 format. * **TestPhoneNumber** *(string) --* The DNIS phone number for routing test emergency calls to, in E.164 format. * **CallingCountry** *(string) --* **[REQUIRED]** The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format. Return type: dict Returns: **Response Syntax** { 'EmergencyCallingConfiguration': { 'DNIS': [ { 'EmergencyPhoneNumber': 'string', 'TestPhoneNumber': 'string', 'CallingCountry': 'string' }, ] } } **Response Structure** * *(dict) --* * **EmergencyCallingConfiguration** *(dict) --* The updated configuration. * **DNIS** *(list) --* The Dialed Number Identification Service (DNIS) emergency calling configuration details. * *(dict) --* The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime SDK Voice Connector's emergency calling configuration. * **EmergencyPhoneNumber** *(string) --* The DNIS phone number that you route emergency calls to, in E.164 format. * **TestPhoneNumber** *(string) --* The DNIS phone number for routing test emergency calls to, in E.164 format. * **CallingCountry** *(string) --* The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_paginator get_paginator ************* ChimeSDKVoice.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. ChimeSDKVoice / Client / search_available_phone_numbers search_available_phone_numbers ****************************** ChimeSDKVoice.Client.search_available_phone_numbers(**kwargs) Searches the provisioned phone numbers in an organization. See also: AWS API Documentation **Request Syntax** response = client.search_available_phone_numbers( AreaCode='string', City='string', Country='string', State='string', TollFreePrefix='string', PhoneNumberType='Local'|'TollFree', MaxResults=123, NextToken='string' ) Parameters: * **AreaCode** (*string*) -- Confines a search to just the phone numbers associated with the specified area code. * **City** (*string*) -- Confines a search to just the phone numbers associated with the specified city. * **Country** (*string*) -- Confines a search to just the phone numbers associated with the specified country. * **State** (*string*) -- Confines a search to just the phone numbers associated with the specified state. * **TollFreePrefix** (*string*) -- Confines a search to just the phone numbers associated with the specified toll-free prefix. * **PhoneNumberType** (*string*) -- Confines a search to just the phone numbers associated with the specified phone number type, either **local** or **toll-free**. * **MaxResults** (*integer*) -- The maximum number of results to return. * **NextToken** (*string*) -- The token used to return the next page of results. Return type: dict Returns: **Response Syntax** { 'E164PhoneNumbers': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **E164PhoneNumbers** *(list) --* Confines a search to just the phone numbers in the E.164 format. * *(string) --* * **NextToken** *(string) --* The token used to return the next page of results. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_connector_logging_configuration get_voice_connector_logging_configuration ***************************************** ChimeSDKVoice.Client.get_voice_connector_logging_configuration(**kwargs) Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs. See also: AWS API Documentation **Request Syntax** response = client.get_voice_connector_logging_configuration( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Return type: dict Returns: **Response Syntax** { 'LoggingConfiguration': { 'EnableSIPLogs': True|False, 'EnableMediaMetricLogs': True|False } } **Response Structure** * *(dict) --* * **LoggingConfiguration** *(dict) --* The logging configuration details . * **EnableSIPLogs** *(boolean) --* Boolean that enables sending SIP message logs to Amazon CloudWatch. * **EnableMediaMetricLogs** *(boolean) --* Enables or disables media metrics logging. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_connector_streaming_configuration get_voice_connector_streaming_configuration ******************************************* ChimeSDKVoice.Client.get_voice_connector_streaming_configuration(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_voice_connector_streaming_configuration( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Return type: dict Returns: **Response Syntax** { 'StreamingConfiguration': { 'DataRetentionInHours': 123, 'Disabled': True|False, 'StreamingNotificationTargets': [ { 'NotificationTarget': 'EventBridge'|'SNS'|'SQS' }, ], 'MediaInsightsConfiguration': { 'Disabled': True|False, 'ConfigurationArn': 'string' } } } **Response Structure** * *(dict) --* * **StreamingConfiguration** *(dict) --* The details of the streaming configuration. * **DataRetentionInHours** *(integer) --* The amount of time, in hours, to the Kinesis data. * **Disabled** *(boolean) --* When true, streaming to Kinesis is off. * **StreamingNotificationTargets** *(list) --* The streaming notification targets. * *(dict) --* The target recipient for a streaming configuration notification. * **NotificationTarget** *(string) --* The streaming notification target. * **MediaInsightsConfiguration** *(dict) --* The call analytics configuration. * **Disabled** *(boolean) --* Denotes the configuration as enabled or disabled. * **ConfigurationArn** *(string) --* The configuration's ARN. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / create_voice_connector_group create_voice_connector_group **************************** ChimeSDKVoice.Client.create_voice_connector_group(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_voice_connector_group( Name='string', VoiceConnectorItems=[ { 'VoiceConnectorId': 'string', 'Priority': 123 }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the Voice Connector group. * **VoiceConnectorItems** (*list*) -- Lists the Voice Connectors that inbound calls are routed to. * *(dict) --* For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group. * **VoiceConnectorId** *(string) --* **[REQUIRED]** The Voice Connector ID. * **Priority** *(integer) --* **[REQUIRED]** The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight. Return type: dict Returns: **Response Syntax** { 'VoiceConnectorGroup': { 'VoiceConnectorGroupId': 'string', 'Name': 'string', 'VoiceConnectorItems': [ { 'VoiceConnectorId': 'string', 'Priority': 123 }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'VoiceConnectorGroupArn': 'string' } } **Response Structure** * *(dict) --* * **VoiceConnectorGroup** *(dict) --* The details of the Voice Connector group. * **VoiceConnectorGroupId** *(string) --* The ID of a Voice Connector group. * **Name** *(string) --* The name of a Voice Connector group. * **VoiceConnectorItems** *(list) --* The Voice Connectors to which you route inbound calls. * *(dict) --* For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **Priority** *(integer) --* The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight. * **CreatedTimestamp** *(datetime) --* The Voice Connector group's creation time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The Voice Connector group's creation time stamp, in ISO 8601 format. * **VoiceConnectorGroupArn** *(string) --* The ARN of the Voice Connector group. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_supported_phone_number_countries list_supported_phone_number_countries ************************************* ChimeSDKVoice.Client.list_supported_phone_number_countries(**kwargs) Lists the countries that you can order phone numbers from. See also: AWS API Documentation **Request Syntax** response = client.list_supported_phone_number_countries( ProductType='VoiceConnector'|'SipMediaApplicationDialIn' ) Parameters: **ProductType** (*string*) -- **[REQUIRED]** The phone number product type. Return type: dict Returns: **Response Syntax** { 'PhoneNumberCountries': [ { 'CountryCode': 'string', 'SupportedPhoneNumberTypes': [ 'Local'|'TollFree', ] }, ] } **Response Structure** * *(dict) --* * **PhoneNumberCountries** *(list) --* The supported phone number countries. * *(dict) --* The phone number's country. * **CountryCode** *(string) --* The phone number country code. Format: ISO 3166-1 alpha-2. * **SupportedPhoneNumberTypes** *(list) --* The supported phone number types. * *(string) --* **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_proxy_sessions list_proxy_sessions ******************* ChimeSDKVoice.Client.list_proxy_sessions(**kwargs) Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.list_proxy_sessions( VoiceConnectorId='string', Status='Open'|'InProgress'|'Closed', NextToken='string', MaxResults=123 ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **Status** (*string*) -- The proxy session status. * **NextToken** (*string*) -- The token used to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Return type: dict Returns: **Response Syntax** { 'ProxySessions': [ { 'VoiceConnectorId': 'string', 'ProxySessionId': 'string', 'Name': 'string', 'Status': 'Open'|'InProgress'|'Closed', 'ExpiryMinutes': 123, 'Capabilities': [ 'Voice'|'SMS', ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'EndedTimestamp': datetime(2015, 1, 1), 'Participants': [ { 'PhoneNumber': 'string', 'ProxyPhoneNumber': 'string' }, ], 'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky', 'GeoMatchLevel': 'Country'|'AreaCode', 'GeoMatchParams': { 'Country': 'string', 'AreaCode': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ProxySessions** *(list) --* The proxy sessions' details. * *(dict) --* The proxy session for an Amazon Chime SDK Voice Connector. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **ProxySessionId** *(string) --* The proxy session ID. * **Name** *(string) --* The proxy session name. * **Status** *(string) --* The proxy session status. * **ExpiryMinutes** *(integer) --* The number of minutes allowed for the proxy session. * **Capabilities** *(list) --* The proxy session capabilities. * *(string) --* * **CreatedTimestamp** *(datetime) --* The created time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated time stamp, in ISO 8601 format. * **EndedTimestamp** *(datetime) --* The ended time stamp, in ISO 8601 format. * **Participants** *(list) --* The proxy session participants. * *(dict) --* The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session. * **PhoneNumber** *(string) --* The participant's phone number. * **ProxyPhoneNumber** *(string) --* The participant's proxy phone number. * **NumberSelectionBehavior** *(string) --* The preference for proxy phone number reuse, or stickiness, between the same participants across sessions. * **GeoMatchLevel** *(string) --* The preference for matching the country or area code of the proxy phone number with that of the first participant. * **GeoMatchParams** *(dict) --* The country and area code for the proxy phone number. * **Country** *(string) --* The country. * **AreaCode** *(string) --* The area code. * **NextToken** *(string) --* The token used to retrieve the next page of results. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / start_speaker_search_task start_speaker_search_task ************************* ChimeSDKVoice.Client.start_speaker_search_task(**kwargs) Starts a speaker search task. Warning: 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. See also: AWS API Documentation **Request Syntax** response = client.start_speaker_search_task( VoiceConnectorId='string', TransactionId='string', VoiceProfileDomainId='string', ClientRequestToken='string', CallLeg='Caller'|'Callee' ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **TransactionId** (*string*) -- **[REQUIRED]** The transaction ID of the call being analyzed. * **VoiceProfileDomainId** (*string*) -- **[REQUIRED]** The ID of the voice profile domain that will store the voice profile. * **ClientRequestToken** (*string*) -- The unique identifier for the client request. Use a different token for different speaker search tasks. * **CallLeg** (*string*) -- Specifies which call leg to stream for speaker search. Return type: dict Returns: **Response Syntax** { 'SpeakerSearchTask': { 'SpeakerSearchTaskId': 'string', 'SpeakerSearchTaskStatus': 'string', 'CallDetails': { 'VoiceConnectorId': 'string', 'TransactionId': 'string', 'IsCaller': True|False }, 'SpeakerSearchDetails': { 'Results': [ { 'ConfidenceScore': ..., 'VoiceProfileId': 'string' }, ], 'VoiceprintGenerationStatus': 'string' }, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'StartedTimestamp': datetime(2015, 1, 1), 'StatusMessage': 'string' } } **Response Structure** * *(dict) --* * **SpeakerSearchTask** *(dict) --* The details of the speaker search task. * **SpeakerSearchTaskId** *(string) --* The speaker search task ID. * **SpeakerSearchTaskStatus** *(string) --* The status of the speaker search task, "IN_QUEUE", "IN_PROGRESS", "PARTIAL_SUCCESS", "SUCCEEDED", "FAILED", or "STOPPED". * **CallDetails** *(dict) --* The call details of a speaker search task. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **TransactionId** *(string) --* The transaction ID of a Voice Connector call. * **IsCaller** *(boolean) --* Identifies a person as the caller or the callee. * **SpeakerSearchDetails** *(dict) --* The details of a speaker search task. * **Results** *(list) --* The result value in the speaker search details. * *(dict) --* The result of a speaker search analysis. * **ConfidenceScore** *(float) --* The confidence score in the speaker search analysis. * **VoiceProfileId** *(string) --* The voice profile ID. * **VoiceprintGenerationStatus** *(string) --* The status of a voice print generation operation, "VoiceprintGenerationSuccess" or "VoiceprintGenerationFailure".. * **CreatedTimestamp** *(datetime) --* The time at which a speaker search task was created. * **UpdatedTimestamp** *(datetime) --* The time at which a speaker search task was updated. * **StartedTimestamp** *(datetime) --* The time at which the speaker search task began. * **StatusMessage** *(string) --* A detailed message about the status of a speaker search. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.GoneException" * "ChimeSDKVoice.Client.exceptions.UnprocessableEntityException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / can_paginate can_paginate ************ ChimeSDKVoice.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. ChimeSDKVoice / Client / list_phone_number_orders list_phone_number_orders ************************ ChimeSDKVoice.Client.list_phone_number_orders(**kwargs) Lists the phone numbers for an administrator's Amazon Chime SDK account. See also: AWS API Documentation **Request Syntax** response = client.list_phone_number_orders( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- The token used to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Return type: dict Returns: **Response Syntax** { 'PhoneNumberOrders': [ { 'PhoneNumberOrderId': 'string', 'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled', 'OrderType': 'New'|'Porting', 'OrderedPhoneNumbers': [ { 'E164PhoneNumber': 'string', 'Status': 'Processing'|'Acquired'|'Failed' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'FocDate': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PhoneNumberOrders** *(list) --* The phone number order details. * *(dict) --* The details of an Amazon Chime SDK phone number order. * **PhoneNumberOrderId** *(string) --* The ID of the phone order. * **ProductType** *(string) --* The phone number order product type. * **Status** *(string) --* The status of the phone number order. * **OrderType** *(string) --* The type of phone number being ordered, local or toll- free. * **OrderedPhoneNumbers** *(list) --* The ordered phone number details, such as the phone number in E.164 format and the phone number status. * *(dict) --* A phone number for which an order has been placed. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Status** *(string) --* The phone number status. * **CreatedTimestamp** *(datetime) --* The phone number order creation time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number order time stamp, in ISO 8601 format. * **FocDate** *(datetime) --* The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order. * **NextToken** *(string) --* The token used to retrieve the next page of results. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / associate_phone_numbers_with_voice_connector_group associate_phone_numbers_with_voice_connector_group ************************************************** ChimeSDKVoice.Client.associate_phone_numbers_with_voice_connector_group(**kwargs) Associates phone numbers with the specified Amazon Chime SDK Voice Connector group. See also: AWS API Documentation **Request Syntax** response = client.associate_phone_numbers_with_voice_connector_group( VoiceConnectorGroupId='string', E164PhoneNumbers=[ 'string', ], ForceAssociate=True|False ) Parameters: * **VoiceConnectorGroupId** (*string*) -- **[REQUIRED]** The Amazon Chime SDK Voice Connector group ID. * **E164PhoneNumbers** (*list*) -- **[REQUIRED]** List of phone numbers, in E.164 format. * *(string) --* * **ForceAssociate** (*boolean*) -- If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations. Return type: dict Returns: **Response Syntax** { 'PhoneNumberErrors': [ { 'PhoneNumberId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **PhoneNumberErrors** *(list) --* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. * *(dict) --* If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages. * **PhoneNumberId** *(string) --* The phone number ID for which the action failed. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The error message. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_proxy_session get_proxy_session ***************** ChimeSDKVoice.Client.get_proxy_session(**kwargs) Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.get_proxy_session( VoiceConnectorId='string', ProxySessionId='string' ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **ProxySessionId** (*string*) -- **[REQUIRED]** The proxy session ID. Return type: dict Returns: **Response Syntax** { 'ProxySession': { 'VoiceConnectorId': 'string', 'ProxySessionId': 'string', 'Name': 'string', 'Status': 'Open'|'InProgress'|'Closed', 'ExpiryMinutes': 123, 'Capabilities': [ 'Voice'|'SMS', ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'EndedTimestamp': datetime(2015, 1, 1), 'Participants': [ { 'PhoneNumber': 'string', 'ProxyPhoneNumber': 'string' }, ], 'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky', 'GeoMatchLevel': 'Country'|'AreaCode', 'GeoMatchParams': { 'Country': 'string', 'AreaCode': 'string' } } } **Response Structure** * *(dict) --* * **ProxySession** *(dict) --* The proxy session details. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **ProxySessionId** *(string) --* The proxy session ID. * **Name** *(string) --* The proxy session name. * **Status** *(string) --* The proxy session status. * **ExpiryMinutes** *(integer) --* The number of minutes allowed for the proxy session. * **Capabilities** *(list) --* The proxy session capabilities. * *(string) --* * **CreatedTimestamp** *(datetime) --* The created time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated time stamp, in ISO 8601 format. * **EndedTimestamp** *(datetime) --* The ended time stamp, in ISO 8601 format. * **Participants** *(list) --* The proxy session participants. * *(dict) --* The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session. * **PhoneNumber** *(string) --* The participant's phone number. * **ProxyPhoneNumber** *(string) --* The participant's proxy phone number. * **NumberSelectionBehavior** *(string) --* The preference for proxy phone number reuse, or stickiness, between the same participants across sessions. * **GeoMatchLevel** *(string) --* The preference for matching the country or area code of the proxy phone number with that of the first participant. * **GeoMatchParams** *(dict) --* The country and area code for the proxy phone number. * **Country** *(string) --* The country. * **AreaCode** *(string) --* The area code. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_phone_number delete_phone_number ******************* ChimeSDKVoice.Client.delete_phone_number(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_phone_number( PhoneNumberId='string' ) Parameters: **PhoneNumberId** (*string*) -- **[REQUIRED]** The phone number ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_phone_number_order get_phone_number_order ********************** ChimeSDKVoice.Client.get_phone_number_order(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_phone_number_order( PhoneNumberOrderId='string' ) Parameters: **PhoneNumberOrderId** (*string*) -- **[REQUIRED]** The ID of the phone number order . Return type: dict Returns: **Response Syntax** { 'PhoneNumberOrder': { 'PhoneNumberOrderId': 'string', 'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled', 'OrderType': 'New'|'Porting', 'OrderedPhoneNumbers': [ { 'E164PhoneNumber': 'string', 'Status': 'Processing'|'Acquired'|'Failed' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'FocDate': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **PhoneNumberOrder** *(dict) --* The phone number order details. * **PhoneNumberOrderId** *(string) --* The ID of the phone order. * **ProductType** *(string) --* The phone number order product type. * **Status** *(string) --* The status of the phone number order. * **OrderType** *(string) --* The type of phone number being ordered, local or toll- free. * **OrderedPhoneNumbers** *(list) --* The ordered phone number details, such as the phone number in E.164 format and the phone number status. * *(dict) --* A phone number for which an order has been placed. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Status** *(string) --* The phone number status. * **CreatedTimestamp** *(datetime) --* The phone number order creation time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number order time stamp, in ISO 8601 format. * **FocDate** *(datetime) --* The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_sip_rule delete_sip_rule *************** ChimeSDKVoice.Client.delete_sip_rule(**kwargs) Deletes a SIP rule. See also: AWS API Documentation **Request Syntax** response = client.delete_sip_rule( SipRuleId='string' ) Parameters: **SipRuleId** (*string*) -- **[REQUIRED]** The SIP rule ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_connector_origination delete_voice_connector_origination ********************************** ChimeSDKVoice.Client.delete_voice_connector_origination(**kwargs) Deletes the origination settings for the specified Amazon Chime SDK Voice Connector. Note: If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_connector_origination( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / put_sip_media_application_alexa_skill_configuration put_sip_media_application_alexa_skill_configuration *************************************************** ChimeSDKVoice.Client.put_sip_media_application_alexa_skill_configuration(**kwargs) Updates the Alexa Skill configuration for the SIP media application. Warning: Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page. Danger: This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity. See also: AWS API Documentation **Request Syntax** response = client.put_sip_media_application_alexa_skill_configuration( SipMediaApplicationId='string', SipMediaApplicationAlexaSkillConfiguration={ 'AlexaSkillStatus': 'ACTIVE'|'INACTIVE', 'AlexaSkillIds': [ 'string', ] } ) Parameters: * **SipMediaApplicationId** (*string*) -- **[REQUIRED]** The SIP media application ID. * **SipMediaApplicationAlexaSkillConfiguration** (*dict*) -- The Alexa Skill configuration. * **AlexaSkillStatus** *(string) --* **[REQUIRED]** The status of the Alexa Skill configuration. * **AlexaSkillIds** *(list) --* **[REQUIRED]** The ID of the Alexa Skill configuration. * *(string) --* Return type: dict Returns: **Response Syntax** { 'SipMediaApplicationAlexaSkillConfiguration': { 'AlexaSkillStatus': 'ACTIVE'|'INACTIVE', 'AlexaSkillIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **SipMediaApplicationAlexaSkillConfiguration** *(dict) --* Returns the Alexa Skill configuration. * **AlexaSkillStatus** *(string) --* The status of the Alexa Skill configuration. * **AlexaSkillIds** *(list) --* The ID of the Alexa Skill configuration. * *(string) --* **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_profile get_voice_profile ***************** ChimeSDKVoice.Client.get_voice_profile(**kwargs) Retrieves the details of the specified voice profile. See also: AWS API Documentation **Request Syntax** response = client.get_voice_profile( VoiceProfileId='string' ) Parameters: **VoiceProfileId** (*string*) -- **[REQUIRED]** The voice profile ID. Return type: dict Returns: **Response Syntax** { 'VoiceProfile': { 'VoiceProfileId': 'string', 'VoiceProfileArn': 'string', 'VoiceProfileDomainId': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'ExpirationTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **VoiceProfile** *(dict) --* The voice profile details. * **VoiceProfileId** *(string) --* The ID of the voice profile. * **VoiceProfileArn** *(string) --* The ARN of the voice profile. * **VoiceProfileDomainId** *(string) --* The ID of the domain that contains the voice profile. * **CreatedTimestamp** *(datetime) --* The time at which the voice profile was created and enrolled. * **UpdatedTimestamp** *(datetime) --* The time at which the voice profile was last updated. * **ExpirationTimestamp** *(datetime) --* The time at which a voice profile expires unless you re- enroll the caller via the "UpdateVoiceProfile" API. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / disassociate_phone_numbers_from_voice_connector disassociate_phone_numbers_from_voice_connector *********************************************** ChimeSDKVoice.Client.disassociate_phone_numbers_from_voice_connector(**kwargs) Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.disassociate_phone_numbers_from_voice_connector( VoiceConnectorId='string', E164PhoneNumbers=[ 'string', ] ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **E164PhoneNumbers** (*list*) -- **[REQUIRED]** List of phone numbers, in E.164 format. * *(string) --* Return type: dict Returns: **Response Syntax** { 'PhoneNumberErrors': [ { 'PhoneNumberId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **PhoneNumberErrors** *(list) --* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. * *(dict) --* If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages. * **PhoneNumberId** *(string) --* The phone number ID for which the action failed. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The error message. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / put_voice_connector_streaming_configuration put_voice_connector_streaming_configuration ******************************************* ChimeSDKVoice.Client.put_voice_connector_streaming_configuration(**kwargs) Updates a Voice Connector's streaming configuration settings. See also: AWS API Documentation **Request Syntax** response = client.put_voice_connector_streaming_configuration( VoiceConnectorId='string', StreamingConfiguration={ 'DataRetentionInHours': 123, 'Disabled': True|False, 'StreamingNotificationTargets': [ { 'NotificationTarget': 'EventBridge'|'SNS'|'SQS' }, ], 'MediaInsightsConfiguration': { 'Disabled': True|False, 'ConfigurationArn': 'string' } } ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **StreamingConfiguration** (*dict*) -- **[REQUIRED]** The streaming settings being updated. * **DataRetentionInHours** *(integer) --* **[REQUIRED]** The amount of time, in hours, to the Kinesis data. * **Disabled** *(boolean) --* **[REQUIRED]** When true, streaming to Kinesis is off. * **StreamingNotificationTargets** *(list) --* The streaming notification targets. * *(dict) --* The target recipient for a streaming configuration notification. * **NotificationTarget** *(string) --* The streaming notification target. * **MediaInsightsConfiguration** *(dict) --* The call analytics configuration. * **Disabled** *(boolean) --* Denotes the configuration as enabled or disabled. * **ConfigurationArn** *(string) --* The configuration's ARN. Return type: dict Returns: **Response Syntax** { 'StreamingConfiguration': { 'DataRetentionInHours': 123, 'Disabled': True|False, 'StreamingNotificationTargets': [ { 'NotificationTarget': 'EventBridge'|'SNS'|'SQS' }, ], 'MediaInsightsConfiguration': { 'Disabled': True|False, 'ConfigurationArn': 'string' } } } **Response Structure** * *(dict) --* * **StreamingConfiguration** *(dict) --* The updated streaming settings. * **DataRetentionInHours** *(integer) --* The amount of time, in hours, to the Kinesis data. * **Disabled** *(boolean) --* When true, streaming to Kinesis is off. * **StreamingNotificationTargets** *(list) --* The streaming notification targets. * *(dict) --* The target recipient for a streaming configuration notification. * **NotificationTarget** *(string) --* The streaming notification target. * **MediaInsightsConfiguration** *(dict) --* The call analytics configuration. * **Disabled** *(boolean) --* Denotes the configuration as enabled or disabled. * **ConfigurationArn** *(string) --* The configuration's ARN. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_connector_termination delete_voice_connector_termination ********************************** ChimeSDKVoice.Client.delete_voice_connector_termination(**kwargs) Deletes the termination settings for the specified Amazon Chime SDK Voice Connector. Note: If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_connector_termination( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_connector_proxy get_voice_connector_proxy ************************* ChimeSDKVoice.Client.get_voice_connector_proxy(**kwargs) Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.get_voice_connector_proxy( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Return type: dict Returns: **Response Syntax** { 'Proxy': { 'DefaultSessionExpiryMinutes': 123, 'Disabled': True|False, 'FallBackPhoneNumber': 'string', 'PhoneNumberCountries': [ 'string', ] } } **Response Structure** * *(dict) --* * **Proxy** *(dict) --* The proxy configuration details. * **DefaultSessionExpiryMinutes** *(integer) --* The default number of minutes allowed for proxy sessions. * **Disabled** *(boolean) --* When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector. * **FallBackPhoneNumber** *(string) --* The phone number to route calls to after a proxy session expires. * **PhoneNumberCountries** *(list) --* The countries for proxy phone numbers to be selected from. * *(string) --* **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_sip_media_application_alexa_skill_configuration get_sip_media_application_alexa_skill_configuration *************************************************** ChimeSDKVoice.Client.get_sip_media_application_alexa_skill_configuration(**kwargs) Gets the Alexa Skill configuration for the SIP media application. Warning: Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page. Danger: This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity. See also: AWS API Documentation **Request Syntax** response = client.get_sip_media_application_alexa_skill_configuration( SipMediaApplicationId='string' ) Parameters: **SipMediaApplicationId** (*string*) -- **[REQUIRED]** The SIP media application ID. Return type: dict Returns: **Response Syntax** { 'SipMediaApplicationAlexaSkillConfiguration': { 'AlexaSkillStatus': 'ACTIVE'|'INACTIVE', 'AlexaSkillIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **SipMediaApplicationAlexaSkillConfiguration** *(dict) --* Returns the Alexa Skill configuration. * **AlexaSkillStatus** *(string) --* The status of the Alexa Skill configuration. * **AlexaSkillIds** *(list) --* The ID of the Alexa Skill configuration. * *(string) --* **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / stop_speaker_search_task stop_speaker_search_task ************************ ChimeSDKVoice.Client.stop_speaker_search_task(**kwargs) Stops a speaker search task. See also: AWS API Documentation **Request Syntax** response = client.stop_speaker_search_task( VoiceConnectorId='string', SpeakerSearchTaskId='string' ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **SpeakerSearchTaskId** (*string*) -- **[REQUIRED]** The speaker search task ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.UnprocessableEntityException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / validate_e911_address validate_e911_address ********************* ChimeSDKVoice.Client.validate_e911_address(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.validate_e911_address( AwsAccountId='string', StreetNumber='string', StreetInfo='string', City='string', State='string', Country='string', PostalCode='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The AWS account ID. * **StreetNumber** (*string*) -- **[REQUIRED]** The address street number, such as "200" or "2121". * **StreetInfo** (*string*) -- **[REQUIRED]** The address street information, such as "8th Avenue". * **City** (*string*) -- **[REQUIRED]** The address city, such as "Portland". * **State** (*string*) -- **[REQUIRED]** The address state, such as "ME". * **Country** (*string*) -- **[REQUIRED]** The country in the address being validated as two-letter country code in ISO 3166-1 alpha-2 format, such as "US". For more information, see ISO 3166-1 alpha-2 in Wikipedia. * **PostalCode** (*string*) -- **[REQUIRED]** The dress postal code, such "04352". Return type: dict Returns: **Response Syntax** { 'ValidationResult': 123, 'AddressExternalId': 'string', 'Address': { 'streetName': 'string', 'streetSuffix': 'string', 'postDirectional': 'string', 'preDirectional': 'string', 'streetNumber': 'string', 'city': 'string', 'state': 'string', 'postalCode': 'string', 'postalCodePlus4': 'string', 'country': 'string' }, 'CandidateAddressList': [ { 'streetInfo': 'string', 'streetNumber': 'string', 'city': 'string', 'state': 'string', 'postalCode': 'string', 'postalCodePlus4': 'string', 'country': 'string' }, ] } **Response Structure** * *(dict) --* * **ValidationResult** *(integer) --* Number indicating the result of address validation. Each possible result is defined as follows: * "0" - Address validation succeeded. * "1" - Address validation succeeded. The address was a close enough match and has been corrected as part of the address object. * "2" - Address validation failed. You should re-submit the validation request with candidates from the "CandidateAddressList" result, if it's a close match. * **AddressExternalId** *(string) --* The ID that represents the address. * **Address** *(dict) --* The validated address. * **streetName** *(string) --* The address street, such as "8th Avenue". * **streetSuffix** *(string) --* The address suffix, such as the "N" in "8th Avenue N". * **postDirectional** *(string) --* An address suffix location, such as the "S. Unit A" in "Central Park S. Unit A". * **preDirectional** *(string) --* An address prefix location, such as the "N" in "N. Third St." * **streetNumber** *(string) --* The numeric portion of an address. * **city** *(string) --* The city of an address. * **state** *(string) --* The state of an address. * **postalCode** *(string) --* The postal code of an address. * **postalCodePlus4** *(string) --* The zip + 4 or postal code + 4 of an address. * **country** *(string) --* The country of an address. * **CandidateAddressList** *(list) --* The list of address suggestions.. * *(dict) --* A suggested address. * **streetInfo** *(string) --* The street information of the candidate address. * **streetNumber** *(string) --* The numeric portion of the candidate address. * **city** *(string) --* The city of the candidate address. * **state** *(string) --* The state of the candidate address. * **postalCode** *(string) --* The postal code of the candidate address. * **postalCodePlus4** *(string) --* The zip + 4 or postal code +4 of the candidate address. * **country** *(string) --* The country of the candidate address. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / put_sip_media_application_logging_configuration put_sip_media_application_logging_configuration *********************************************** ChimeSDKVoice.Client.put_sip_media_application_logging_configuration(**kwargs) Updates the logging configuration for the specified SIP media application. See also: AWS API Documentation **Request Syntax** response = client.put_sip_media_application_logging_configuration( SipMediaApplicationId='string', SipMediaApplicationLoggingConfiguration={ 'EnableSipMediaApplicationMessageLogs': True|False } ) Parameters: * **SipMediaApplicationId** (*string*) -- **[REQUIRED]** The SIP media application ID. * **SipMediaApplicationLoggingConfiguration** (*dict*) -- The logging configuration for the specified SIP media application. * **EnableSipMediaApplicationMessageLogs** *(boolean) --* Enables message logging for the specified SIP media application. Return type: dict Returns: **Response Syntax** { 'SipMediaApplicationLoggingConfiguration': { 'EnableSipMediaApplicationMessageLogs': True|False } } **Response Structure** * *(dict) --* * **SipMediaApplicationLoggingConfiguration** *(dict) --* The updated logging configuration for the specified SIP media application. * **EnableSipMediaApplicationMessageLogs** *(boolean) --* Enables message logging for the specified SIP media application. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / update_proxy_session update_proxy_session ******************** ChimeSDKVoice.Client.update_proxy_session(**kwargs) Updates the specified proxy session details, such as voice or SMS capabilities. See also: AWS API Documentation **Request Syntax** response = client.update_proxy_session( VoiceConnectorId='string', ProxySessionId='string', Capabilities=[ 'Voice'|'SMS', ], ExpiryMinutes=123 ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **ProxySessionId** (*string*) -- **[REQUIRED]** The proxy session ID. * **Capabilities** (*list*) -- **[REQUIRED]** The proxy session capabilities. * *(string) --* * **ExpiryMinutes** (*integer*) -- The number of minutes allowed for the proxy session. Return type: dict Returns: **Response Syntax** { 'ProxySession': { 'VoiceConnectorId': 'string', 'ProxySessionId': 'string', 'Name': 'string', 'Status': 'Open'|'InProgress'|'Closed', 'ExpiryMinutes': 123, 'Capabilities': [ 'Voice'|'SMS', ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'EndedTimestamp': datetime(2015, 1, 1), 'Participants': [ { 'PhoneNumber': 'string', 'ProxyPhoneNumber': 'string' }, ], 'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky', 'GeoMatchLevel': 'Country'|'AreaCode', 'GeoMatchParams': { 'Country': 'string', 'AreaCode': 'string' } } } **Response Structure** * *(dict) --* * **ProxySession** *(dict) --* The updated proxy session details. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **ProxySessionId** *(string) --* The proxy session ID. * **Name** *(string) --* The proxy session name. * **Status** *(string) --* The proxy session status. * **ExpiryMinutes** *(integer) --* The number of minutes allowed for the proxy session. * **Capabilities** *(list) --* The proxy session capabilities. * *(string) --* * **CreatedTimestamp** *(datetime) --* The created time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated time stamp, in ISO 8601 format. * **EndedTimestamp** *(datetime) --* The ended time stamp, in ISO 8601 format. * **Participants** *(list) --* The proxy session participants. * *(dict) --* The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session. * **PhoneNumber** *(string) --* The participant's phone number. * **ProxyPhoneNumber** *(string) --* The participant's proxy phone number. * **NumberSelectionBehavior** *(string) --* The preference for proxy phone number reuse, or stickiness, between the same participants across sessions. * **GeoMatchLevel** *(string) --* The preference for matching the country or area code of the proxy phone number with that of the first participant. * **GeoMatchParams** *(dict) --* The country and area code for the proxy phone number. * **Country** *(string) --* The country. * **AreaCode** *(string) --* The area code. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_global_settings get_global_settings ******************* ChimeSDKVoice.Client.get_global_settings() Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account. See also: AWS API Documentation **Request Syntax** response = client.get_global_settings() Return type: dict Returns: **Response Syntax** { 'VoiceConnector': { 'CdrBucket': 'string' } } **Response Structure** * *(dict) --* * **VoiceConnector** *(dict) --* The Voice Connector settings. * **CdrBucket** *(string) --* The S3 bucket that stores the Voice Connector's call detail records. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / create_voice_profile_domain create_voice_profile_domain *************************** ChimeSDKVoice.Client.create_voice_profile_domain(**kwargs) Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio. Warning: 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*. See also: AWS API Documentation **Request Syntax** response = client.create_voice_profile_domain( Name='string', Description='string', ServerSideEncryptionConfiguration={ 'KmsKeyArn': 'string' }, ClientRequestToken='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the voice profile domain. * **Description** (*string*) -- A description of the voice profile domain. * **ServerSideEncryptionConfiguration** (*dict*) -- **[REQUIRED]** The server-side encryption configuration for the request. * **KmsKeyArn** *(string) --* **[REQUIRED]** The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported. * **ClientRequestToken** (*string*) -- The unique identifier for the client request. Use a different token for different domain creation requests. * **Tags** (*list*) -- The tags assigned to the domain. * *(dict) --* Describes a tag applied to a resource. * **Key** *(string) --* **[REQUIRED]** The tag's key. * **Value** *(string) --* **[REQUIRED]** The tag's value. Return type: dict Returns: **Response Syntax** { 'VoiceProfileDomain': { 'VoiceProfileDomainId': 'string', 'VoiceProfileDomainArn': 'string', 'Name': 'string', 'Description': 'string', 'ServerSideEncryptionConfiguration': { 'KmsKeyArn': 'string' }, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **VoiceProfileDomain** *(dict) --* The requested voice profile domain. * **VoiceProfileDomainId** *(string) --* The ID of the voice profile domain. * **VoiceProfileDomainArn** *(string) --* The voice profile domain's Amazon Resource Number (ARN). * **Name** *(string) --* The name of the voice profile domain. * **Description** *(string) --* The description of the voice profile domain. * **ServerSideEncryptionConfiguration** *(dict) --* A structure that contains the configuration settings for server-side encryption. * **KmsKeyArn** *(string) --* The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported. * **CreatedTimestamp** *(datetime) --* The time at which the voice profile domain was created. * **UpdatedTimestamp** *(datetime) --* The time at which the voice profile was last updated. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / update_voice_profile update_voice_profile ******************** ChimeSDKVoice.Client.update_voice_profile(**kwargs) Updates the specified voice profile’s voice print and refreshes its expiration timestamp. Warning: 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. See also: AWS API Documentation **Request Syntax** response = client.update_voice_profile( VoiceProfileId='string', SpeakerSearchTaskId='string' ) Parameters: * **VoiceProfileId** (*string*) -- **[REQUIRED]** The profile ID. * **SpeakerSearchTaskId** (*string*) -- **[REQUIRED]** The ID of the speaker search task. Return type: dict Returns: **Response Syntax** { 'VoiceProfile': { 'VoiceProfileId': 'string', 'VoiceProfileArn': 'string', 'VoiceProfileDomainId': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'ExpirationTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **VoiceProfile** *(dict) --* The updated voice profile settings. * **VoiceProfileId** *(string) --* The ID of the voice profile. * **VoiceProfileArn** *(string) --* The ARN of the voice profile. * **VoiceProfileDomainId** *(string) --* The ID of the domain that contains the voice profile. * **CreatedTimestamp** *(datetime) --* The time at which the voice profile was created and enrolled. * **UpdatedTimestamp** *(datetime) --* The time at which the voice profile was last updated. * **ExpirationTimestamp** *(datetime) --* The time at which a voice profile expires unless you re- enroll the caller via the "UpdateVoiceProfile" API. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.GoneException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_tags_for_resource list_tags_for_resource ********************** ChimeSDKVoice.Client.list_tags_for_resource(**kwargs) Returns a list of the tags in a given resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceARN='string' ) Parameters: **ResourceARN** (*string*) -- **[REQUIRED]** The resource ARN. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* The tags in the list. * *(dict) --* Describes a tag applied to a resource. * **Key** *(string) --* The tag's key. * **Value** *(string) --* The tag's value. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_voice_connector_termination_credentials list_voice_connector_termination_credentials ******************************************** ChimeSDKVoice.Client.list_voice_connector_termination_credentials(**kwargs) Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.list_voice_connector_termination_credentials( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Return type: dict Returns: **Response Syntax** { 'Usernames': [ 'string', ] } **Response Structure** * *(dict) --* * **Usernames** *(list) --* A list of user names. * *(string) --* **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / create_sip_media_application_call create_sip_media_application_call ********************************* ChimeSDKVoice.Client.create_sip_media_application_call(**kwargs) 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". See also: AWS API Documentation **Request Syntax** response = client.create_sip_media_application_call( FromPhoneNumber='string', ToPhoneNumber='string', SipMediaApplicationId='string', SipHeaders={ 'string': 'string' }, ArgumentsMap={ 'string': 'string' } ) Parameters: * **FromPhoneNumber** (*string*) -- **[REQUIRED]** The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory. * **ToPhoneNumber** (*string*) -- **[REQUIRED]** The phone number that the service should call. * **SipMediaApplicationId** (*string*) -- **[REQUIRED]** The ID of the SIP media application. * **SipHeaders** (*dict*) -- The SIP headers added to an outbound call leg. * *(string) --* * *(string) --* * **ArgumentsMap** (*dict*) -- Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: ""FirstName": "John", "LastName": "Doe"" * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'SipMediaApplicationCall': { 'TransactionId': 'string' } } **Response Structure** * *(dict) --* * **SipMediaApplicationCall** *(dict) --* The actual call. * **TransactionId** *(string) --* The call's transaction ID. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / update_phone_number_settings update_phone_number_settings **************************** ChimeSDKVoice.Client.update_phone_number_settings(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.update_phone_number_settings( CallingName='string' ) Parameters: **CallingName** (*string*) -- **[REQUIRED]** The default outbound calling name for the account. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_sip_rule get_sip_rule ************ ChimeSDKVoice.Client.get_sip_rule(**kwargs) Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints. See also: AWS API Documentation **Request Syntax** response = client.get_sip_rule( SipRuleId='string' ) Parameters: **SipRuleId** (*string*) -- **[REQUIRED]** The SIP rule ID. Return type: dict Returns: **Response Syntax** { 'SipRule': { 'SipRuleId': 'string', 'Name': 'string', 'Disabled': True|False, 'TriggerType': 'ToPhoneNumber'|'RequestUriHostname', 'TriggerValue': 'string', 'TargetApplications': [ { 'SipMediaApplicationId': 'string', 'Priority': 123, 'AwsRegion': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **SipRule** *(dict) --* The SIP rule details. * **SipRuleId** *(string) --* A SIP rule's ID. * **Name** *(string) --* A SIP rule's name. * **Disabled** *(boolean) --* Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it. * **TriggerType** *(string) --* The type of trigger set for a SIP rule, either a phone number or a URI request host name. * **TriggerValue** *(string) --* The value set for a SIP rule's trigger type. Either a phone number or a URI hostname. * **TargetApplications** *(list) --* The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * *(dict) --* A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * **SipMediaApplicationId** *(string) --* The ID of a rule's target SIP media application. * **Priority** *(integer) --* The priority setting of a rule's target SIP media application. * **AwsRegion** *(string) --* The AWS Region of a rule's target SIP media application. * **CreatedTimestamp** *(datetime) --* The time at which the SIP rule was created, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The time at which the SIP rule was updated, in ISO 8601 format. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / update_voice_connector_group update_voice_connector_group **************************** ChimeSDKVoice.Client.update_voice_connector_group(**kwargs) Updates the settings for the specified Amazon Chime SDK Voice Connector group. See also: AWS API Documentation **Request Syntax** response = client.update_voice_connector_group( VoiceConnectorGroupId='string', Name='string', VoiceConnectorItems=[ { 'VoiceConnectorId': 'string', 'Priority': 123 }, ] ) Parameters: * **VoiceConnectorGroupId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **Name** (*string*) -- **[REQUIRED]** The name of the Voice Connector group. * **VoiceConnectorItems** (*list*) -- **[REQUIRED]** The "VoiceConnectorItems" to associate with the Voice Connector group. * *(dict) --* For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group. * **VoiceConnectorId** *(string) --* **[REQUIRED]** The Voice Connector ID. * **Priority** *(integer) --* **[REQUIRED]** The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight. Return type: dict Returns: **Response Syntax** { 'VoiceConnectorGroup': { 'VoiceConnectorGroupId': 'string', 'Name': 'string', 'VoiceConnectorItems': [ { 'VoiceConnectorId': 'string', 'Priority': 123 }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'VoiceConnectorGroupArn': 'string' } } **Response Structure** * *(dict) --* * **VoiceConnectorGroup** *(dict) --* The updated Voice Connector group. * **VoiceConnectorGroupId** *(string) --* The ID of a Voice Connector group. * **Name** *(string) --* The name of a Voice Connector group. * **VoiceConnectorItems** *(list) --* The Voice Connectors to which you route inbound calls. * *(dict) --* For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **Priority** *(integer) --* The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight. * **CreatedTimestamp** *(datetime) --* The Voice Connector group's creation time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The Voice Connector group's creation time stamp, in ISO 8601 format. * **VoiceConnectorGroupArn** *(string) --* The ARN of the Voice Connector group. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / untag_resource untag_resource ************** ChimeSDKVoice.Client.untag_resource(**kwargs) Removes tags from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceARN='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource having its tags removed. * **TagKeys** (*list*) -- **[REQUIRED]** The keys of the tags being removed from the resource. * *(string) --* Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_connector_emergency_calling_configuration delete_voice_connector_emergency_calling_configuration ****************************************************** ChimeSDKVoice.Client.delete_voice_connector_emergency_calling_configuration(**kwargs) Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_connector_emergency_calling_configuration( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_profile_domain delete_voice_profile_domain *************************** ChimeSDKVoice.Client.delete_voice_profile_domain(**kwargs) Deletes all voice profiles in the domain. WARNING: This action is not reversible. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_profile_domain( VoiceProfileDomainId='string' ) Parameters: **VoiceProfileDomainId** (*string*) -- **[REQUIRED]** The voice profile domain ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_sip_media_application get_sip_media_application ************************* ChimeSDKVoice.Client.get_sip_media_application(**kwargs) Retrieves the information for a SIP media application, including name, AWS Region, and endpoints. See also: AWS API Documentation **Request Syntax** response = client.get_sip_media_application( SipMediaApplicationId='string' ) Parameters: **SipMediaApplicationId** (*string*) -- **[REQUIRED]** The SIP media application ID . Return type: dict Returns: **Response Syntax** { 'SipMediaApplication': { 'SipMediaApplicationId': 'string', 'AwsRegion': 'string', 'Name': 'string', 'Endpoints': [ { 'LambdaArn': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'SipMediaApplicationArn': 'string' } } **Response Structure** * *(dict) --* * **SipMediaApplication** *(dict) --* The details of the SIP media application. * **SipMediaApplicationId** *(string) --* A SIP media application's ID. * **AwsRegion** *(string) --* The AWS Region in which the SIP media application is created. * **Name** *(string) --* The SIP media application's name. * **Endpoints** *(list) --* List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted. * *(dict) --* The endpoint assigned to a SIP media application. * **LambdaArn** *(string) --* Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application. * **CreatedTimestamp** *(datetime) --* The SIP media application creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The time at which the SIP media application was updated. * **SipMediaApplicationArn** *(string) --* The ARN of the SIP media application. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_connector_group delete_voice_connector_group **************************** ChimeSDKVoice.Client.delete_voice_connector_group(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_connector_group( VoiceConnectorGroupId='string' ) Parameters: **VoiceConnectorGroupId** (*string*) -- **[REQUIRED]** The Voice Connector Group ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / update_global_settings update_global_settings ********************** ChimeSDKVoice.Client.update_global_settings(**kwargs) Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account. See also: AWS API Documentation **Request Syntax** response = client.update_global_settings( VoiceConnector={ 'CdrBucket': 'string' } ) Parameters: **VoiceConnector** (*dict*) -- The Voice Connector settings. * **CdrBucket** *(string) --* The S3 bucket that stores the Voice Connector's call detail records. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_tone_analysis_task get_voice_tone_analysis_task **************************** ChimeSDKVoice.Client.get_voice_tone_analysis_task(**kwargs) Retrieves the details of a voice tone analysis task. See also: AWS API Documentation **Request Syntax** response = client.get_voice_tone_analysis_task( VoiceConnectorId='string', VoiceToneAnalysisTaskId='string', IsCaller=True|False ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **VoiceToneAnalysisTaskId** (*string*) -- **[REQUIRED]** The ID of the voice tone analysis task. * **IsCaller** (*boolean*) -- **[REQUIRED]** Specifies whether the voice being analyzed is the caller (originator) or the callee (responder). Return type: dict Returns: **Response Syntax** { 'VoiceToneAnalysisTask': { 'VoiceToneAnalysisTaskId': 'string', 'VoiceToneAnalysisTaskStatus': 'string', 'CallDetails': { 'VoiceConnectorId': 'string', 'TransactionId': 'string', 'IsCaller': True|False }, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'StartedTimestamp': datetime(2015, 1, 1), 'StatusMessage': 'string' } } **Response Structure** * *(dict) --* * **VoiceToneAnalysisTask** *(dict) --* The details of the voice tone analysis task. * **VoiceToneAnalysisTaskId** *(string) --* The ID of the voice tone analysis task. * **VoiceToneAnalysisTaskStatus** *(string) --* The status of a voice tone analysis task, "IN_QUEUE", "IN_PROGRESS", "PARTIAL_SUCCESS", "SUCCEEDED", "FAILED", or "STOPPED". * **CallDetails** *(dict) --* The call details of a voice tone analysis task. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **TransactionId** *(string) --* The transaction ID of a Voice Connector call. * **IsCaller** *(boolean) --* Identifies a person as the caller or the callee. * **CreatedTimestamp** *(datetime) --* The time at which a voice tone analysis task was created. * **UpdatedTimestamp** *(datetime) --* The time at which a voice tone analysis task was updated. * **StartedTimestamp** *(datetime) --* The time at which a voice tone analysis task started. * **StatusMessage** *(string) --* The status of a voice tone analysis task. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" ChimeSDKVoice / Client / delete_proxy_session delete_proxy_session ******************** ChimeSDKVoice.Client.delete_proxy_session(**kwargs) Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.delete_proxy_session( VoiceConnectorId='string', ProxySessionId='string' ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **ProxySessionId** (*string*) -- **[REQUIRED]** The proxy session ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_waiter get_waiter ********** ChimeSDKVoice.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" ChimeSDKVoice / Client / put_voice_connector_termination_credentials put_voice_connector_termination_credentials ******************************************* ChimeSDKVoice.Client.put_voice_connector_termination_credentials(**kwargs) Updates a Voice Connector's termination credentials. See also: AWS API Documentation **Request Syntax** response = client.put_voice_connector_termination_credentials( VoiceConnectorId='string', Credentials=[ { 'Username': 'string', 'Password': 'string' }, ] ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **Credentials** (*list*) -- The termination credentials being updated. * *(dict) --* The SIP credentials used to authenticate requests to an Amazon Chime SDK Voice Connector. * **Username** *(string) --* The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format. * **Password** *(string) --* The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / update_voice_profile_domain update_voice_profile_domain *************************** ChimeSDKVoice.Client.update_voice_profile_domain(**kwargs) Updates the settings for the specified voice profile domain. See also: AWS API Documentation **Request Syntax** response = client.update_voice_profile_domain( VoiceProfileDomainId='string', Name='string', Description='string' ) Parameters: * **VoiceProfileDomainId** (*string*) -- **[REQUIRED]** The domain ID. * **Name** (*string*) -- The name of the voice profile domain. * **Description** (*string*) -- The description of the voice profile domain. Return type: dict Returns: **Response Syntax** { 'VoiceProfileDomain': { 'VoiceProfileDomainId': 'string', 'VoiceProfileDomainArn': 'string', 'Name': 'string', 'Description': 'string', 'ServerSideEncryptionConfiguration': { 'KmsKeyArn': 'string' }, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **VoiceProfileDomain** *(dict) --* The updated details of the voice profile domain. * **VoiceProfileDomainId** *(string) --* The ID of the voice profile domain. * **VoiceProfileDomainArn** *(string) --* The voice profile domain's Amazon Resource Number (ARN). * **Name** *(string) --* The name of the voice profile domain. * **Description** *(string) --* The description of the voice profile domain. * **ServerSideEncryptionConfiguration** *(dict) --* A structure that contains the configuration settings for server-side encryption. * **KmsKeyArn** *(string) --* The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported. * **CreatedTimestamp** *(datetime) --* The time at which the voice profile domain was created. * **UpdatedTimestamp** *(datetime) --* The time at which the voice profile was last updated. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_connector_termination get_voice_connector_termination ******************************* ChimeSDKVoice.Client.get_voice_connector_termination(**kwargs) Retrieves the termination setting details for the specified Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.get_voice_connector_termination( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Return type: dict Returns: **Response Syntax** { 'Termination': { 'CpsLimit': 123, 'DefaultPhoneNumber': 'string', 'CallingRegions': [ 'string', ], 'CidrAllowedList': [ 'string', ], 'Disabled': True|False } } **Response Structure** * *(dict) --* * **Termination** *(dict) --* The termination setting details. * **CpsLimit** *(integer) --* The limit on calls per second. Max value based on account service quota. Default value of 1. * **DefaultPhoneNumber** *(string) --* The default outbound calling number. * **CallingRegions** *(list) --* The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required. * *(string) --* * **CidrAllowedList** *(list) --* The IP addresses allowed to make calls, in CIDR format. * *(string) --* * **Disabled** *(boolean) --* When termination is disabled, outbound calls cannot be made. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / update_sip_media_application_call update_sip_media_application_call ********************************* ChimeSDKVoice.Client.update_sip_media_application_call(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.update_sip_media_application_call( SipMediaApplicationId='string', TransactionId='string', Arguments={ 'string': 'string' } ) Parameters: * **SipMediaApplicationId** (*string*) -- **[REQUIRED]** The ID of the SIP media application handling the call. * **TransactionId** (*string*) -- **[REQUIRED]** The ID of the call transaction. * **Arguments** (*dict*) -- **[REQUIRED]** Arguments made available to the Lambda function as part of the "CALL_UPDATE_REQUESTED" event. Can contain 0-20 key-value pairs. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'SipMediaApplicationCall': { 'TransactionId': 'string' } } **Response Structure** * *(dict) --* * **SipMediaApplicationCall** *(dict) --* A "Call" instance for a SIP media application. * **TransactionId** *(string) --* The call's transaction ID. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_connector_emergency_calling_configuration get_voice_connector_emergency_calling_configuration *************************************************** ChimeSDKVoice.Client.get_voice_connector_emergency_calling_configuration(**kwargs) Retrieves the emergency calling configuration details for the specified Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.get_voice_connector_emergency_calling_configuration( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Return type: dict Returns: **Response Syntax** { 'EmergencyCallingConfiguration': { 'DNIS': [ { 'EmergencyPhoneNumber': 'string', 'TestPhoneNumber': 'string', 'CallingCountry': 'string' }, ] } } **Response Structure** * *(dict) --* * **EmergencyCallingConfiguration** *(dict) --* The details of the emergency calling configuration. * **DNIS** *(list) --* The Dialed Number Identification Service (DNIS) emergency calling configuration details. * *(dict) --* The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime SDK Voice Connector's emergency calling configuration. * **EmergencyPhoneNumber** *(string) --* The DNIS phone number that you route emergency calls to, in E.164 format. * **TestPhoneNumber** *(string) --* The DNIS phone number for routing test emergency calls to, in E.164 format. * **CallingCountry** *(string) --* The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / batch_update_phone_number batch_update_phone_number ************************* ChimeSDKVoice.Client.batch_update_phone_number(**kwargs) Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each "UpdatePhoneNumberRequestItem". For example, you can update the product type, the calling name, or phone name. Note: You cannot have a duplicate "phoneNumberId" in a request. See also: AWS API Documentation **Request Syntax** response = client.batch_update_phone_number( UpdatePhoneNumberRequestItems=[ { 'PhoneNumberId': 'string', 'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn', 'CallingName': 'string', 'Name': 'string' }, ] ) Parameters: **UpdatePhoneNumberRequestItems** (*list*) -- **[REQUIRED]** Lists the phone numbers in the update request. * *(dict) --* The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions. * **PhoneNumberId** *(string) --* **[REQUIRED]** The phone number ID to update. * **ProductType** *(string) --* The product type to update. * **CallingName** *(string) --* The outbound calling name to update. * **Name** *(string) --* The name of the phone number. Return type: dict Returns: **Response Syntax** { 'PhoneNumberErrors': [ { 'PhoneNumberId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **PhoneNumberErrors** *(list) --* A list of failed phone numbers and their error messages. * *(dict) --* If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages. * **PhoneNumberId** *(string) --* The phone number ID for which the action failed. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The error message. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_connector_origination get_voice_connector_origination ******************************* ChimeSDKVoice.Client.get_voice_connector_origination(**kwargs) Retrieves the origination settings for the specified Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.get_voice_connector_origination( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Return type: dict Returns: **Response Syntax** { 'Origination': { 'Routes': [ { 'Host': 'string', 'Port': 123, 'Protocol': 'TCP'|'UDP', 'Priority': 123, 'Weight': 123 }, ], 'Disabled': True|False } } **Response Structure** * *(dict) --* * **Origination** *(dict) --* The origination setting details. * **Routes** *(list) --* The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or "Disabled". * *(dict) --* Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector. Note: The parameters listed below are not required, but you must use at least one. * **Host** *(string) --* The FQDN or IP address to contact for origination traffic. * **Port** *(integer) --* The designated origination route port. Defaults to 5060. * **Protocol** *(string) --* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default. * **Priority** *(integer) --* The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first. * **Weight** *(integer) --* The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights. * **Disabled** *(boolean) --* When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or "Routes". **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / put_voice_connector_proxy put_voice_connector_proxy ************************* ChimeSDKVoice.Client.put_voice_connector_proxy(**kwargs) Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.put_voice_connector_proxy( VoiceConnectorId='string', DefaultSessionExpiryMinutes=123, PhoneNumberPoolCountries=[ 'string', ], FallBackPhoneNumber='string', Disabled=True|False ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **DefaultSessionExpiryMinutes** (*integer*) -- **[REQUIRED]** The default number of minutes allowed for proxy session. * **PhoneNumberPoolCountries** (*list*) -- **[REQUIRED]** The countries for proxy phone numbers to be selected from. * *(string) --* * **FallBackPhoneNumber** (*string*) -- The phone number to route calls to after a proxy session expires. * **Disabled** (*boolean*) -- When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector. Return type: dict Returns: **Response Syntax** { 'Proxy': { 'DefaultSessionExpiryMinutes': 123, 'Disabled': True|False, 'FallBackPhoneNumber': 'string', 'PhoneNumberCountries': [ 'string', ] } } **Response Structure** * *(dict) --* * **Proxy** *(dict) --* The proxy configuration details. * **DefaultSessionExpiryMinutes** *(integer) --* The default number of minutes allowed for proxy sessions. * **Disabled** *(boolean) --* When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector. * **FallBackPhoneNumber** *(string) --* The phone number to route calls to after a proxy session expires. * **PhoneNumberCountries** *(list) --* The countries for proxy phone numbers to be selected from. * *(string) --* **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_profile delete_voice_profile ******************** ChimeSDKVoice.Client.delete_voice_profile(**kwargs) Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_profile( VoiceProfileId='string' ) Parameters: **VoiceProfileId** (*string*) -- **[REQUIRED]** The voice profile ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_voice_connectors list_voice_connectors ********************* ChimeSDKVoice.Client.list_voice_connectors(**kwargs) Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account. See also: AWS API Documentation **Request Syntax** response = client.list_voice_connectors( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- The token used to return the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Return type: dict Returns: **Response Syntax** { 'VoiceConnectors': [ { 'VoiceConnectorId': 'string', 'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2', 'Name': 'string', 'OutboundHostName': 'string', 'RequireEncryption': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'VoiceConnectorArn': 'string', 'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **VoiceConnectors** *(list) --* The details of the Voice Connectors. * *(dict) --* The Amazon Chime SDK Voice Connector configuration, including outbound host name and encryption settings. * **VoiceConnectorId** *(string) --* The Voice Connector's ID. * **AwsRegion** *(string) --* The AWS Region in which the Voice Connector is created. Default: us-east-1. * **Name** *(string) --* The Voice Connector's name. * **OutboundHostName** *(string) --* The outbound host name for the Voice Connector. * **RequireEncryption** *(boolean) --* Enables or disables encryption for the Voice Connector. * **CreatedTimestamp** *(datetime) --* The Voice Connector's creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The Voice Connector's updated timestamp, in ISO 8601 format. * **VoiceConnectorArn** *(string) --* The ARN of the Voice Connector. * **IntegrationType** *(string) --* The connectors for use with Amazon Connect. * **NextToken** *(string) --* The token used to return the next page of results. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_voice_profile_domains list_voice_profile_domains ************************** ChimeSDKVoice.Client.list_voice_profile_domains(**kwargs) Lists the specified voice profile domains in the administrator's AWS account. See also: AWS API Documentation **Request Syntax** response = client.list_voice_profile_domains( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- The token used to return the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Return type: dict Returns: **Response Syntax** { 'VoiceProfileDomains': [ { 'VoiceProfileDomainId': 'string', 'VoiceProfileDomainArn': 'string', 'Name': 'string', 'Description': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **VoiceProfileDomains** *(list) --* The list of voice profile domains. * *(dict) --* A high-level overview of a voice profile domain. * **VoiceProfileDomainId** *(string) --* The ID of the voice profile domain summary. * **VoiceProfileDomainArn** *(string) --* The ARN of a voice profile in a voice profile domain summary. * **Name** *(string) --* The name of the voice profile domain summary. * **Description** *(string) --* Describes the voice profile domain summary. * **CreatedTimestamp** *(datetime) --* The time at which the voice profile domain summary was created. * **UpdatedTimestamp** *(datetime) --* The time at which the voice profile domain summary was last updated. * **NextToken** *(string) --* The token used to return the next page of results. **Exceptions** * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_connector_termination_health get_voice_connector_termination_health ************************************** ChimeSDKVoice.Client.get_voice_connector_termination_health(**kwargs) Retrieves information about the last time a "SIP OPTIONS" ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.get_voice_connector_termination_health( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Return type: dict Returns: **Response Syntax** { 'TerminationHealth': { 'Timestamp': datetime(2015, 1, 1), 'Source': 'string' } } **Response Structure** * *(dict) --* * **TerminationHealth** *(dict) --* The termination health details. * **Timestamp** *(datetime) --* The timestamp, in ISO 8601 format. * **Source** *(string) --* The source IP address. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / associate_phone_numbers_with_voice_connector associate_phone_numbers_with_voice_connector ******************************************** ChimeSDKVoice.Client.associate_phone_numbers_with_voice_connector(**kwargs) Associates phone numbers with the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.associate_phone_numbers_with_voice_connector( VoiceConnectorId='string', E164PhoneNumbers=[ 'string', ], ForceAssociate=True|False ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **E164PhoneNumbers** (*list*) -- **[REQUIRED]** List of phone numbers, in E.164 format. * *(string) --* * **ForceAssociate** (*boolean*) -- If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations. Return type: dict Returns: **Response Syntax** { 'PhoneNumberErrors': [ { 'PhoneNumberId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **PhoneNumberErrors** *(list) --* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. * *(dict) --* If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages. * **PhoneNumberId** *(string) --* The phone number ID for which the action failed. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The error message. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_sip_media_application_logging_configuration get_sip_media_application_logging_configuration *********************************************** ChimeSDKVoice.Client.get_sip_media_application_logging_configuration(**kwargs) Retrieves the logging configuration for the specified SIP media application. See also: AWS API Documentation **Request Syntax** response = client.get_sip_media_application_logging_configuration( SipMediaApplicationId='string' ) Parameters: **SipMediaApplicationId** (*string*) -- **[REQUIRED]** The SIP media application ID. Return type: dict Returns: **Response Syntax** { 'SipMediaApplicationLoggingConfiguration': { 'EnableSipMediaApplicationMessageLogs': True|False } } **Response Structure** * *(dict) --* * **SipMediaApplicationLoggingConfiguration** *(dict) --* The actual logging configuration. * **EnableSipMediaApplicationMessageLogs** *(boolean) --* Enables message logging for the specified SIP media application. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_connector_external_systems_configuration delete_voice_connector_external_systems_configuration ***************************************************** ChimeSDKVoice.Client.delete_voice_connector_external_systems_configuration(**kwargs) Deletes the external systems configuration for a Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_connector_external_systems_configuration( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The ID of the Voice Connector for which to delete the external system configuration. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / update_sip_rule update_sip_rule *************** ChimeSDKVoice.Client.update_sip_rule(**kwargs) Updates the details of the specified SIP rule. See also: AWS API Documentation **Request Syntax** response = client.update_sip_rule( SipRuleId='string', Name='string', Disabled=True|False, TargetApplications=[ { 'SipMediaApplicationId': 'string', 'Priority': 123, 'AwsRegion': 'string' }, ] ) Parameters: * **SipRuleId** (*string*) -- **[REQUIRED]** The SIP rule ID. * **Name** (*string*) -- **[REQUIRED]** The new name for the specified SIP rule. * **Disabled** (*boolean*) -- The new value that indicates whether the rule is disabled. * **TargetApplications** (*list*) -- The new list of target applications. * *(dict) --* A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * **SipMediaApplicationId** *(string) --* The ID of a rule's target SIP media application. * **Priority** *(integer) --* The priority setting of a rule's target SIP media application. * **AwsRegion** *(string) --* The AWS Region of a rule's target SIP media application. Return type: dict Returns: **Response Syntax** { 'SipRule': { 'SipRuleId': 'string', 'Name': 'string', 'Disabled': True|False, 'TriggerType': 'ToPhoneNumber'|'RequestUriHostname', 'TriggerValue': 'string', 'TargetApplications': [ { 'SipMediaApplicationId': 'string', 'Priority': 123, 'AwsRegion': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **SipRule** *(dict) --* The updated SIP rule details. * **SipRuleId** *(string) --* A SIP rule's ID. * **Name** *(string) --* A SIP rule's name. * **Disabled** *(boolean) --* Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it. * **TriggerType** *(string) --* The type of trigger set for a SIP rule, either a phone number or a URI request host name. * **TriggerValue** *(string) --* The value set for a SIP rule's trigger type. Either a phone number or a URI hostname. * **TargetApplications** *(list) --* The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * *(dict) --* A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * **SipMediaApplicationId** *(string) --* The ID of a rule's target SIP media application. * **Priority** *(integer) --* The priority setting of a rule's target SIP media application. * **AwsRegion** *(string) --* The AWS Region of a rule's target SIP media application. * **CreatedTimestamp** *(datetime) --* The time at which the SIP rule was created, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The time at which the SIP rule was updated, in ISO 8601 format. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / put_voice_connector_origination put_voice_connector_origination ******************************* ChimeSDKVoice.Client.put_voice_connector_origination(**kwargs) Updates a Voice Connector's origination settings. See also: AWS API Documentation **Request Syntax** response = client.put_voice_connector_origination( VoiceConnectorId='string', Origination={ 'Routes': [ { 'Host': 'string', 'Port': 123, 'Protocol': 'TCP'|'UDP', 'Priority': 123, 'Weight': 123 }, ], 'Disabled': True|False } ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **Origination** (*dict*) -- **[REQUIRED]** The origination settings being updated. * **Routes** *(list) --* The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or "Disabled". * *(dict) --* Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector. Note: The parameters listed below are not required, but you must use at least one. * **Host** *(string) --* The FQDN or IP address to contact for origination traffic. * **Port** *(integer) --* The designated origination route port. Defaults to 5060. * **Protocol** *(string) --* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default. * **Priority** *(integer) --* The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first. * **Weight** *(integer) --* The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights. * **Disabled** *(boolean) --* When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or "Routes". Return type: dict Returns: **Response Syntax** { 'Origination': { 'Routes': [ { 'Host': 'string', 'Port': 123, 'Protocol': 'TCP'|'UDP', 'Priority': 123, 'Weight': 123 }, ], 'Disabled': True|False } } **Response Structure** * *(dict) --* * **Origination** *(dict) --* The updated origination settings. * **Routes** *(list) --* The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or "Disabled". * *(dict) --* Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector. Note: The parameters listed below are not required, but you must use at least one. * **Host** *(string) --* The FQDN or IP address to contact for origination traffic. * **Port** *(integer) --* The designated origination route port. Defaults to 5060. * **Protocol** *(string) --* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default. * **Priority** *(integer) --* The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first. * **Weight** *(integer) --* The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights. * **Disabled** *(boolean) --* When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or "Routes". **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / put_voice_connector_termination put_voice_connector_termination ******************************* ChimeSDKVoice.Client.put_voice_connector_termination(**kwargs) Updates a Voice Connector's termination settings. See also: AWS API Documentation **Request Syntax** response = client.put_voice_connector_termination( VoiceConnectorId='string', Termination={ 'CpsLimit': 123, 'DefaultPhoneNumber': 'string', 'CallingRegions': [ 'string', ], 'CidrAllowedList': [ 'string', ], 'Disabled': True|False } ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **Termination** (*dict*) -- **[REQUIRED]** The termination settings to be updated. * **CpsLimit** *(integer) --* The limit on calls per second. Max value based on account service quota. Default value of 1. * **DefaultPhoneNumber** *(string) --* The default outbound calling number. * **CallingRegions** *(list) --* The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required. * *(string) --* * **CidrAllowedList** *(list) --* The IP addresses allowed to make calls, in CIDR format. * *(string) --* * **Disabled** *(boolean) --* When termination is disabled, outbound calls cannot be made. Return type: dict Returns: **Response Syntax** { 'Termination': { 'CpsLimit': 123, 'DefaultPhoneNumber': 'string', 'CallingRegions': [ 'string', ], 'CidrAllowedList': [ 'string', ], 'Disabled': True|False } } **Response Structure** * *(dict) --* * **Termination** *(dict) --* The updated termination settings. * **CpsLimit** *(integer) --* The limit on calls per second. Max value based on account service quota. Default value of 1. * **DefaultPhoneNumber** *(string) --* The default outbound calling number. * **CallingRegions** *(list) --* The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required. * *(string) --* * **CidrAllowedList** *(list) --* The IP addresses allowed to make calls, in CIDR format. * *(string) --* * **Disabled** *(boolean) --* When termination is disabled, outbound calls cannot be made. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_connector get_voice_connector ******************* ChimeSDKVoice.Client.get_voice_connector(**kwargs) Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements. See also: AWS API Documentation **Request Syntax** response = client.get_voice_connector( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Return type: dict Returns: **Response Syntax** { 'VoiceConnector': { 'VoiceConnectorId': 'string', 'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2', 'Name': 'string', 'OutboundHostName': 'string', 'RequireEncryption': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'VoiceConnectorArn': 'string', 'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR' } } **Response Structure** * *(dict) --* * **VoiceConnector** *(dict) --* The Voice Connector details. * **VoiceConnectorId** *(string) --* The Voice Connector's ID. * **AwsRegion** *(string) --* The AWS Region in which the Voice Connector is created. Default: us-east-1. * **Name** *(string) --* The Voice Connector's name. * **OutboundHostName** *(string) --* The outbound host name for the Voice Connector. * **RequireEncryption** *(boolean) --* Enables or disables encryption for the Voice Connector. * **CreatedTimestamp** *(datetime) --* The Voice Connector's creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The Voice Connector's updated timestamp, in ISO 8601 format. * **VoiceConnectorArn** *(string) --* The ARN of the Voice Connector. * **IntegrationType** *(string) --* The connectors for use with Amazon Connect. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / update_phone_number update_phone_number ******************* ChimeSDKVoice.Client.update_phone_number(**kwargs) Updates phone number details, such as product type, calling name, or phone number name for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type, calling name, or phone number name in one action. For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type. Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update. See also: AWS API Documentation **Request Syntax** response = client.update_phone_number( PhoneNumberId='string', ProductType='VoiceConnector'|'SipMediaApplicationDialIn', CallingName='string', Name='string' ) Parameters: * **PhoneNumberId** (*string*) -- **[REQUIRED]** The phone number ID. * **ProductType** (*string*) -- The product type. * **CallingName** (*string*) -- The outbound calling name associated with the phone number. * **Name** (*string*) -- Specifies the updated name assigned to one or more phone numbers. Return type: dict Returns: **Response Syntax** { 'PhoneNumber': { 'PhoneNumberId': 'string', 'E164PhoneNumber': 'string', 'Country': 'string', 'Type': 'Local'|'TollFree', 'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed', 'Capabilities': { 'InboundCall': True|False, 'OutboundCall': True|False, 'InboundSMS': True|False, 'OutboundSMS': True|False, 'InboundMMS': True|False, 'OutboundMMS': True|False }, 'Associations': [ { 'Value': 'string', 'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId', 'AssociatedTimestamp': datetime(2015, 1, 1) }, ], 'CallingName': 'string', 'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'DeletionTimestamp': datetime(2015, 1, 1), 'OrderId': 'string', 'Name': 'string' } } **Response Structure** * *(dict) --* * **PhoneNumber** *(dict) --* The updated phone number details. * **PhoneNumberId** *(string) --* The phone number's ID. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Country** *(string) --* The phone number's country. Format: ISO 3166-1 alpha-2. * **Type** *(string) --* The phone number's type. * **ProductType** *(string) --* The phone number's product type. * **Status** *(string) --* The phone number's status. * **Capabilities** *(dict) --* The phone number's capabilities. * **InboundCall** *(boolean) --* Allows or denies inbound calling for the specified phone number. * **OutboundCall** *(boolean) --* Allows or denies outbound calling for the specified phone number. * **InboundSMS** *(boolean) --* Allows or denies inbound SMS messaging for the specified phone number. * **OutboundSMS** *(boolean) --* Allows or denies outbound SMS messaging for the specified phone number. * **InboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **OutboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **Associations** *(list) --* The phone number's associations. * *(dict) --* The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID. * **Value** *(string) --* Contains the ID for the entity specified in Name. * **Name** *(string) --* Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID. * **AssociatedTimestamp** *(datetime) --* The timestamp of the phone number association, in ISO 8601 format. * **CallingName** *(string) --* The outbound calling name associated with the phone number. * **CallingNameStatus** *(string) --* The outbound calling name status. * **CreatedTimestamp** *(datetime) --* The phone number creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number timestamp, in ISO 8601 format. * **DeletionTimestamp** *(datetime) --* The deleted phone number timestamp, in ISO 8601 format. * **OrderId** *(string) --* The phone number's order ID. * **Name** *(string) --* The name of the phone number. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / stop_voice_tone_analysis_task stop_voice_tone_analysis_task ***************************** ChimeSDKVoice.Client.stop_voice_tone_analysis_task(**kwargs) Stops a voice tone analysis task. See also: AWS API Documentation **Request Syntax** response = client.stop_voice_tone_analysis_task( VoiceConnectorId='string', VoiceToneAnalysisTaskId='string' ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **VoiceToneAnalysisTaskId** (*string*) -- **[REQUIRED]** The ID of the voice tone analysis task. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.UnprocessableEntityException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / start_voice_tone_analysis_task start_voice_tone_analysis_task ****************************** ChimeSDKVoice.Client.start_voice_tone_analysis_task(**kwargs) 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*. Warning: 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. See also: AWS API Documentation **Request Syntax** response = client.start_voice_tone_analysis_task( VoiceConnectorId='string', TransactionId='string', LanguageCode='en-US', ClientRequestToken='string' ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **TransactionId** (*string*) -- **[REQUIRED]** The transaction ID. * **LanguageCode** (*string*) -- **[REQUIRED]** The language code. * **ClientRequestToken** (*string*) -- The unique identifier for the client request. Use a different token for different voice tone analysis tasks. Return type: dict Returns: **Response Syntax** { 'VoiceToneAnalysisTask': { 'VoiceToneAnalysisTaskId': 'string', 'VoiceToneAnalysisTaskStatus': 'string', 'CallDetails': { 'VoiceConnectorId': 'string', 'TransactionId': 'string', 'IsCaller': True|False }, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'StartedTimestamp': datetime(2015, 1, 1), 'StatusMessage': 'string' } } **Response Structure** * *(dict) --* * **VoiceToneAnalysisTask** *(dict) --* The details of the voice tone analysis task. * **VoiceToneAnalysisTaskId** *(string) --* The ID of the voice tone analysis task. * **VoiceToneAnalysisTaskStatus** *(string) --* The status of a voice tone analysis task, "IN_QUEUE", "IN_PROGRESS", "PARTIAL_SUCCESS", "SUCCEEDED", "FAILED", or "STOPPED". * **CallDetails** *(dict) --* The call details of a voice tone analysis task. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **TransactionId** *(string) --* The transaction ID of a Voice Connector call. * **IsCaller** *(boolean) --* Identifies a person as the caller or the callee. * **CreatedTimestamp** *(datetime) --* The time at which a voice tone analysis task was created. * **UpdatedTimestamp** *(datetime) --* The time at which a voice tone analysis task was updated. * **StartedTimestamp** *(datetime) --* The time at which a voice tone analysis task started. * **StatusMessage** *(string) --* The status of a voice tone analysis task. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.GoneException" * "ChimeSDKVoice.Client.exceptions.UnprocessableEntityException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / put_voice_connector_external_systems_configuration put_voice_connector_external_systems_configuration ************************************************** ChimeSDKVoice.Client.put_voice_connector_external_systems_configuration(**kwargs) Adds an external systems configuration to a Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.put_voice_connector_external_systems_configuration( VoiceConnectorId='string', SessionBorderControllerTypes=[ 'RIBBON_SBC'|'ORACLE_ACME_PACKET_SBC'|'AVAYA_SBCE'|'CISCO_UNIFIED_BORDER_ELEMENT'|'AUDIOCODES_MEDIANT_SBC', ], ContactCenterSystemTypes=[ 'GENESYS_ENGAGE_ON_PREMISES'|'AVAYA_AURA_CALL_CENTER_ELITE'|'AVAYA_AURA_CONTACT_CENTER'|'CISCO_UNIFIED_CONTACT_CENTER_ENTERPRISE', ] ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The ID of the Voice Connector for which to add the external system configuration. * **SessionBorderControllerTypes** (*list*) -- The session border controllers to use. * *(string) --* * **ContactCenterSystemTypes** (*list*) -- The contact center system to use. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ExternalSystemsConfiguration': { 'SessionBorderControllerTypes': [ 'RIBBON_SBC'|'ORACLE_ACME_PACKET_SBC'|'AVAYA_SBCE'|'CISCO_UNIFIED_BORDER_ELEMENT'|'AUDIOCODES_MEDIANT_SBC', ], 'ContactCenterSystemTypes': [ 'GENESYS_ENGAGE_ON_PREMISES'|'AVAYA_AURA_CALL_CENTER_ELITE'|'AVAYA_AURA_CONTACT_CENTER'|'CISCO_UNIFIED_CONTACT_CENTER_ENTERPRISE', ] } } **Response Structure** * *(dict) --* * **ExternalSystemsConfiguration** *(dict) --* An object that contains information about an external systems configuration for a Voice Connector. * **SessionBorderControllerTypes** *(list) --* The session border controllers. * *(string) --* * **ContactCenterSystemTypes** *(list) --* The contact center system. * *(string) --* **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_voice_connector_groups list_voice_connector_groups *************************** ChimeSDKVoice.Client.list_voice_connector_groups(**kwargs) Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account. See also: AWS API Documentation **Request Syntax** response = client.list_voice_connector_groups( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- The token used to return the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Return type: dict Returns: **Response Syntax** { 'VoiceConnectorGroups': [ { 'VoiceConnectorGroupId': 'string', 'Name': 'string', 'VoiceConnectorItems': [ { 'VoiceConnectorId': 'string', 'Priority': 123 }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'VoiceConnectorGroupArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **VoiceConnectorGroups** *(list) --* The details of the Voice Connector groups. * *(dict) --* The Amazon Chime SDK Voice Connector group configuration, including associated Voice Connectors. You can include Voice Connectors from different AWS Regions in a group. This creates a fault tolerant mechanism for fallback in case of availability events. * **VoiceConnectorGroupId** *(string) --* The ID of a Voice Connector group. * **Name** *(string) --* The name of a Voice Connector group. * **VoiceConnectorItems** *(list) --* The Voice Connectors to which you route inbound calls. * *(dict) --* For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **Priority** *(integer) --* The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight. * **CreatedTimestamp** *(datetime) --* The Voice Connector group's creation time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The Voice Connector group's creation time stamp, in ISO 8601 format. * **VoiceConnectorGroupArn** *(string) --* The ARN of the Voice Connector group. * **NextToken** *(string) --* The token used to return the next page of results. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / put_voice_connector_logging_configuration put_voice_connector_logging_configuration ***************************************** ChimeSDKVoice.Client.put_voice_connector_logging_configuration(**kwargs) Updates a Voice Connector's logging configuration. See also: AWS API Documentation **Request Syntax** response = client.put_voice_connector_logging_configuration( VoiceConnectorId='string', LoggingConfiguration={ 'EnableSIPLogs': True|False, 'EnableMediaMetricLogs': True|False } ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **LoggingConfiguration** (*dict*) -- **[REQUIRED]** The logging configuration being updated. * **EnableSIPLogs** *(boolean) --* Boolean that enables sending SIP message logs to Amazon CloudWatch. * **EnableMediaMetricLogs** *(boolean) --* Enables or disables media metrics logging. Return type: dict Returns: **Response Syntax** { 'LoggingConfiguration': { 'EnableSIPLogs': True|False, 'EnableMediaMetricLogs': True|False } } **Response Structure** * *(dict) --* * **LoggingConfiguration** *(dict) --* The updated logging configuration. * **EnableSIPLogs** *(boolean) --* Boolean that enables sending SIP message logs to Amazon CloudWatch. * **EnableMediaMetricLogs** *(boolean) --* Enables or disables media metrics logging. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_connector_termination_credentials delete_voice_connector_termination_credentials ********************************************** ChimeSDKVoice.Client.delete_voice_connector_termination_credentials(**kwargs) Deletes the specified SIP credentials used by your equipment to authenticate during call termination. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_connector_termination_credentials( VoiceConnectorId='string', Usernames=[ 'string', ] ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **Usernames** (*list*) -- **[REQUIRED]** The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format. * *(string) --* Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / create_sip_rule create_sip_rule *************** ChimeSDKVoice.Client.create_sip_rule(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.create_sip_rule( Name='string', TriggerType='ToPhoneNumber'|'RequestUriHostname', TriggerValue='string', Disabled=True|False, TargetApplications=[ { 'SipMediaApplicationId': 'string', 'Priority': 123, 'AwsRegion': 'string' }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the SIP rule. * **TriggerType** (*string*) -- **[REQUIRED]** The type of trigger assigned to the SIP rule in "TriggerValue", currently "RequestUriHostname" or "ToPhoneNumber". * **TriggerValue** (*string*) -- **[REQUIRED]** If "TriggerType" is "RequestUriHostname", the value can be the outbound host name of a Voice Connector. If "TriggerType" is "ToPhoneNumber", the value can be a customer-owned phone number in the E164 format. The "SipMediaApplication" specified in the "SipRule" is triggered if the request URI in an incoming SIP request matches the "RequestUriHostname", or if the "To" header in the incoming SIP request matches the "ToPhoneNumber" value. * **Disabled** (*boolean*) -- Disables or enables a SIP rule. You must disable SIP rules before you can delete them. * **TargetApplications** (*list*) -- List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used. * *(dict) --* A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * **SipMediaApplicationId** *(string) --* The ID of a rule's target SIP media application. * **Priority** *(integer) --* The priority setting of a rule's target SIP media application. * **AwsRegion** *(string) --* The AWS Region of a rule's target SIP media application. Return type: dict Returns: **Response Syntax** { 'SipRule': { 'SipRuleId': 'string', 'Name': 'string', 'Disabled': True|False, 'TriggerType': 'ToPhoneNumber'|'RequestUriHostname', 'TriggerValue': 'string', 'TargetApplications': [ { 'SipMediaApplicationId': 'string', 'Priority': 123, 'AwsRegion': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **SipRule** *(dict) --* The SIP rule information, including the rule ID, triggers, and target applications. * **SipRuleId** *(string) --* A SIP rule's ID. * **Name** *(string) --* A SIP rule's name. * **Disabled** *(boolean) --* Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it. * **TriggerType** *(string) --* The type of trigger set for a SIP rule, either a phone number or a URI request host name. * **TriggerValue** *(string) --* The value set for a SIP rule's trigger type. Either a phone number or a URI hostname. * **TargetApplications** *(list) --* The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * *(dict) --* A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * **SipMediaApplicationId** *(string) --* The ID of a rule's target SIP media application. * **Priority** *(integer) --* The priority setting of a rule's target SIP media application. * **AwsRegion** *(string) --* The AWS Region of a rule's target SIP media application. * **CreatedTimestamp** *(datetime) --* The time at which the SIP rule was created, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The time at which the SIP rule was updated, in ISO 8601 format. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / close close ***** ChimeSDKVoice.Client.close() Closes underlying endpoint connections. ChimeSDKVoice / Client / update_voice_connector update_voice_connector ********************** ChimeSDKVoice.Client.update_voice_connector(**kwargs) Updates the details for the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.update_voice_connector( VoiceConnectorId='string', Name='string', RequireEncryption=True|False ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **Name** (*string*) -- **[REQUIRED]** The name of the Voice Connector. * **RequireEncryption** (*boolean*) -- **[REQUIRED]** When enabled, requires encryption for the Voice Connector. Return type: dict Returns: **Response Syntax** { 'VoiceConnector': { 'VoiceConnectorId': 'string', 'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2', 'Name': 'string', 'OutboundHostName': 'string', 'RequireEncryption': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'VoiceConnectorArn': 'string', 'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR' } } **Response Structure** * *(dict) --* * **VoiceConnector** *(dict) --* The updated Voice Connector details. * **VoiceConnectorId** *(string) --* The Voice Connector's ID. * **AwsRegion** *(string) --* The AWS Region in which the Voice Connector is created. Default: us-east-1. * **Name** *(string) --* The Voice Connector's name. * **OutboundHostName** *(string) --* The outbound host name for the Voice Connector. * **RequireEncryption** *(boolean) --* Enables or disables encryption for the Voice Connector. * **CreatedTimestamp** *(datetime) --* The Voice Connector's creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The Voice Connector's updated timestamp, in ISO 8601 format. * **VoiceConnectorArn** *(string) --* The ARN of the Voice Connector. * **IntegrationType** *(string) --* The connectors for use with Amazon Connect. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / create_sip_media_application create_sip_media_application **************************** ChimeSDKVoice.Client.create_sip_media_application(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.create_sip_media_application( AwsRegion='string', Name='string', Endpoints=[ { 'LambdaArn': 'string' }, ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **AwsRegion** (*string*) -- **[REQUIRED]** The AWS Region assigned to the SIP media application. * **Name** (*string*) -- **[REQUIRED]** The SIP media application's name. * **Endpoints** (*list*) -- **[REQUIRED]** List of endpoints (Lambda ARNs) specified for the SIP media application. * *(dict) --* The endpoint assigned to a SIP media application. * **LambdaArn** *(string) --* Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application. * **Tags** (*list*) -- The tags assigned to the SIP media application. * *(dict) --* Describes a tag applied to a resource. * **Key** *(string) --* **[REQUIRED]** The tag's key. * **Value** *(string) --* **[REQUIRED]** The tag's value. Return type: dict Returns: **Response Syntax** { 'SipMediaApplication': { 'SipMediaApplicationId': 'string', 'AwsRegion': 'string', 'Name': 'string', 'Endpoints': [ { 'LambdaArn': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'SipMediaApplicationArn': 'string' } } **Response Structure** * *(dict) --* * **SipMediaApplication** *(dict) --* The SIP media application details. * **SipMediaApplicationId** *(string) --* A SIP media application's ID. * **AwsRegion** *(string) --* The AWS Region in which the SIP media application is created. * **Name** *(string) --* The SIP media application's name. * **Endpoints** *(list) --* List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted. * *(dict) --* The endpoint assigned to a SIP media application. * **LambdaArn** *(string) --* Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application. * **CreatedTimestamp** *(datetime) --* The SIP media application creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The time at which the SIP media application was updated. * **SipMediaApplicationArn** *(string) --* The ARN of the SIP media application. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / restore_phone_number restore_phone_number ******************** ChimeSDKVoice.Client.restore_phone_number(**kwargs) Restores a deleted phone number. See also: AWS API Documentation **Request Syntax** response = client.restore_phone_number( PhoneNumberId='string' ) Parameters: **PhoneNumberId** (*string*) -- **[REQUIRED]** The ID of the phone number being restored. Return type: dict Returns: **Response Syntax** { 'PhoneNumber': { 'PhoneNumberId': 'string', 'E164PhoneNumber': 'string', 'Country': 'string', 'Type': 'Local'|'TollFree', 'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed', 'Capabilities': { 'InboundCall': True|False, 'OutboundCall': True|False, 'InboundSMS': True|False, 'OutboundSMS': True|False, 'InboundMMS': True|False, 'OutboundMMS': True|False }, 'Associations': [ { 'Value': 'string', 'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId', 'AssociatedTimestamp': datetime(2015, 1, 1) }, ], 'CallingName': 'string', 'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'DeletionTimestamp': datetime(2015, 1, 1), 'OrderId': 'string', 'Name': 'string' } } **Response Structure** * *(dict) --* * **PhoneNumber** *(dict) --* The restored phone number. * **PhoneNumberId** *(string) --* The phone number's ID. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Country** *(string) --* The phone number's country. Format: ISO 3166-1 alpha-2. * **Type** *(string) --* The phone number's type. * **ProductType** *(string) --* The phone number's product type. * **Status** *(string) --* The phone number's status. * **Capabilities** *(dict) --* The phone number's capabilities. * **InboundCall** *(boolean) --* Allows or denies inbound calling for the specified phone number. * **OutboundCall** *(boolean) --* Allows or denies outbound calling for the specified phone number. * **InboundSMS** *(boolean) --* Allows or denies inbound SMS messaging for the specified phone number. * **OutboundSMS** *(boolean) --* Allows or denies outbound SMS messaging for the specified phone number. * **InboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **OutboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **Associations** *(list) --* The phone number's associations. * *(dict) --* The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID. * **Value** *(string) --* Contains the ID for the entity specified in Name. * **Name** *(string) --* Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID. * **AssociatedTimestamp** *(datetime) --* The timestamp of the phone number association, in ISO 8601 format. * **CallingName** *(string) --* The outbound calling name associated with the phone number. * **CallingNameStatus** *(string) --* The outbound calling name status. * **CreatedTimestamp** *(datetime) --* The phone number creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number timestamp, in ISO 8601 format. * **DeletionTimestamp** *(datetime) --* The deleted phone number timestamp, in ISO 8601 format. * **OrderId** *(string) --* The phone number's order ID. * **Name** *(string) --* The name of the phone number. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / create_proxy_session create_proxy_session ******************** ChimeSDKVoice.Client.create_proxy_session(**kwargs) Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers. See also: AWS API Documentation **Request Syntax** response = client.create_proxy_session( VoiceConnectorId='string', ParticipantPhoneNumbers=[ 'string', ], Name='string', ExpiryMinutes=123, Capabilities=[ 'Voice'|'SMS', ], NumberSelectionBehavior='PreferSticky'|'AvoidSticky', GeoMatchLevel='Country'|'AreaCode', GeoMatchParams={ 'Country': 'string', 'AreaCode': 'string' } ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **ParticipantPhoneNumbers** (*list*) -- **[REQUIRED]** The participant phone numbers. * *(string) --* * **Name** (*string*) -- The name of the proxy session. * **ExpiryMinutes** (*integer*) -- The number of minutes allowed for the proxy session. * **Capabilities** (*list*) -- **[REQUIRED]** The proxy session's capabilities. * *(string) --* * **NumberSelectionBehavior** (*string*) -- The preference for proxy phone number reuse, or stickiness, between the same participants across sessions. * **GeoMatchLevel** (*string*) -- The preference for matching the country or area code of the proxy phone number with that of the first participant. * **GeoMatchParams** (*dict*) -- The country and area code for the proxy phone number. * **Country** *(string) --* **[REQUIRED]** The country. * **AreaCode** *(string) --* **[REQUIRED]** The area code. Return type: dict Returns: **Response Syntax** { 'ProxySession': { 'VoiceConnectorId': 'string', 'ProxySessionId': 'string', 'Name': 'string', 'Status': 'Open'|'InProgress'|'Closed', 'ExpiryMinutes': 123, 'Capabilities': [ 'Voice'|'SMS', ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'EndedTimestamp': datetime(2015, 1, 1), 'Participants': [ { 'PhoneNumber': 'string', 'ProxyPhoneNumber': 'string' }, ], 'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky', 'GeoMatchLevel': 'Country'|'AreaCode', 'GeoMatchParams': { 'Country': 'string', 'AreaCode': 'string' } } } **Response Structure** * *(dict) --* * **ProxySession** *(dict) --* The proxy session details. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **ProxySessionId** *(string) --* The proxy session ID. * **Name** *(string) --* The proxy session name. * **Status** *(string) --* The proxy session status. * **ExpiryMinutes** *(integer) --* The number of minutes allowed for the proxy session. * **Capabilities** *(list) --* The proxy session capabilities. * *(string) --* * **CreatedTimestamp** *(datetime) --* The created time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated time stamp, in ISO 8601 format. * **EndedTimestamp** *(datetime) --* The ended time stamp, in ISO 8601 format. * **Participants** *(list) --* The proxy session participants. * *(dict) --* The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session. * **PhoneNumber** *(string) --* The participant's phone number. * **ProxyPhoneNumber** *(string) --* The participant's proxy phone number. * **NumberSelectionBehavior** *(string) --* The preference for proxy phone number reuse, or stickiness, between the same participants across sessions. * **GeoMatchLevel** *(string) --* The preference for matching the country or area code of the proxy phone number with that of the first participant. * **GeoMatchParams** *(dict) --* The country and area code for the proxy phone number. * **Country** *(string) --* The country. * **AreaCode** *(string) --* The area code. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_connector_external_systems_configuration get_voice_connector_external_systems_configuration ************************************************** ChimeSDKVoice.Client.get_voice_connector_external_systems_configuration(**kwargs) Gets information about an external systems configuration for a Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.get_voice_connector_external_systems_configuration( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The ID of the Voice Connector for which to return information about the external system configuration. Return type: dict Returns: **Response Syntax** { 'ExternalSystemsConfiguration': { 'SessionBorderControllerTypes': [ 'RIBBON_SBC'|'ORACLE_ACME_PACKET_SBC'|'AVAYA_SBCE'|'CISCO_UNIFIED_BORDER_ELEMENT'|'AUDIOCODES_MEDIANT_SBC', ], 'ContactCenterSystemTypes': [ 'GENESYS_ENGAGE_ON_PREMISES'|'AVAYA_AURA_CALL_CENTER_ELITE'|'AVAYA_AURA_CONTACT_CENTER'|'CISCO_UNIFIED_CONTACT_CENTER_ENTERPRISE', ] } } **Response Structure** * *(dict) --* * **ExternalSystemsConfiguration** *(dict) --* An object that contains information about an external systems configuration for a Voice Connector. * **SessionBorderControllerTypes** *(list) --* The session border controllers. * *(string) --* * **ContactCenterSystemTypes** *(list) --* The contact center system. * *(string) --* **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_speaker_search_task get_speaker_search_task *********************** ChimeSDKVoice.Client.get_speaker_search_task(**kwargs) Retrieves the details of the specified speaker search task. See also: AWS API Documentation **Request Syntax** response = client.get_speaker_search_task( VoiceConnectorId='string', SpeakerSearchTaskId='string' ) Parameters: * **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. * **SpeakerSearchTaskId** (*string*) -- **[REQUIRED]** The ID of the speaker search task. Return type: dict Returns: **Response Syntax** { 'SpeakerSearchTask': { 'SpeakerSearchTaskId': 'string', 'SpeakerSearchTaskStatus': 'string', 'CallDetails': { 'VoiceConnectorId': 'string', 'TransactionId': 'string', 'IsCaller': True|False }, 'SpeakerSearchDetails': { 'Results': [ { 'ConfidenceScore': ..., 'VoiceProfileId': 'string' }, ], 'VoiceprintGenerationStatus': 'string' }, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'StartedTimestamp': datetime(2015, 1, 1), 'StatusMessage': 'string' } } **Response Structure** * *(dict) --* * **SpeakerSearchTask** *(dict) --* The details of the speaker search task. * **SpeakerSearchTaskId** *(string) --* The speaker search task ID. * **SpeakerSearchTaskStatus** *(string) --* The status of the speaker search task, "IN_QUEUE", "IN_PROGRESS", "PARTIAL_SUCCESS", "SUCCEEDED", "FAILED", or "STOPPED". * **CallDetails** *(dict) --* The call details of a speaker search task. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **TransactionId** *(string) --* The transaction ID of a Voice Connector call. * **IsCaller** *(boolean) --* Identifies a person as the caller or the callee. * **SpeakerSearchDetails** *(dict) --* The details of a speaker search task. * **Results** *(list) --* The result value in the speaker search details. * *(dict) --* The result of a speaker search analysis. * **ConfidenceScore** *(float) --* The confidence score in the speaker search analysis. * **VoiceProfileId** *(string) --* The voice profile ID. * **VoiceprintGenerationStatus** *(string) --* The status of a voice print generation operation, "VoiceprintGenerationSuccess" or "VoiceprintGenerationFailure".. * **CreatedTimestamp** *(datetime) --* The time at which a speaker search task was created. * **UpdatedTimestamp** *(datetime) --* The time at which a speaker search task was updated. * **StartedTimestamp** *(datetime) --* The time at which the speaker search task began. * **StatusMessage** *(string) --* A detailed message about the status of a speaker search. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" ChimeSDKVoice / Client / delete_sip_media_application delete_sip_media_application **************************** ChimeSDKVoice.Client.delete_sip_media_application(**kwargs) Deletes a SIP media application. See also: AWS API Documentation **Request Syntax** response = client.delete_sip_media_application( SipMediaApplicationId='string' ) Parameters: **SipMediaApplicationId** (*string*) -- **[REQUIRED]** The SIP media application ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_phone_number_settings get_phone_number_settings ************************* ChimeSDKVoice.Client.get_phone_number_settings() Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name. See also: AWS API Documentation **Request Syntax** response = client.get_phone_number_settings() Return type: dict Returns: **Response Syntax** { 'CallingName': 'string', 'CallingNameUpdatedTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **CallingName** *(string) --* The default outbound calling name for the account. * **CallingNameUpdatedTimestamp** *(datetime) --* The updated outbound calling name timestamp, in ISO 8601 format. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_connector_group get_voice_connector_group ************************* ChimeSDKVoice.Client.get_voice_connector_group(**kwargs) Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated "VoiceConnectorItems". See also: AWS API Documentation **Request Syntax** response = client.get_voice_connector_group( VoiceConnectorGroupId='string' ) Parameters: **VoiceConnectorGroupId** (*string*) -- **[REQUIRED]** The Voice Connector group ID. Return type: dict Returns: **Response Syntax** { 'VoiceConnectorGroup': { 'VoiceConnectorGroupId': 'string', 'Name': 'string', 'VoiceConnectorItems': [ { 'VoiceConnectorId': 'string', 'Priority': 123 }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'VoiceConnectorGroupArn': 'string' } } **Response Structure** * *(dict) --* * **VoiceConnectorGroup** *(dict) --* The details of the Voice Connector group. * **VoiceConnectorGroupId** *(string) --* The ID of a Voice Connector group. * **Name** *(string) --* The name of a Voice Connector group. * **VoiceConnectorItems** *(list) --* The Voice Connectors to which you route inbound calls. * *(dict) --* For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group. * **VoiceConnectorId** *(string) --* The Voice Connector ID. * **Priority** *(integer) --* The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight. * **CreatedTimestamp** *(datetime) --* The Voice Connector group's creation time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The Voice Connector group's creation time stamp, in ISO 8601 format. * **VoiceConnectorGroupArn** *(string) --* The ARN of the Voice Connector group. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / disassociate_phone_numbers_from_voice_connector_group disassociate_phone_numbers_from_voice_connector_group ***************************************************** ChimeSDKVoice.Client.disassociate_phone_numbers_from_voice_connector_group(**kwargs) Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group. See also: AWS API Documentation **Request Syntax** response = client.disassociate_phone_numbers_from_voice_connector_group( VoiceConnectorGroupId='string', E164PhoneNumbers=[ 'string', ] ) Parameters: * **VoiceConnectorGroupId** (*string*) -- **[REQUIRED]** The Voice Connector group ID. * **E164PhoneNumbers** (*list*) -- **[REQUIRED]** The list of phone numbers, in E.164 format. * *(string) --* Return type: dict Returns: **Response Syntax** { 'PhoneNumberErrors': [ { 'PhoneNumberId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **PhoneNumberErrors** *(list) --* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. * *(dict) --* If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages. * **PhoneNumberId** *(string) --* The phone number ID for which the action failed. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The error message. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_voice_profiles list_voice_profiles ******************* ChimeSDKVoice.Client.list_voice_profiles(**kwargs) Lists the voice profiles in a voice profile domain. See also: AWS API Documentation **Request Syntax** response = client.list_voice_profiles( VoiceProfileDomainId='string', NextToken='string', MaxResults=123 ) Parameters: * **VoiceProfileDomainId** (*string*) -- **[REQUIRED]** The ID of the voice profile domain. * **NextToken** (*string*) -- The token used to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of results in the request. Return type: dict Returns: **Response Syntax** { 'VoiceProfiles': [ { 'VoiceProfileId': 'string', 'VoiceProfileArn': 'string', 'VoiceProfileDomainId': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'ExpirationTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **VoiceProfiles** *(list) --* The list of voice profiles. * *(dict) --* A high-level summary of a voice profile. * **VoiceProfileId** *(string) --* The ID of the voice profile in a voice profile summary. * **VoiceProfileArn** *(string) --* The ARN of the voice profile in a voice profile summary. * **VoiceProfileDomainId** *(string) --* The ID of the voice profile domain in a voice profile summary. * **CreatedTimestamp** *(datetime) --* The time at which a voice profile summary was created. * **UpdatedTimestamp** *(datetime) --* The time at which a voice profile summary was last updated. * **ExpirationTimestamp** *(datetime) --* Extends the life of the voice profile. You can use "UpdateVoiceProfile" to refresh an existing voice profile's voice print and extend the life of the summary. * **NextToken** *(string) --* The token used to retrieve the next page of results. **Exceptions** * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_voice_profile_domain get_voice_profile_domain ************************ ChimeSDKVoice.Client.get_voice_profile_domain(**kwargs) Retrieves the details of the specified voice profile domain. See also: AWS API Documentation **Request Syntax** response = client.get_voice_profile_domain( VoiceProfileDomainId='string' ) Parameters: **VoiceProfileDomainId** (*string*) -- **[REQUIRED]** The voice profile domain ID. Return type: dict Returns: **Response Syntax** { 'VoiceProfileDomain': { 'VoiceProfileDomainId': 'string', 'VoiceProfileDomainArn': 'string', 'Name': 'string', 'Description': 'string', 'ServerSideEncryptionConfiguration': { 'KmsKeyArn': 'string' }, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **VoiceProfileDomain** *(dict) --* The details of the voice profile domain. * **VoiceProfileDomainId** *(string) --* The ID of the voice profile domain. * **VoiceProfileDomainArn** *(string) --* The voice profile domain's Amazon Resource Number (ARN). * **Name** *(string) --* The name of the voice profile domain. * **Description** *(string) --* The description of the voice profile domain. * **ServerSideEncryptionConfiguration** *(dict) --* A structure that contains the configuration settings for server-side encryption. * **KmsKeyArn** *(string) --* The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported. * **CreatedTimestamp** *(datetime) --* The time at which the voice profile domain was created. * **UpdatedTimestamp** *(datetime) --* The time at which the voice profile was last updated. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_connector delete_voice_connector ********************** ChimeSDKVoice.Client.delete_voice_connector(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_connector( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / create_voice_profile create_voice_profile ******************** ChimeSDKVoice.Client.create_voice_profile(**kwargs) Creates a voice profile, which consists of an enrolled user and their latest voice print. Warning: 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*. See also: AWS API Documentation **Request Syntax** response = client.create_voice_profile( SpeakerSearchTaskId='string' ) Parameters: **SpeakerSearchTaskId** (*string*) -- **[REQUIRED]** The ID of the speaker search task. Return type: dict Returns: **Response Syntax** { 'VoiceProfile': { 'VoiceProfileId': 'string', 'VoiceProfileArn': 'string', 'VoiceProfileDomainId': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'ExpirationTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **VoiceProfile** *(dict) --* The requested voice profile. * **VoiceProfileId** *(string) --* The ID of the voice profile. * **VoiceProfileArn** *(string) --* The ARN of the voice profile. * **VoiceProfileDomainId** *(string) --* The ID of the domain that contains the voice profile. * **CreatedTimestamp** *(datetime) --* The time at which the voice profile was created and enrolled. * **UpdatedTimestamp** *(datetime) --* The time at which the voice profile was last updated. * **ExpirationTimestamp** *(datetime) --* The time at which a voice profile expires unless you re- enroll the caller via the "UpdateVoiceProfile" API. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.GoneException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / tag_resource tag_resource ************ ChimeSDKVoice.Client.tag_resource(**kwargs) Adds a tag to the specified resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceARN='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource being tagged. * **Tags** (*list*) -- **[REQUIRED]** A list of the tags being added to the resource. * *(dict) --* Describes a tag applied to a resource. * **Key** *(string) --* **[REQUIRED]** The tag's key. * **Value** *(string) --* **[REQUIRED]** The tag's value. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_sip_media_applications list_sip_media_applications *************************** ChimeSDKVoice.Client.list_sip_media_applications(**kwargs) Lists the SIP media applications under the administrator's AWS account. See also: AWS API Documentation **Request Syntax** response = client.list_sip_media_applications( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Defaults to 100. * **NextToken** (*string*) -- The token used to return the next page of results. Return type: dict Returns: **Response Syntax** { 'SipMediaApplications': [ { 'SipMediaApplicationId': 'string', 'AwsRegion': 'string', 'Name': 'string', 'Endpoints': [ { 'LambdaArn': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'SipMediaApplicationArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **SipMediaApplications** *(list) --* The list of SIP media applications and application details. * *(dict) --* The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications. * **SipMediaApplicationId** *(string) --* A SIP media application's ID. * **AwsRegion** *(string) --* The AWS Region in which the SIP media application is created. * **Name** *(string) --* The SIP media application's name. * **Endpoints** *(list) --* List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted. * *(dict) --* The endpoint assigned to a SIP media application. * **LambdaArn** *(string) --* Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application. * **CreatedTimestamp** *(datetime) --* The SIP media application creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The time at which the SIP media application was updated. * **SipMediaApplicationArn** *(string) --* The ARN of the SIP media application. * **NextToken** *(string) --* The token used to return the next page of results. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / get_phone_number get_phone_number **************** ChimeSDKVoice.Client.get_phone_number(**kwargs) Retrieves details for the specified phone number ID, such as associations, capabilities, and product type. See also: AWS API Documentation **Request Syntax** response = client.get_phone_number( PhoneNumberId='string' ) Parameters: **PhoneNumberId** (*string*) -- **[REQUIRED]** The phone number ID. Return type: dict Returns: **Response Syntax** { 'PhoneNumber': { 'PhoneNumberId': 'string', 'E164PhoneNumber': 'string', 'Country': 'string', 'Type': 'Local'|'TollFree', 'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed', 'Capabilities': { 'InboundCall': True|False, 'OutboundCall': True|False, 'InboundSMS': True|False, 'OutboundSMS': True|False, 'InboundMMS': True|False, 'OutboundMMS': True|False }, 'Associations': [ { 'Value': 'string', 'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId', 'AssociatedTimestamp': datetime(2015, 1, 1) }, ], 'CallingName': 'string', 'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'DeletionTimestamp': datetime(2015, 1, 1), 'OrderId': 'string', 'Name': 'string' } } **Response Structure** * *(dict) --* * **PhoneNumber** *(dict) --* The phone number details. * **PhoneNumberId** *(string) --* The phone number's ID. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Country** *(string) --* The phone number's country. Format: ISO 3166-1 alpha-2. * **Type** *(string) --* The phone number's type. * **ProductType** *(string) --* The phone number's product type. * **Status** *(string) --* The phone number's status. * **Capabilities** *(dict) --* The phone number's capabilities. * **InboundCall** *(boolean) --* Allows or denies inbound calling for the specified phone number. * **OutboundCall** *(boolean) --* Allows or denies outbound calling for the specified phone number. * **InboundSMS** *(boolean) --* Allows or denies inbound SMS messaging for the specified phone number. * **OutboundSMS** *(boolean) --* Allows or denies outbound SMS messaging for the specified phone number. * **InboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **OutboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **Associations** *(list) --* The phone number's associations. * *(dict) --* The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID. * **Value** *(string) --* Contains the ID for the entity specified in Name. * **Name** *(string) --* Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID. * **AssociatedTimestamp** *(datetime) --* The timestamp of the phone number association, in ISO 8601 format. * **CallingName** *(string) --* The outbound calling name associated with the phone number. * **CallingNameStatus** *(string) --* The outbound calling name status. * **CreatedTimestamp** *(datetime) --* The phone number creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number timestamp, in ISO 8601 format. * **DeletionTimestamp** *(datetime) --* The deleted phone number timestamp, in ISO 8601 format. * **OrderId** *(string) --* The phone number's order ID. * **Name** *(string) --* The name of the phone number. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_connector_proxy delete_voice_connector_proxy **************************** ChimeSDKVoice.Client.delete_voice_connector_proxy(**kwargs) Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_connector_proxy( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_available_voice_connector_regions list_available_voice_connector_regions ************************************** ChimeSDKVoice.Client.list_available_voice_connector_regions() Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector. See also: AWS API Documentation **Request Syntax** response = client.list_available_voice_connector_regions() Return type: dict Returns: **Response Syntax** { 'VoiceConnectorRegions': [ 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2', ] } **Response Structure** * *(dict) --* * **VoiceConnectorRegions** *(list) --* The list of AWS Regions. * *(string) --* **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / update_sip_media_application update_sip_media_application **************************** ChimeSDKVoice.Client.update_sip_media_application(**kwargs) Updates the details of the specified SIP media application. See also: AWS API Documentation **Request Syntax** response = client.update_sip_media_application( SipMediaApplicationId='string', Name='string', Endpoints=[ { 'LambdaArn': 'string' }, ] ) Parameters: * **SipMediaApplicationId** (*string*) -- **[REQUIRED]** The SIP media application ID. * **Name** (*string*) -- The new name for the specified SIP media application. * **Endpoints** (*list*) -- The new set of endpoints for the specified SIP media application. * *(dict) --* The endpoint assigned to a SIP media application. * **LambdaArn** *(string) --* Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application. Return type: dict Returns: **Response Syntax** { 'SipMediaApplication': { 'SipMediaApplicationId': 'string', 'AwsRegion': 'string', 'Name': 'string', 'Endpoints': [ { 'LambdaArn': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'SipMediaApplicationArn': 'string' } } **Response Structure** * *(dict) --* * **SipMediaApplication** *(dict) --* The updated SIP media application’s details. * **SipMediaApplicationId** *(string) --* A SIP media application's ID. * **AwsRegion** *(string) --* The AWS Region in which the SIP media application is created. * **Name** *(string) --* The SIP media application's name. * **Endpoints** *(list) --* List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted. * *(dict) --* The endpoint assigned to a SIP media application. * **LambdaArn** *(string) --* Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application. * **CreatedTimestamp** *(datetime) --* The SIP media application creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The time at which the SIP media application was updated. * **SipMediaApplicationArn** *(string) --* The ARN of the SIP media application. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ConflictException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / list_sip_rules list_sip_rules ************** ChimeSDKVoice.Client.list_sip_rules(**kwargs) Lists the SIP rules under the administrator's AWS account. See also: AWS API Documentation **Request Syntax** response = client.list_sip_rules( SipMediaApplicationId='string', MaxResults=123, NextToken='string' ) Parameters: * **SipMediaApplicationId** (*string*) -- The SIP media application ID. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Defaults to 100. * **NextToken** (*string*) -- The token used to return the next page of results. Return type: dict Returns: **Response Syntax** { 'SipRules': [ { 'SipRuleId': 'string', 'Name': 'string', 'Disabled': True|False, 'TriggerType': 'ToPhoneNumber'|'RequestUriHostname', 'TriggerValue': 'string', 'TargetApplications': [ { 'SipMediaApplicationId': 'string', 'Priority': 123, 'AwsRegion': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **SipRules** *(list) --* The list of SIP rules and details. * *(dict) --* The details of a SIP rule, including name, triggers, and target applications. An AWS account can have multiple SIP rules. * **SipRuleId** *(string) --* A SIP rule's ID. * **Name** *(string) --* A SIP rule's name. * **Disabled** *(boolean) --* Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it. * **TriggerType** *(string) --* The type of trigger set for a SIP rule, either a phone number or a URI request host name. * **TriggerValue** *(string) --* The value set for a SIP rule's trigger type. Either a phone number or a URI hostname. * **TargetApplications** *(list) --* The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * *(dict) --* A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided. * **SipMediaApplicationId** *(string) --* The ID of a rule's target SIP media application. * **Priority** *(integer) --* The priority setting of a rule's target SIP media application. * **AwsRegion** *(string) --* The AWS Region of a rule's target SIP media application. * **CreatedTimestamp** *(datetime) --* The time at which the SIP rule was created, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The time at which the SIP rule was updated, in ISO 8601 format. * **NextToken** *(string) --* The token used to return the next page of results. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / create_voice_connector create_voice_connector ********************** ChimeSDKVoice.Client.create_voice_connector(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.create_voice_connector( Name='string', AwsRegion='us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2', RequireEncryption=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], IntegrationType='CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the Voice Connector. * **AwsRegion** (*string*) -- The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: "us- east-1" . * **RequireEncryption** (*boolean*) -- **[REQUIRED]** Enables or disables encryption for the Voice Connector. * **Tags** (*list*) -- The tags assigned to the Voice Connector. * *(dict) --* Describes a tag applied to a resource. * **Key** *(string) --* **[REQUIRED]** The tag's key. * **Value** *(string) --* **[REQUIRED]** The tag's value. * **IntegrationType** (*string*) -- The connectors for use with Amazon Connect. The following options are available: * "CONNECT_CALL_TRANSFER_CONNECTOR" - Enables enterprises to integrate Amazon Connect with other voice systems to directly transfer voice calls and metadata without using the public telephone network. They can use Amazon Connect telephony and Interactive Voice Response (IVR) with their existing voice systems to modernize the IVR experience of their existing contact center and their enterprise and branch voice systems. Additionally, enterprises migrating their contact center to Amazon Connect can start with Connect telephony and IVR for immediate modernization ahead of agent migration. * "CONNECT_ANALYTICS_CONNECTOR" - Enables enterprises to integrate Amazon Connect with other voice systems for real- time and post-call analytics. They can use Amazon Connect Contact Lens with their existing voice systems to provides call recordings, conversational analytics (including contact transcript, sensitive data redaction, content categorization, theme detection, sentiment analysis, real- time alerts, and post-contact summary), and agent performance evaluations (including evaluation forms, automated evaluation, supervisor review) with a rich user experience to display, search and filter customer interactions, and programmatic access to data streams and the data lake. Additionally, enterprises migrating their contact center to Amazon Connect can start with Contact Lens analytics and performance insights ahead of agent migration. Return type: dict Returns: **Response Syntax** { 'VoiceConnector': { 'VoiceConnectorId': 'string', 'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2', 'Name': 'string', 'OutboundHostName': 'string', 'RequireEncryption': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'VoiceConnectorArn': 'string', 'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR' } } **Response Structure** * *(dict) --* * **VoiceConnector** *(dict) --* The details of the Voice Connector. * **VoiceConnectorId** *(string) --* The Voice Connector's ID. * **AwsRegion** *(string) --* The AWS Region in which the Voice Connector is created. Default: us-east-1. * **Name** *(string) --* The Voice Connector's name. * **OutboundHostName** *(string) --* The outbound host name for the Voice Connector. * **RequireEncryption** *(boolean) --* Enables or disables encryption for the Voice Connector. * **CreatedTimestamp** *(datetime) --* The Voice Connector's creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The Voice Connector's updated timestamp, in ISO 8601 format. * **VoiceConnectorArn** *(string) --* The ARN of the Voice Connector. * **IntegrationType** *(string) --* The connectors for use with Amazon Connect. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / batch_delete_phone_number batch_delete_phone_number ************************* ChimeSDKVoice.Client.batch_delete_phone_number(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.batch_delete_phone_number( PhoneNumberIds=[ 'string', ] ) Parameters: **PhoneNumberIds** (*list*) -- **[REQUIRED]** List of phone number IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'PhoneNumberErrors': [ { 'PhoneNumberId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **PhoneNumberErrors** *(list) --* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. * *(dict) --* If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages. * **PhoneNumberId** *(string) --* The phone number ID for which the action failed. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The error message. **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / create_phone_number_order create_phone_number_order ************************* ChimeSDKVoice.Client.create_phone_number_order(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_phone_number_order( ProductType='VoiceConnector'|'SipMediaApplicationDialIn', E164PhoneNumbers=[ 'string', ], Name='string' ) Parameters: * **ProductType** (*string*) -- **[REQUIRED]** The phone number product type. * **E164PhoneNumbers** (*list*) -- **[REQUIRED]** List of phone numbers, in E.164 format. * *(string) --* * **Name** (*string*) -- Specifies the name assigned to one or more phone numbers. Return type: dict Returns: **Response Syntax** { 'PhoneNumberOrder': { 'PhoneNumberOrderId': 'string', 'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled', 'OrderType': 'New'|'Porting', 'OrderedPhoneNumbers': [ { 'E164PhoneNumber': 'string', 'Status': 'Processing'|'Acquired'|'Failed' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'FocDate': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **PhoneNumberOrder** *(dict) --* The phone number order details. * **PhoneNumberOrderId** *(string) --* The ID of the phone order. * **ProductType** *(string) --* The phone number order product type. * **Status** *(string) --* The status of the phone number order. * **OrderType** *(string) --* The type of phone number being ordered, local or toll- free. * **OrderedPhoneNumbers** *(list) --* The ordered phone number details, such as the phone number in E.164 format and the phone number status. * *(dict) --* A phone number for which an order has been placed. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Status** *(string) --* The phone number status. * **CreatedTimestamp** *(datetime) --* The phone number order creation time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number order time stamp, in ISO 8601 format. * **FocDate** *(datetime) --* The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order. **Exceptions** * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.AccessDeniedException" * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException" ChimeSDKVoice / Client / delete_voice_connector_streaming_configuration delete_voice_connector_streaming_configuration ********************************************** ChimeSDKVoice.Client.delete_voice_connector_streaming_configuration(**kwargs) Deletes a Voice Connector's streaming configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_voice_connector_streaming_configuration( VoiceConnectorId='string' ) Parameters: **VoiceConnectorId** (*string*) -- **[REQUIRED]** The Voice Connector ID. Returns: None **Exceptions** * "ChimeSDKVoice.Client.exceptions.UnauthorizedClientException" * "ChimeSDKVoice.Client.exceptions.NotFoundException" * "ChimeSDKVoice.Client.exceptions.ForbiddenException" * "ChimeSDKVoice.Client.exceptions.BadRequestException" * "ChimeSDKVoice.Client.exceptions.ThrottledClientException" * "ChimeSDKVoice.Client.exceptions.ServiceUnavailableException" * "ChimeSDKVoice.Client.exceptions.ServiceFailureException"