ChimeSDKVoiceClient#
Index > ChimeSDKVoice > ChimeSDKVoiceClient
Auto-generated documentation for ChimeSDKVoice type annotations stubs module mypy-boto3-chime-sdk-voice.
ChimeSDKVoiceClient#
Type annotations and code completion for boto3.client("chime-sdk-voice").
boto3 documentation
# ChimeSDKVoiceClient usage example
from boto3.session import Session
from mypy_boto3_chime_sdk_voice.client import ChimeSDKVoiceClient
def get_chime-sdk-voice_client() -> ChimeSDKVoiceClient:
return Session().client("chime-sdk-voice")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("chime-sdk-voice").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("chime-sdk-voice")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ForbiddenException,
client.exceptions.GoneException,
client.exceptions.NotFoundException,
client.exceptions.ResourceLimitExceededException,
client.exceptions.ServiceFailureException,
client.exceptions.ServiceUnavailableException,
client.exceptions.ThrottledClientException,
client.exceptions.UnauthorizedClientException,
client.exceptions.UnprocessableEntityException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_chime_sdk_voice.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
associate_phone_numbers_with_voice_connector#
Associates phone numbers with the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").associate_phone_numbers_with_voice_connector method.
boto3 documentation
# associate_phone_numbers_with_voice_connector method definition
def associate_phone_numbers_with_voice_connector(
self,
*,
VoiceConnectorId: str,
E164PhoneNumbers: Sequence[str],
ForceAssociate: bool = ...,
) -> AssociatePhoneNumbersWithVoiceConnectorResponseTypeDef: # (1)
...# associate_phone_numbers_with_voice_connector method usage example with argument unpacking
kwargs: AssociatePhoneNumbersWithVoiceConnectorRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"E164PhoneNumbers": ...,
}
parent.associate_phone_numbers_with_voice_connector(**kwargs)associate_phone_numbers_with_voice_connector_group#
Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.
Type annotations and code completion for boto3.client("chime-sdk-voice").associate_phone_numbers_with_voice_connector_group method.
boto3 documentation
# associate_phone_numbers_with_voice_connector_group method definition
def associate_phone_numbers_with_voice_connector_group(
self,
*,
VoiceConnectorGroupId: str,
E164PhoneNumbers: Sequence[str],
ForceAssociate: bool = ...,
) -> AssociatePhoneNumbersWithVoiceConnectorGroupResponseTypeDef: # (1)
...# associate_phone_numbers_with_voice_connector_group method usage example with argument unpacking
kwargs: AssociatePhoneNumbersWithVoiceConnectorGroupRequestRequestTypeDef = { # (1)
"VoiceConnectorGroupId": ...,
"E164PhoneNumbers": ...,
}
parent.associate_phone_numbers_with_voice_connector_group(**kwargs)batch_delete_phone_number#
Moves phone numbers into the Deletion queue.
Type annotations and code completion for boto3.client("chime-sdk-voice").batch_delete_phone_number method.
boto3 documentation
# batch_delete_phone_number method definition
def batch_delete_phone_number(
self,
*,
PhoneNumberIds: Sequence[str],
) -> BatchDeletePhoneNumberResponseTypeDef: # (1)
...# batch_delete_phone_number method usage example with argument unpacking
kwargs: BatchDeletePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberIds": ...,
}
parent.batch_delete_phone_number(**kwargs)batch_update_phone_number#
Updates phone number product types, calling names, or phone number names.
Type annotations and code completion for boto3.client("chime-sdk-voice").batch_update_phone_number method.
boto3 documentation
# batch_update_phone_number method definition
def batch_update_phone_number(
self,
*,
UpdatePhoneNumberRequestItems: Sequence[UpdatePhoneNumberRequestItemTypeDef], # (1)
) -> BatchUpdatePhoneNumberResponseTypeDef: # (2)
...# batch_update_phone_number method usage example with argument unpacking
kwargs: BatchUpdatePhoneNumberRequestRequestTypeDef = { # (1)
"UpdatePhoneNumberRequestItems": ...,
}
parent.batch_update_phone_number(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("chime-sdk-voice").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("chime-sdk-voice").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_phone_number_order#
Creates an order for phone numbers to be provisioned.
Type annotations and code completion for boto3.client("chime-sdk-voice").create_phone_number_order method.
boto3 documentation
# create_phone_number_order method definition
def create_phone_number_order(
self,
*,
ProductType: PhoneNumberProductTypeType, # (1)
E164PhoneNumbers: Sequence[str],
Name: str = ...,
) -> CreatePhoneNumberOrderResponseTypeDef: # (2)
...# create_phone_number_order method usage example with argument unpacking
kwargs: CreatePhoneNumberOrderRequestRequestTypeDef = { # (1)
"ProductType": ...,
"E164PhoneNumbers": ...,
}
parent.create_phone_number_order(**kwargs)create_proxy_session#
Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.
Type annotations and code completion for boto3.client("chime-sdk-voice").create_proxy_session method.
boto3 documentation
# create_proxy_session method definition
def create_proxy_session(
self,
*,
VoiceConnectorId: str,
ParticipantPhoneNumbers: Sequence[str],
Capabilities: Sequence[CapabilityType], # (1)
Name: str = ...,
ExpiryMinutes: int = ...,
NumberSelectionBehavior: NumberSelectionBehaviorType = ..., # (2)
GeoMatchLevel: GeoMatchLevelType = ..., # (3)
GeoMatchParams: GeoMatchParamsTypeDef = ..., # (4)
) -> CreateProxySessionResponseTypeDef: # (5)
...- See CapabilityType
- See NumberSelectionBehaviorType
- See GeoMatchLevelType
- See GeoMatchParamsTypeDef
- See CreateProxySessionResponseTypeDef
# create_proxy_session method usage example with argument unpacking
kwargs: CreateProxySessionRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"ParticipantPhoneNumbers": ...,
"Capabilities": ...,
}
parent.create_proxy_session(**kwargs)create_sip_media_application#
Creates a SIP media application.
Type annotations and code completion for boto3.client("chime-sdk-voice").create_sip_media_application method.
boto3 documentation
# create_sip_media_application method definition
def create_sip_media_application(
self,
*,
AwsRegion: str,
Name: str,
Endpoints: Sequence[SipMediaApplicationEndpointTypeDef], # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateSipMediaApplicationResponseTypeDef: # (3)
...# create_sip_media_application method usage example with argument unpacking
kwargs: CreateSipMediaApplicationRequestRequestTypeDef = { # (1)
"AwsRegion": ...,
"Name": ...,
"Endpoints": ...,
}
parent.create_sip_media_application(**kwargs)create_sip_media_application_call#
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.
Type annotations and code completion for boto3.client("chime-sdk-voice").create_sip_media_application_call method.
boto3 documentation
# create_sip_media_application_call method definition
def create_sip_media_application_call(
self,
*,
FromPhoneNumber: str,
ToPhoneNumber: str,
SipMediaApplicationId: str,
SipHeaders: Mapping[str, str] = ...,
ArgumentsMap: Mapping[str, str] = ...,
) -> CreateSipMediaApplicationCallResponseTypeDef: # (1)
...# create_sip_media_application_call method usage example with argument unpacking
kwargs: CreateSipMediaApplicationCallRequestRequestTypeDef = { # (1)
"FromPhoneNumber": ...,
"ToPhoneNumber": ...,
"SipMediaApplicationId": ...,
}
parent.create_sip_media_application_call(**kwargs)create_sip_rule#
Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type.
Type annotations and code completion for boto3.client("chime-sdk-voice").create_sip_rule method.
boto3 documentation
# create_sip_rule method definition
def create_sip_rule(
self,
*,
Name: str,
TriggerType: SipRuleTriggerTypeType, # (1)
TriggerValue: str,
Disabled: bool = ...,
TargetApplications: Sequence[SipRuleTargetApplicationTypeDef] = ..., # (2)
) -> CreateSipRuleResponseTypeDef: # (3)
...# create_sip_rule method usage example with argument unpacking
kwargs: CreateSipRuleRequestRequestTypeDef = { # (1)
"Name": ...,
"TriggerType": ...,
"TriggerValue": ...,
}
parent.create_sip_rule(**kwargs)create_voice_connector#
Creates an Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").create_voice_connector method.
boto3 documentation
# create_voice_connector method definition
def create_voice_connector(
self,
*,
Name: str,
RequireEncryption: bool,
AwsRegion: VoiceConnectorAwsRegionType = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateVoiceConnectorResponseTypeDef: # (3)
...# create_voice_connector method usage example with argument unpacking
kwargs: CreateVoiceConnectorRequestRequestTypeDef = { # (1)
"Name": ...,
"RequireEncryption": ...,
}
parent.create_voice_connector(**kwargs)create_voice_connector_group#
Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account.
Type annotations and code completion for boto3.client("chime-sdk-voice").create_voice_connector_group method.
boto3 documentation
# create_voice_connector_group method definition
def create_voice_connector_group(
self,
*,
Name: str,
VoiceConnectorItems: Sequence[VoiceConnectorItemTypeDef] = ..., # (1)
) -> CreateVoiceConnectorGroupResponseTypeDef: # (2)
...# create_voice_connector_group method usage example with argument unpacking
kwargs: CreateVoiceConnectorGroupRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_voice_connector_group(**kwargs)create_voice_profile#
Creates a voice profile, which consists of an enrolled user and their latest voice print.
Type annotations and code completion for boto3.client("chime-sdk-voice").create_voice_profile method.
boto3 documentation
# create_voice_profile method definition
def create_voice_profile(
self,
*,
SpeakerSearchTaskId: str,
) -> CreateVoiceProfileResponseTypeDef: # (1)
...# create_voice_profile method usage example with argument unpacking
kwargs: CreateVoiceProfileRequestRequestTypeDef = { # (1)
"SpeakerSearchTaskId": ...,
}
parent.create_voice_profile(**kwargs)create_voice_profile_domain#
Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.
Type annotations and code completion for boto3.client("chime-sdk-voice").create_voice_profile_domain method.
boto3 documentation
# create_voice_profile_domain method definition
def create_voice_profile_domain(
self,
*,
Name: str,
ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef, # (1)
Description: str = ...,
ClientRequestToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateVoiceProfileDomainResponseTypeDef: # (3)
...- See ServerSideEncryptionConfigurationTypeDef
- See TagTypeDef
- See CreateVoiceProfileDomainResponseTypeDef
# create_voice_profile_domain method usage example with argument unpacking
kwargs: CreateVoiceProfileDomainRequestRequestTypeDef = { # (1)
"Name": ...,
"ServerSideEncryptionConfiguration": ...,
}
parent.create_voice_profile_domain(**kwargs)delete_phone_number#
Moves the specified phone number into the Deletion queue.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_phone_number method.
boto3 documentation
# delete_phone_number method definition
def delete_phone_number(
self,
*,
PhoneNumberId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_phone_number method usage example with argument unpacking
kwargs: DeletePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.delete_phone_number(**kwargs)delete_proxy_session#
Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_proxy_session method.
boto3 documentation
# delete_proxy_session method definition
def delete_proxy_session(
self,
*,
VoiceConnectorId: str,
ProxySessionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_proxy_session method usage example with argument unpacking
kwargs: DeleteProxySessionRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"ProxySessionId": ...,
}
parent.delete_proxy_session(**kwargs)delete_sip_media_application#
Deletes a SIP media application.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_sip_media_application method.
boto3 documentation
# delete_sip_media_application method definition
def delete_sip_media_application(
self,
*,
SipMediaApplicationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_sip_media_application method usage example with argument unpacking
kwargs: DeleteSipMediaApplicationRequestRequestTypeDef = { # (1)
"SipMediaApplicationId": ...,
}
parent.delete_sip_media_application(**kwargs)delete_sip_rule#
Deletes a SIP rule.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_sip_rule method.
boto3 documentation
# delete_sip_rule method definition
def delete_sip_rule(
self,
*,
SipRuleId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_sip_rule method usage example with argument unpacking
kwargs: DeleteSipRuleRequestRequestTypeDef = { # (1)
"SipRuleId": ...,
}
parent.delete_sip_rule(**kwargs)delete_voice_connector#
Deletes an Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_connector method.
boto3 documentation
# delete_voice_connector method definition
def delete_voice_connector(
self,
*,
VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_voice_connector method usage example with argument unpacking
kwargs: DeleteVoiceConnectorRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.delete_voice_connector(**kwargs)delete_voice_connector_emergency_calling_configuration#
Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_connector_emergency_calling_configuration method.
boto3 documentation
# delete_voice_connector_emergency_calling_configuration method definition
def delete_voice_connector_emergency_calling_configuration(
self,
*,
VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_voice_connector_emergency_calling_configuration method usage example with argument unpacking
kwargs: DeleteVoiceConnectorEmergencyCallingConfigurationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.delete_voice_connector_emergency_calling_configuration(**kwargs)delete_voice_connector_group#
Deletes an Amazon Chime SDK Voice Connector group.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_connector_group method.
boto3 documentation
# delete_voice_connector_group method definition
def delete_voice_connector_group(
self,
*,
VoiceConnectorGroupId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_voice_connector_group method usage example with argument unpacking
kwargs: DeleteVoiceConnectorGroupRequestRequestTypeDef = { # (1)
"VoiceConnectorGroupId": ...,
}
parent.delete_voice_connector_group(**kwargs)delete_voice_connector_origination#
Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_connector_origination method.
boto3 documentation
# delete_voice_connector_origination method definition
def delete_voice_connector_origination(
self,
*,
VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_voice_connector_origination method usage example with argument unpacking
kwargs: DeleteVoiceConnectorOriginationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.delete_voice_connector_origination(**kwargs)delete_voice_connector_proxy#
Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_connector_proxy method.
boto3 documentation
# delete_voice_connector_proxy method definition
def delete_voice_connector_proxy(
self,
*,
VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_voice_connector_proxy method usage example with argument unpacking
kwargs: DeleteVoiceConnectorProxyRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.delete_voice_connector_proxy(**kwargs)delete_voice_connector_streaming_configuration#
Deletes a Voice Connector's streaming configuration.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_connector_streaming_configuration method.
boto3 documentation
# delete_voice_connector_streaming_configuration method definition
def delete_voice_connector_streaming_configuration(
self,
*,
VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_voice_connector_streaming_configuration method usage example with argument unpacking
kwargs: DeleteVoiceConnectorStreamingConfigurationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.delete_voice_connector_streaming_configuration(**kwargs)delete_voice_connector_termination#
Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_connector_termination method.
boto3 documentation
# delete_voice_connector_termination method definition
def delete_voice_connector_termination(
self,
*,
VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_voice_connector_termination method usage example with argument unpacking
kwargs: DeleteVoiceConnectorTerminationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.delete_voice_connector_termination(**kwargs)delete_voice_connector_termination_credentials#
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_connector_termination_credentials method.
boto3 documentation
# delete_voice_connector_termination_credentials method definition
def delete_voice_connector_termination_credentials(
self,
*,
VoiceConnectorId: str,
Usernames: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_voice_connector_termination_credentials method usage example with argument unpacking
kwargs: DeleteVoiceConnectorTerminationCredentialsRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"Usernames": ...,
}
parent.delete_voice_connector_termination_credentials(**kwargs)delete_voice_profile#
Deletes a voice profile, including its voice print and enrollment data.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_profile method.
boto3 documentation
# delete_voice_profile method definition
def delete_voice_profile(
self,
*,
VoiceProfileId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_voice_profile method usage example with argument unpacking
kwargs: DeleteVoiceProfileRequestRequestTypeDef = { # (1)
"VoiceProfileId": ...,
}
parent.delete_voice_profile(**kwargs)delete_voice_profile_domain#
Deletes all voice profiles in the domain.
Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_profile_domain method.
boto3 documentation
# delete_voice_profile_domain method definition
def delete_voice_profile_domain(
self,
*,
VoiceProfileDomainId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_voice_profile_domain method usage example with argument unpacking
kwargs: DeleteVoiceProfileDomainRequestRequestTypeDef = { # (1)
"VoiceProfileDomainId": ...,
}
parent.delete_voice_profile_domain(**kwargs)disassociate_phone_numbers_from_voice_connector#
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").disassociate_phone_numbers_from_voice_connector method.
boto3 documentation
# disassociate_phone_numbers_from_voice_connector method definition
def disassociate_phone_numbers_from_voice_connector(
self,
*,
VoiceConnectorId: str,
E164PhoneNumbers: Sequence[str],
) -> DisassociatePhoneNumbersFromVoiceConnectorResponseTypeDef: # (1)
...# disassociate_phone_numbers_from_voice_connector method usage example with argument unpacking
kwargs: DisassociatePhoneNumbersFromVoiceConnectorRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"E164PhoneNumbers": ...,
}
parent.disassociate_phone_numbers_from_voice_connector(**kwargs)disassociate_phone_numbers_from_voice_connector_group#
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.
Type annotations and code completion for boto3.client("chime-sdk-voice").disassociate_phone_numbers_from_voice_connector_group method.
boto3 documentation
# disassociate_phone_numbers_from_voice_connector_group method definition
def disassociate_phone_numbers_from_voice_connector_group(
self,
*,
VoiceConnectorGroupId: str,
E164PhoneNumbers: Sequence[str],
) -> DisassociatePhoneNumbersFromVoiceConnectorGroupResponseTypeDef: # (1)
...# disassociate_phone_numbers_from_voice_connector_group method usage example with argument unpacking
kwargs: DisassociatePhoneNumbersFromVoiceConnectorGroupRequestRequestTypeDef = { # (1)
"VoiceConnectorGroupId": ...,
"E164PhoneNumbers": ...,
}
parent.disassociate_phone_numbers_from_voice_connector_group(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("chime-sdk-voice").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_global_settings#
Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_global_settings method.
boto3 documentation
# get_global_settings method definition
def get_global_settings(
self,
) -> GetGlobalSettingsResponseTypeDef: # (1)
...get_phone_number#
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_phone_number method.
boto3 documentation
# get_phone_number method definition
def get_phone_number(
self,
*,
PhoneNumberId: str,
) -> GetPhoneNumberResponseTypeDef: # (1)
...# get_phone_number method usage example with argument unpacking
kwargs: GetPhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.get_phone_number(**kwargs)get_phone_number_order#
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.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_phone_number_order method.
boto3 documentation
# get_phone_number_order method definition
def get_phone_number_order(
self,
*,
PhoneNumberOrderId: str,
) -> GetPhoneNumberOrderResponseTypeDef: # (1)
...# get_phone_number_order method usage example with argument unpacking
kwargs: GetPhoneNumberOrderRequestRequestTypeDef = { # (1)
"PhoneNumberOrderId": ...,
}
parent.get_phone_number_order(**kwargs)get_phone_number_settings#
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_phone_number_settings method.
boto3 documentation
# get_phone_number_settings method definition
def get_phone_number_settings(
self,
) -> GetPhoneNumberSettingsResponseTypeDef: # (1)
...get_proxy_session#
Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_proxy_session method.
boto3 documentation
# get_proxy_session method definition
def get_proxy_session(
self,
*,
VoiceConnectorId: str,
ProxySessionId: str,
) -> GetProxySessionResponseTypeDef: # (1)
...# get_proxy_session method usage example with argument unpacking
kwargs: GetProxySessionRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"ProxySessionId": ...,
}
parent.get_proxy_session(**kwargs)get_sip_media_application#
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_sip_media_application method.
boto3 documentation
# get_sip_media_application method definition
def get_sip_media_application(
self,
*,
SipMediaApplicationId: str,
) -> GetSipMediaApplicationResponseTypeDef: # (1)
...# get_sip_media_application method usage example with argument unpacking
kwargs: GetSipMediaApplicationRequestRequestTypeDef = { # (1)
"SipMediaApplicationId": ...,
}
parent.get_sip_media_application(**kwargs)get_sip_media_application_alexa_skill_configuration#
Gets the Alexa Skill configuration for the SIP media application.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_sip_media_application_alexa_skill_configuration method.
boto3 documentation
# get_sip_media_application_alexa_skill_configuration method definition
def get_sip_media_application_alexa_skill_configuration(
self,
*,
SipMediaApplicationId: str,
) -> GetSipMediaApplicationAlexaSkillConfigurationResponseTypeDef: # (1)
...# get_sip_media_application_alexa_skill_configuration method usage example with argument unpacking
kwargs: GetSipMediaApplicationAlexaSkillConfigurationRequestRequestTypeDef = { # (1)
"SipMediaApplicationId": ...,
}
parent.get_sip_media_application_alexa_skill_configuration(**kwargs)get_sip_media_application_logging_configuration#
Retrieves the logging configuration for the specified SIP media application.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_sip_media_application_logging_configuration method.
boto3 documentation
# get_sip_media_application_logging_configuration method definition
def get_sip_media_application_logging_configuration(
self,
*,
SipMediaApplicationId: str,
) -> GetSipMediaApplicationLoggingConfigurationResponseTypeDef: # (1)
...# get_sip_media_application_logging_configuration method usage example with argument unpacking
kwargs: GetSipMediaApplicationLoggingConfigurationRequestRequestTypeDef = { # (1)
"SipMediaApplicationId": ...,
}
parent.get_sip_media_application_logging_configuration(**kwargs)get_sip_rule#
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_sip_rule method.
boto3 documentation
# get_sip_rule method definition
def get_sip_rule(
self,
*,
SipRuleId: str,
) -> GetSipRuleResponseTypeDef: # (1)
...# get_sip_rule method usage example with argument unpacking
kwargs: GetSipRuleRequestRequestTypeDef = { # (1)
"SipRuleId": ...,
}
parent.get_sip_rule(**kwargs)get_speaker_search_task#
Retrieves the details of the specified speaker search task.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_speaker_search_task method.
boto3 documentation
# get_speaker_search_task method definition
def get_speaker_search_task(
self,
*,
VoiceConnectorId: str,
SpeakerSearchTaskId: str,
) -> GetSpeakerSearchTaskResponseTypeDef: # (1)
...# get_speaker_search_task method usage example with argument unpacking
kwargs: GetSpeakerSearchTaskRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"SpeakerSearchTaskId": ...,
}
parent.get_speaker_search_task(**kwargs)get_voice_connector#
Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_connector method.
boto3 documentation
# get_voice_connector method definition
def get_voice_connector(
self,
*,
VoiceConnectorId: str,
) -> GetVoiceConnectorResponseTypeDef: # (1)
...# get_voice_connector method usage example with argument unpacking
kwargs: GetVoiceConnectorRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.get_voice_connector(**kwargs)get_voice_connector_emergency_calling_configuration#
Retrieves the emergency calling configuration details for the specified Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_connector_emergency_calling_configuration method.
boto3 documentation
# get_voice_connector_emergency_calling_configuration method definition
def get_voice_connector_emergency_calling_configuration(
self,
*,
VoiceConnectorId: str,
) -> GetVoiceConnectorEmergencyCallingConfigurationResponseTypeDef: # (1)
...# get_voice_connector_emergency_calling_configuration method usage example with argument unpacking
kwargs: GetVoiceConnectorEmergencyCallingConfigurationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.get_voice_connector_emergency_calling_configuration(**kwargs)get_voice_connector_group#
Retrieves details for the specified Amazon Chime SDK Voice Connector group,
such as timestamps,name, and associated VoiceConnectorItems.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_connector_group method.
boto3 documentation
# get_voice_connector_group method definition
def get_voice_connector_group(
self,
*,
VoiceConnectorGroupId: str,
) -> GetVoiceConnectorGroupResponseTypeDef: # (1)
...# get_voice_connector_group method usage example with argument unpacking
kwargs: GetVoiceConnectorGroupRequestRequestTypeDef = { # (1)
"VoiceConnectorGroupId": ...,
}
parent.get_voice_connector_group(**kwargs)get_voice_connector_logging_configuration#
Retrieves the logging configuration settings for the specified Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_connector_logging_configuration method.
boto3 documentation
# get_voice_connector_logging_configuration method definition
def get_voice_connector_logging_configuration(
self,
*,
VoiceConnectorId: str,
) -> GetVoiceConnectorLoggingConfigurationResponseTypeDef: # (1)
...# get_voice_connector_logging_configuration method usage example with argument unpacking
kwargs: GetVoiceConnectorLoggingConfigurationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.get_voice_connector_logging_configuration(**kwargs)get_voice_connector_origination#
Retrieves the origination settings for the specified Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_connector_origination method.
boto3 documentation
# get_voice_connector_origination method definition
def get_voice_connector_origination(
self,
*,
VoiceConnectorId: str,
) -> GetVoiceConnectorOriginationResponseTypeDef: # (1)
...# get_voice_connector_origination method usage example with argument unpacking
kwargs: GetVoiceConnectorOriginationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.get_voice_connector_origination(**kwargs)get_voice_connector_proxy#
Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_connector_proxy method.
boto3 documentation
# get_voice_connector_proxy method definition
def get_voice_connector_proxy(
self,
*,
VoiceConnectorId: str,
) -> GetVoiceConnectorProxyResponseTypeDef: # (1)
...# get_voice_connector_proxy method usage example with argument unpacking
kwargs: GetVoiceConnectorProxyRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.get_voice_connector_proxy(**kwargs)get_voice_connector_streaming_configuration#
Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_connector_streaming_configuration method.
boto3 documentation
# get_voice_connector_streaming_configuration method definition
def get_voice_connector_streaming_configuration(
self,
*,
VoiceConnectorId: str,
) -> GetVoiceConnectorStreamingConfigurationResponseTypeDef: # (1)
...# get_voice_connector_streaming_configuration method usage example with argument unpacking
kwargs: GetVoiceConnectorStreamingConfigurationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.get_voice_connector_streaming_configuration(**kwargs)get_voice_connector_termination#
Retrieves the termination setting details for the specified Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_connector_termination method.
boto3 documentation
# get_voice_connector_termination method definition
def get_voice_connector_termination(
self,
*,
VoiceConnectorId: str,
) -> GetVoiceConnectorTerminationResponseTypeDef: # (1)
...# get_voice_connector_termination method usage example with argument unpacking
kwargs: GetVoiceConnectorTerminationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.get_voice_connector_termination(**kwargs)get_voice_connector_termination_health#
Retrieves information about the last time a SIP OPTIONS ping was received
from your SIP infrastructure for the specified Amazon Chime SDK Voice
Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_connector_termination_health method.
boto3 documentation
# get_voice_connector_termination_health method definition
def get_voice_connector_termination_health(
self,
*,
VoiceConnectorId: str,
) -> GetVoiceConnectorTerminationHealthResponseTypeDef: # (1)
...# get_voice_connector_termination_health method usage example with argument unpacking
kwargs: GetVoiceConnectorTerminationHealthRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.get_voice_connector_termination_health(**kwargs)get_voice_profile#
Retrieves the details of the specified voice profile.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_profile method.
boto3 documentation
# get_voice_profile method definition
def get_voice_profile(
self,
*,
VoiceProfileId: str,
) -> GetVoiceProfileResponseTypeDef: # (1)
...# get_voice_profile method usage example with argument unpacking
kwargs: GetVoiceProfileRequestRequestTypeDef = { # (1)
"VoiceProfileId": ...,
}
parent.get_voice_profile(**kwargs)get_voice_profile_domain#
Retrieves the details of the specified voice profile domain.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_profile_domain method.
boto3 documentation
# get_voice_profile_domain method definition
def get_voice_profile_domain(
self,
*,
VoiceProfileDomainId: str,
) -> GetVoiceProfileDomainResponseTypeDef: # (1)
...# get_voice_profile_domain method usage example with argument unpacking
kwargs: GetVoiceProfileDomainRequestRequestTypeDef = { # (1)
"VoiceProfileDomainId": ...,
}
parent.get_voice_profile_domain(**kwargs)get_voice_tone_analysis_task#
Retrieves the details of a voice tone analysis task.
Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_tone_analysis_task method.
boto3 documentation
# get_voice_tone_analysis_task method definition
def get_voice_tone_analysis_task(
self,
*,
VoiceConnectorId: str,
VoiceToneAnalysisTaskId: str,
IsCaller: bool,
) -> GetVoiceToneAnalysisTaskResponseTypeDef: # (1)
...# get_voice_tone_analysis_task method usage example with argument unpacking
kwargs: GetVoiceToneAnalysisTaskRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"VoiceToneAnalysisTaskId": ...,
"IsCaller": ...,
}
parent.get_voice_tone_analysis_task(**kwargs)list_available_voice_connector_regions#
Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_available_voice_connector_regions method.
boto3 documentation
# list_available_voice_connector_regions method definition
def list_available_voice_connector_regions(
self,
) -> ListAvailableVoiceConnectorRegionsResponseTypeDef: # (1)
...list_phone_number_orders#
Lists the phone numbers for an administrator's Amazon Chime SDK account.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_phone_number_orders method.
boto3 documentation
# list_phone_number_orders method definition
def list_phone_number_orders(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPhoneNumberOrdersResponseTypeDef: # (1)
...# list_phone_number_orders method usage example with argument unpacking
kwargs: ListPhoneNumberOrdersRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_phone_number_orders(**kwargs)list_phone_numbers#
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.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_phone_numbers method.
boto3 documentation
# list_phone_numbers method definition
def list_phone_numbers(
self,
*,
Status: str = ...,
ProductType: PhoneNumberProductTypeType = ..., # (1)
FilterName: PhoneNumberAssociationNameType = ..., # (2)
FilterValue: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListPhoneNumbersResponseTypeDef: # (3)
...- See PhoneNumberProductTypeType
- See PhoneNumberAssociationNameType
- See ListPhoneNumbersResponseTypeDef
# list_phone_numbers method usage example with argument unpacking
kwargs: ListPhoneNumbersRequestRequestTypeDef = { # (1)
"Status": ...,
}
parent.list_phone_numbers(**kwargs)list_proxy_sessions#
Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_proxy_sessions method.
boto3 documentation
# list_proxy_sessions method definition
def list_proxy_sessions(
self,
*,
VoiceConnectorId: str,
Status: ProxySessionStatusType = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListProxySessionsResponseTypeDef: # (2)
...# list_proxy_sessions method usage example with argument unpacking
kwargs: ListProxySessionsRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.list_proxy_sessions(**kwargs)list_sip_media_applications#
Lists the SIP media applications under the administrator's AWS account.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_sip_media_applications method.
boto3 documentation
# list_sip_media_applications method definition
def list_sip_media_applications(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSipMediaApplicationsResponseTypeDef: # (1)
...# list_sip_media_applications method usage example with argument unpacking
kwargs: ListSipMediaApplicationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_sip_media_applications(**kwargs)list_sip_rules#
Lists the SIP rules under the administrator's AWS account.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_sip_rules method.
boto3 documentation
# list_sip_rules method definition
def list_sip_rules(
self,
*,
SipMediaApplicationId: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSipRulesResponseTypeDef: # (1)
...# list_sip_rules method usage example with argument unpacking
kwargs: ListSipRulesRequestRequestTypeDef = { # (1)
"SipMediaApplicationId": ...,
}
parent.list_sip_rules(**kwargs)list_supported_phone_number_countries#
Lists the countries that you can order phone numbers from.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_supported_phone_number_countries method.
boto3 documentation
# list_supported_phone_number_countries method definition
def list_supported_phone_number_countries(
self,
*,
ProductType: PhoneNumberProductTypeType, # (1)
) -> ListSupportedPhoneNumberCountriesResponseTypeDef: # (2)
...# list_supported_phone_number_countries method usage example with argument unpacking
kwargs: ListSupportedPhoneNumberCountriesRequestRequestTypeDef = { # (1)
"ProductType": ...,
}
parent.list_supported_phone_number_countries(**kwargs)list_tags_for_resource#
Returns a list of the tags in a given resource.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)list_voice_connector_groups#
Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_voice_connector_groups method.
boto3 documentation
# list_voice_connector_groups method definition
def list_voice_connector_groups(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListVoiceConnectorGroupsResponseTypeDef: # (1)
...# list_voice_connector_groups method usage example with argument unpacking
kwargs: ListVoiceConnectorGroupsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_voice_connector_groups(**kwargs)list_voice_connector_termination_credentials#
Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_voice_connector_termination_credentials method.
boto3 documentation
# list_voice_connector_termination_credentials method definition
def list_voice_connector_termination_credentials(
self,
*,
VoiceConnectorId: str,
) -> ListVoiceConnectorTerminationCredentialsResponseTypeDef: # (1)
...# list_voice_connector_termination_credentials method usage example with argument unpacking
kwargs: ListVoiceConnectorTerminationCredentialsRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.list_voice_connector_termination_credentials(**kwargs)list_voice_connectors#
Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_voice_connectors method.
boto3 documentation
# list_voice_connectors method definition
def list_voice_connectors(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListVoiceConnectorsResponseTypeDef: # (1)
...# list_voice_connectors method usage example with argument unpacking
kwargs: ListVoiceConnectorsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_voice_connectors(**kwargs)list_voice_profile_domains#
Lists the specified voice profile domains in the administrator's AWS account.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_voice_profile_domains method.
boto3 documentation
# list_voice_profile_domains method definition
def list_voice_profile_domains(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListVoiceProfileDomainsResponseTypeDef: # (1)
...# list_voice_profile_domains method usage example with argument unpacking
kwargs: ListVoiceProfileDomainsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_voice_profile_domains(**kwargs)list_voice_profiles#
Lists the voice profiles in a voice profile domain.
Type annotations and code completion for boto3.client("chime-sdk-voice").list_voice_profiles method.
boto3 documentation
# list_voice_profiles method definition
def list_voice_profiles(
self,
*,
VoiceProfileDomainId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListVoiceProfilesResponseTypeDef: # (1)
...# list_voice_profiles method usage example with argument unpacking
kwargs: ListVoiceProfilesRequestRequestTypeDef = { # (1)
"VoiceProfileDomainId": ...,
}
parent.list_voice_profiles(**kwargs)put_sip_media_application_alexa_skill_configuration#
Updates the Alexa Skill configuration for the SIP media application.
Type annotations and code completion for boto3.client("chime-sdk-voice").put_sip_media_application_alexa_skill_configuration method.
boto3 documentation
# put_sip_media_application_alexa_skill_configuration method definition
def put_sip_media_application_alexa_skill_configuration(
self,
*,
SipMediaApplicationId: str,
SipMediaApplicationAlexaSkillConfiguration: SipMediaApplicationAlexaSkillConfigurationTypeDef = ..., # (1)
) -> PutSipMediaApplicationAlexaSkillConfigurationResponseTypeDef: # (2)
...- See SipMediaApplicationAlexaSkillConfigurationTypeDef
- See PutSipMediaApplicationAlexaSkillConfigurationResponseTypeDef
# put_sip_media_application_alexa_skill_configuration method usage example with argument unpacking
kwargs: PutSipMediaApplicationAlexaSkillConfigurationRequestRequestTypeDef = { # (1)
"SipMediaApplicationId": ...,
}
parent.put_sip_media_application_alexa_skill_configuration(**kwargs)put_sip_media_application_logging_configuration#
Updates the logging configuration for the specified SIP media application.
Type annotations and code completion for boto3.client("chime-sdk-voice").put_sip_media_application_logging_configuration method.
boto3 documentation
# put_sip_media_application_logging_configuration method definition
def put_sip_media_application_logging_configuration(
self,
*,
SipMediaApplicationId: str,
SipMediaApplicationLoggingConfiguration: SipMediaApplicationLoggingConfigurationTypeDef = ..., # (1)
) -> PutSipMediaApplicationLoggingConfigurationResponseTypeDef: # (2)
...- See SipMediaApplicationLoggingConfigurationTypeDef
- See PutSipMediaApplicationLoggingConfigurationResponseTypeDef
# put_sip_media_application_logging_configuration method usage example with argument unpacking
kwargs: PutSipMediaApplicationLoggingConfigurationRequestRequestTypeDef = { # (1)
"SipMediaApplicationId": ...,
}
parent.put_sip_media_application_logging_configuration(**kwargs)put_voice_connector_emergency_calling_configuration#
Updates a Voice Connector's emergency calling configuration.
Type annotations and code completion for boto3.client("chime-sdk-voice").put_voice_connector_emergency_calling_configuration method.
boto3 documentation
# put_voice_connector_emergency_calling_configuration method definition
def put_voice_connector_emergency_calling_configuration(
self,
*,
VoiceConnectorId: str,
EmergencyCallingConfiguration: EmergencyCallingConfigurationTypeDef, # (1)
) -> PutVoiceConnectorEmergencyCallingConfigurationResponseTypeDef: # (2)
...- See EmergencyCallingConfigurationTypeDef
- See PutVoiceConnectorEmergencyCallingConfigurationResponseTypeDef
# put_voice_connector_emergency_calling_configuration method usage example with argument unpacking
kwargs: PutVoiceConnectorEmergencyCallingConfigurationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"EmergencyCallingConfiguration": ...,
}
parent.put_voice_connector_emergency_calling_configuration(**kwargs)put_voice_connector_logging_configuration#
Updates a Voice Connector's logging configuration.
Type annotations and code completion for boto3.client("chime-sdk-voice").put_voice_connector_logging_configuration method.
boto3 documentation
# put_voice_connector_logging_configuration method definition
def put_voice_connector_logging_configuration(
self,
*,
VoiceConnectorId: str,
LoggingConfiguration: LoggingConfigurationTypeDef, # (1)
) -> PutVoiceConnectorLoggingConfigurationResponseTypeDef: # (2)
...# put_voice_connector_logging_configuration method usage example with argument unpacking
kwargs: PutVoiceConnectorLoggingConfigurationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"LoggingConfiguration": ...,
}
parent.put_voice_connector_logging_configuration(**kwargs)put_voice_connector_origination#
Updates a Voice Connector's origination settings.
Type annotations and code completion for boto3.client("chime-sdk-voice").put_voice_connector_origination method.
boto3 documentation
# put_voice_connector_origination method definition
def put_voice_connector_origination(
self,
*,
VoiceConnectorId: str,
Origination: OriginationTypeDef, # (1)
) -> PutVoiceConnectorOriginationResponseTypeDef: # (2)
...# put_voice_connector_origination method usage example with argument unpacking
kwargs: PutVoiceConnectorOriginationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"Origination": ...,
}
parent.put_voice_connector_origination(**kwargs)put_voice_connector_proxy#
Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").put_voice_connector_proxy method.
boto3 documentation
# put_voice_connector_proxy method definition
def put_voice_connector_proxy(
self,
*,
VoiceConnectorId: str,
DefaultSessionExpiryMinutes: int,
PhoneNumberPoolCountries: Sequence[str],
FallBackPhoneNumber: str = ...,
Disabled: bool = ...,
) -> PutVoiceConnectorProxyResponseTypeDef: # (1)
...# put_voice_connector_proxy method usage example with argument unpacking
kwargs: PutVoiceConnectorProxyRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"DefaultSessionExpiryMinutes": ...,
"PhoneNumberPoolCountries": ...,
}
parent.put_voice_connector_proxy(**kwargs)put_voice_connector_streaming_configuration#
Updates a Voice Connector's streaming configuration settings.
Type annotations and code completion for boto3.client("chime-sdk-voice").put_voice_connector_streaming_configuration method.
boto3 documentation
# put_voice_connector_streaming_configuration method definition
def put_voice_connector_streaming_configuration(
self,
*,
VoiceConnectorId: str,
StreamingConfiguration: StreamingConfigurationTypeDef, # (1)
) -> PutVoiceConnectorStreamingConfigurationResponseTypeDef: # (2)
...# put_voice_connector_streaming_configuration method usage example with argument unpacking
kwargs: PutVoiceConnectorStreamingConfigurationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"StreamingConfiguration": ...,
}
parent.put_voice_connector_streaming_configuration(**kwargs)put_voice_connector_termination#
Updates a Voice Connector's termination settings.
Type annotations and code completion for boto3.client("chime-sdk-voice").put_voice_connector_termination method.
boto3 documentation
# put_voice_connector_termination method definition
def put_voice_connector_termination(
self,
*,
VoiceConnectorId: str,
Termination: TerminationTypeDef, # (1)
) -> PutVoiceConnectorTerminationResponseTypeDef: # (2)
...# put_voice_connector_termination method usage example with argument unpacking
kwargs: PutVoiceConnectorTerminationRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"Termination": ...,
}
parent.put_voice_connector_termination(**kwargs)put_voice_connector_termination_credentials#
Updates a Voice Connector's termination credentials.
Type annotations and code completion for boto3.client("chime-sdk-voice").put_voice_connector_termination_credentials method.
boto3 documentation
# put_voice_connector_termination_credentials method definition
def put_voice_connector_termination_credentials(
self,
*,
VoiceConnectorId: str,
Credentials: Sequence[CredentialTypeDef] = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# put_voice_connector_termination_credentials method usage example with argument unpacking
kwargs: PutVoiceConnectorTerminationCredentialsRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
}
parent.put_voice_connector_termination_credentials(**kwargs)restore_phone_number#
Restores a deleted phone number.
Type annotations and code completion for boto3.client("chime-sdk-voice").restore_phone_number method.
boto3 documentation
# restore_phone_number method definition
def restore_phone_number(
self,
*,
PhoneNumberId: str,
) -> RestorePhoneNumberResponseTypeDef: # (1)
...# restore_phone_number method usage example with argument unpacking
kwargs: RestorePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.restore_phone_number(**kwargs)search_available_phone_numbers#
Searches the provisioned phone numbers in an organization.
Type annotations and code completion for boto3.client("chime-sdk-voice").search_available_phone_numbers method.
boto3 documentation
# search_available_phone_numbers method definition
def search_available_phone_numbers(
self,
*,
AreaCode: str = ...,
City: str = ...,
Country: str = ...,
State: str = ...,
TollFreePrefix: str = ...,
PhoneNumberType: PhoneNumberTypeType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> SearchAvailablePhoneNumbersResponseTypeDef: # (2)
...# search_available_phone_numbers method usage example with argument unpacking
kwargs: SearchAvailablePhoneNumbersRequestRequestTypeDef = { # (1)
"AreaCode": ...,
}
parent.search_available_phone_numbers(**kwargs)start_speaker_search_task#
Starts a speaker search task.
Type annotations and code completion for boto3.client("chime-sdk-voice").start_speaker_search_task method.
boto3 documentation
# start_speaker_search_task method definition
def start_speaker_search_task(
self,
*,
VoiceConnectorId: str,
TransactionId: str,
VoiceProfileDomainId: str,
ClientRequestToken: str = ...,
CallLeg: CallLegTypeType = ..., # (1)
) -> StartSpeakerSearchTaskResponseTypeDef: # (2)
...# start_speaker_search_task method usage example with argument unpacking
kwargs: StartSpeakerSearchTaskRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"TransactionId": ...,
"VoiceProfileDomainId": ...,
}
parent.start_speaker_search_task(**kwargs)start_voice_tone_analysis_task#
Starts a voice tone analysis task.
Type annotations and code completion for boto3.client("chime-sdk-voice").start_voice_tone_analysis_task method.
boto3 documentation
# start_voice_tone_analysis_task method definition
def start_voice_tone_analysis_task(
self,
*,
VoiceConnectorId: str,
TransactionId: str,
LanguageCode: LanguageCodeType, # (1)
ClientRequestToken: str = ...,
) -> StartVoiceToneAnalysisTaskResponseTypeDef: # (2)
...# start_voice_tone_analysis_task method usage example with argument unpacking
kwargs: StartVoiceToneAnalysisTaskRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"TransactionId": ...,
"LanguageCode": ...,
}
parent.start_voice_tone_analysis_task(**kwargs)stop_speaker_search_task#
Stops a speaker search task.
Type annotations and code completion for boto3.client("chime-sdk-voice").stop_speaker_search_task method.
boto3 documentation
# stop_speaker_search_task method definition
def stop_speaker_search_task(
self,
*,
VoiceConnectorId: str,
SpeakerSearchTaskId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# stop_speaker_search_task method usage example with argument unpacking
kwargs: StopSpeakerSearchTaskRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"SpeakerSearchTaskId": ...,
}
parent.stop_speaker_search_task(**kwargs)stop_voice_tone_analysis_task#
Stops a voice tone analysis task.
Type annotations and code completion for boto3.client("chime-sdk-voice").stop_voice_tone_analysis_task method.
boto3 documentation
# stop_voice_tone_analysis_task method definition
def stop_voice_tone_analysis_task(
self,
*,
VoiceConnectorId: str,
VoiceToneAnalysisTaskId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# stop_voice_tone_analysis_task method usage example with argument unpacking
kwargs: StopVoiceToneAnalysisTaskRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"VoiceToneAnalysisTaskId": ...,
}
parent.stop_voice_tone_analysis_task(**kwargs)tag_resource#
Adds a tag to the specified resource.
Type annotations and code completion for boto3.client("chime-sdk-voice").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes tags from a resource.
Type annotations and code completion for boto3.client("chime-sdk-voice").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)update_global_settings#
Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_global_settings method.
boto3 documentation
# update_global_settings method definition
def update_global_settings(
self,
*,
VoiceConnector: VoiceConnectorSettingsTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_global_settings method usage example with argument unpacking
kwargs: UpdateGlobalSettingsRequestRequestTypeDef = { # (1)
"VoiceConnector": ...,
}
parent.update_global_settings(**kwargs)update_phone_number#
Updates phone number details, such as product type, calling name, or phone number name for the specified phone number ID.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_phone_number method.
boto3 documentation
# update_phone_number method definition
def update_phone_number(
self,
*,
PhoneNumberId: str,
ProductType: PhoneNumberProductTypeType = ..., # (1)
CallingName: str = ...,
Name: str = ...,
) -> UpdatePhoneNumberResponseTypeDef: # (2)
...# update_phone_number method usage example with argument unpacking
kwargs: UpdatePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.update_phone_number(**kwargs)update_phone_number_settings#
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_phone_number_settings method.
boto3 documentation
# update_phone_number_settings method definition
def update_phone_number_settings(
self,
*,
CallingName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_phone_number_settings method usage example with argument unpacking
kwargs: UpdatePhoneNumberSettingsRequestRequestTypeDef = { # (1)
"CallingName": ...,
}
parent.update_phone_number_settings(**kwargs)update_proxy_session#
Updates the specified proxy session details, such as voice or SMS capabilities.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_proxy_session method.
boto3 documentation
# update_proxy_session method definition
def update_proxy_session(
self,
*,
VoiceConnectorId: str,
ProxySessionId: str,
Capabilities: Sequence[CapabilityType], # (1)
ExpiryMinutes: int = ...,
) -> UpdateProxySessionResponseTypeDef: # (2)
...# update_proxy_session method usage example with argument unpacking
kwargs: UpdateProxySessionRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"ProxySessionId": ...,
"Capabilities": ...,
}
parent.update_proxy_session(**kwargs)update_sip_media_application#
Updates the details of the specified SIP media application.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_sip_media_application method.
boto3 documentation
# update_sip_media_application method definition
def update_sip_media_application(
self,
*,
SipMediaApplicationId: str,
Name: str = ...,
Endpoints: Sequence[SipMediaApplicationEndpointTypeDef] = ..., # (1)
) -> UpdateSipMediaApplicationResponseTypeDef: # (2)
...# update_sip_media_application method usage example with argument unpacking
kwargs: UpdateSipMediaApplicationRequestRequestTypeDef = { # (1)
"SipMediaApplicationId": ...,
}
parent.update_sip_media_application(**kwargs)update_sip_media_application_call#
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_sip_media_application_call method.
boto3 documentation
# update_sip_media_application_call method definition
def update_sip_media_application_call(
self,
*,
SipMediaApplicationId: str,
TransactionId: str,
Arguments: Mapping[str, str],
) -> UpdateSipMediaApplicationCallResponseTypeDef: # (1)
...# update_sip_media_application_call method usage example with argument unpacking
kwargs: UpdateSipMediaApplicationCallRequestRequestTypeDef = { # (1)
"SipMediaApplicationId": ...,
"TransactionId": ...,
"Arguments": ...,
}
parent.update_sip_media_application_call(**kwargs)update_sip_rule#
Updates the details of the specified SIP rule.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_sip_rule method.
boto3 documentation
# update_sip_rule method definition
def update_sip_rule(
self,
*,
SipRuleId: str,
Name: str,
Disabled: bool = ...,
TargetApplications: Sequence[SipRuleTargetApplicationTypeDef] = ..., # (1)
) -> UpdateSipRuleResponseTypeDef: # (2)
...# update_sip_rule method usage example with argument unpacking
kwargs: UpdateSipRuleRequestRequestTypeDef = { # (1)
"SipRuleId": ...,
"Name": ...,
}
parent.update_sip_rule(**kwargs)update_voice_connector#
Updates the details for the specified Amazon Chime SDK Voice Connector.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_voice_connector method.
boto3 documentation
# update_voice_connector method definition
def update_voice_connector(
self,
*,
VoiceConnectorId: str,
Name: str,
RequireEncryption: bool,
) -> UpdateVoiceConnectorResponseTypeDef: # (1)
...# update_voice_connector method usage example with argument unpacking
kwargs: UpdateVoiceConnectorRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"Name": ...,
"RequireEncryption": ...,
}
parent.update_voice_connector(**kwargs)update_voice_connector_group#
Updates the settings for the specified Amazon Chime SDK Voice Connector group.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_voice_connector_group method.
boto3 documentation
# update_voice_connector_group method definition
def update_voice_connector_group(
self,
*,
VoiceConnectorGroupId: str,
Name: str,
VoiceConnectorItems: Sequence[VoiceConnectorItemTypeDef], # (1)
) -> UpdateVoiceConnectorGroupResponseTypeDef: # (2)
...# update_voice_connector_group method usage example with argument unpacking
kwargs: UpdateVoiceConnectorGroupRequestRequestTypeDef = { # (1)
"VoiceConnectorGroupId": ...,
"Name": ...,
"VoiceConnectorItems": ...,
}
parent.update_voice_connector_group(**kwargs)update_voice_profile#
Updates the specified voice profile's voice print and refreshes its expiration timestamp.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_voice_profile method.
boto3 documentation
# update_voice_profile method definition
def update_voice_profile(
self,
*,
VoiceProfileId: str,
SpeakerSearchTaskId: str,
) -> UpdateVoiceProfileResponseTypeDef: # (1)
...# update_voice_profile method usage example with argument unpacking
kwargs: UpdateVoiceProfileRequestRequestTypeDef = { # (1)
"VoiceProfileId": ...,
"SpeakerSearchTaskId": ...,
}
parent.update_voice_profile(**kwargs)update_voice_profile_domain#
Updates the settings for the specified voice profile domain.
Type annotations and code completion for boto3.client("chime-sdk-voice").update_voice_profile_domain method.
boto3 documentation
# update_voice_profile_domain method definition
def update_voice_profile_domain(
self,
*,
VoiceProfileDomainId: str,
Name: str = ...,
Description: str = ...,
) -> UpdateVoiceProfileDomainResponseTypeDef: # (1)
...# update_voice_profile_domain method usage example with argument unpacking
kwargs: UpdateVoiceProfileDomainRequestRequestTypeDef = { # (1)
"VoiceProfileDomainId": ...,
}
parent.update_voice_profile_domain(**kwargs)validate_e911_address#
Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors.
Type annotations and code completion for boto3.client("chime-sdk-voice").validate_e911_address method.
boto3 documentation
# validate_e911_address method definition
def validate_e911_address(
self,
*,
AwsAccountId: str,
StreetNumber: str,
StreetInfo: str,
City: str,
State: str,
Country: str,
PostalCode: str,
) -> ValidateE911AddressResponseTypeDef: # (1)
...# validate_e911_address method usage example with argument unpacking
kwargs: ValidateE911AddressRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"StreetNumber": ...,
"StreetInfo": ...,
"City": ...,
"State": ...,
"Country": ...,
"PostalCode": ...,
}
parent.validate_e911_address(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("chime-sdk-voice").get_paginator method with overloads.
client.get_paginator("list_sip_media_applications")-> ListSipMediaApplicationsPaginatorclient.get_paginator("list_sip_rules")-> ListSipRulesPaginator