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

can_paginate

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:
    ...

generate_presigned_url

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:
    ...

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)
    ...

1. See AssociatePhoneNumbersWithVoiceConnectorResponseTypeDef

# associate_phone_numbers_with_voice_connector method usage example with argument unpacking

kwargs: AssociatePhoneNumbersWithVoiceConnectorRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "E164PhoneNumbers": ...,
}

parent.associate_phone_numbers_with_voice_connector(**kwargs)

1. See AssociatePhoneNumbersWithVoiceConnectorRequestTypeDef

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)
    ...

1. See AssociatePhoneNumbersWithVoiceConnectorGroupResponseTypeDef

# associate_phone_numbers_with_voice_connector_group method usage example with argument unpacking

kwargs: AssociatePhoneNumbersWithVoiceConnectorGroupRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
    "E164PhoneNumbers": ...,
}

parent.associate_phone_numbers_with_voice_connector_group(**kwargs)

1. See AssociatePhoneNumbersWithVoiceConnectorGroupRequestTypeDef

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)
    ...

1. See BatchDeletePhoneNumberResponseTypeDef

# batch_delete_phone_number method usage example with argument unpacking

kwargs: BatchDeletePhoneNumberRequestTypeDef = {  # (1)
    "PhoneNumberIds": ...,
}

parent.batch_delete_phone_number(**kwargs)

1. See BatchDeletePhoneNumberRequestTypeDef

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)
    ...

1. See Sequence[UpdatePhoneNumberRequestItemTypeDef]
2. See BatchUpdatePhoneNumberResponseTypeDef

# batch_update_phone_number method usage example with argument unpacking

kwargs: BatchUpdatePhoneNumberRequestTypeDef = {  # (1)
    "UpdatePhoneNumberRequestItems": ...,
}

parent.batch_update_phone_number(**kwargs)

1. See BatchUpdatePhoneNumberRequestTypeDef

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)
    ...

1. See PhoneNumberProductTypeType
2. See CreatePhoneNumberOrderResponseTypeDef

# create_phone_number_order method usage example with argument unpacking

kwargs: CreatePhoneNumberOrderRequestTypeDef = {  # (1)
    "ProductType": ...,
    "E164PhoneNumbers": ...,
}

parent.create_phone_number_order(**kwargs)

1. See CreatePhoneNumberOrderRequestTypeDef

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)
    ...

1. See Sequence[CapabilityType]
2. See NumberSelectionBehaviorType
3. See GeoMatchLevelType
4. See GeoMatchParamsTypeDef
5. See CreateProxySessionResponseTypeDef

# create_proxy_session method usage example with argument unpacking

kwargs: CreateProxySessionRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "ParticipantPhoneNumbers": ...,
    "Capabilities": ...,
}

parent.create_proxy_session(**kwargs)

1. See CreateProxySessionRequestTypeDef

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)
    ...

1. See Sequence[SipMediaApplicationEndpointTypeDef]
2. See Sequence[TagTypeDef]
3. See CreateSipMediaApplicationResponseTypeDef

# create_sip_media_application method usage example with argument unpacking

kwargs: CreateSipMediaApplicationRequestTypeDef = {  # (1)
    "AwsRegion": ...,
    "Name": ...,
    "Endpoints": ...,
}

parent.create_sip_media_application(**kwargs)

1. See CreateSipMediaApplicationRequestTypeDef

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)
    ...

1. See CreateSipMediaApplicationCallResponseTypeDef

# create_sip_media_application_call method usage example with argument unpacking

kwargs: CreateSipMediaApplicationCallRequestTypeDef = {  # (1)
    "FromPhoneNumber": ...,
    "ToPhoneNumber": ...,
    "SipMediaApplicationId": ...,
}

parent.create_sip_media_application_call(**kwargs)

1. See CreateSipMediaApplicationCallRequestTypeDef

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)
    ...

1. See SipRuleTriggerTypeType
2. See Sequence[SipRuleTargetApplicationTypeDef]
3. See CreateSipRuleResponseTypeDef

# create_sip_rule method usage example with argument unpacking

kwargs: CreateSipRuleRequestTypeDef = {  # (1)
    "Name": ...,
    "TriggerType": ...,
    "TriggerValue": ...,
}

parent.create_sip_rule(**kwargs)

1. See CreateSipRuleRequestTypeDef

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)
    IntegrationType: VoiceConnectorIntegrationTypeType = ...,  # (3)
) -> CreateVoiceConnectorResponseTypeDef:  # (4)
    ...

1. See VoiceConnectorAwsRegionType
2. See Sequence[TagTypeDef]
3. See VoiceConnectorIntegrationTypeType
4. See CreateVoiceConnectorResponseTypeDef

# create_voice_connector method usage example with argument unpacking

kwargs: CreateVoiceConnectorRequestTypeDef = {  # (1)
    "Name": ...,
    "RequireEncryption": ...,
}

parent.create_voice_connector(**kwargs)

1. See CreateVoiceConnectorRequestTypeDef

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)
    ...

1. See Sequence[VoiceConnectorItemTypeDef]
2. See CreateVoiceConnectorGroupResponseTypeDef

# create_voice_connector_group method usage example with argument unpacking

kwargs: CreateVoiceConnectorGroupRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_voice_connector_group(**kwargs)

1. See CreateVoiceConnectorGroupRequestTypeDef

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)
    ...

1. See CreateVoiceProfileResponseTypeDef

# create_voice_profile method usage example with argument unpacking

kwargs: CreateVoiceProfileRequestTypeDef = {  # (1)
    "SpeakerSearchTaskId": ...,
}

parent.create_voice_profile(**kwargs)

1. See CreateVoiceProfileRequestTypeDef

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)
    ...

1. See ServerSideEncryptionConfigurationTypeDef
2. See Sequence[TagTypeDef]
3. See CreateVoiceProfileDomainResponseTypeDef

# create_voice_profile_domain method usage example with argument unpacking

kwargs: CreateVoiceProfileDomainRequestTypeDef = {  # (1)
    "Name": ...,
    "ServerSideEncryptionConfiguration": ...,
}

parent.create_voice_profile_domain(**kwargs)

1. See CreateVoiceProfileDomainRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_phone_number method usage example with argument unpacking

kwargs: DeletePhoneNumberRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.delete_phone_number(**kwargs)

1. See DeletePhoneNumberRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_proxy_session method usage example with argument unpacking

kwargs: DeleteProxySessionRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "ProxySessionId": ...,
}

parent.delete_proxy_session(**kwargs)

1. See DeleteProxySessionRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_sip_media_application method usage example with argument unpacking

kwargs: DeleteSipMediaApplicationRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.delete_sip_media_application(**kwargs)

1. See DeleteSipMediaApplicationRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_sip_rule method usage example with argument unpacking

kwargs: DeleteSipRuleRequestTypeDef = {  # (1)
    "SipRuleId": ...,
}

parent.delete_sip_rule(**kwargs)

1. See DeleteSipRuleRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector method usage example with argument unpacking

kwargs: DeleteVoiceConnectorRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector(**kwargs)

1. See DeleteVoiceConnectorRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_emergency_calling_configuration method usage example with argument unpacking

kwargs: DeleteVoiceConnectorEmergencyCallingConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_emergency_calling_configuration(**kwargs)

1. See DeleteVoiceConnectorEmergencyCallingConfigurationRequestTypeDef

delete_voice_connector_external_systems_configuration

Deletes the external systems configuration for a Voice Connector.

Type annotations and code completion for boto3.client("chime-sdk-voice").delete_voice_connector_external_systems_configuration method. boto3 documentation

# delete_voice_connector_external_systems_configuration method definition

def delete_voice_connector_external_systems_configuration(
    self,
    *,
    VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_external_systems_configuration method usage example with argument unpacking

kwargs: DeleteVoiceConnectorExternalSystemsConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_external_systems_configuration(**kwargs)

1. See DeleteVoiceConnectorExternalSystemsConfigurationRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_group method usage example with argument unpacking

kwargs: DeleteVoiceConnectorGroupRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
}

parent.delete_voice_connector_group(**kwargs)

1. See DeleteVoiceConnectorGroupRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_origination method usage example with argument unpacking

kwargs: DeleteVoiceConnectorOriginationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_origination(**kwargs)

1. See DeleteVoiceConnectorOriginationRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_proxy method usage example with argument unpacking

kwargs: DeleteVoiceConnectorProxyRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_proxy(**kwargs)

1. See DeleteVoiceConnectorProxyRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_streaming_configuration method usage example with argument unpacking

kwargs: DeleteVoiceConnectorStreamingConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_streaming_configuration(**kwargs)

1. See DeleteVoiceConnectorStreamingConfigurationRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_termination method usage example with argument unpacking

kwargs: DeleteVoiceConnectorTerminationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_termination(**kwargs)

1. See DeleteVoiceConnectorTerminationRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_termination_credentials method usage example with argument unpacking

kwargs: DeleteVoiceConnectorTerminationCredentialsRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "Usernames": ...,
}

parent.delete_voice_connector_termination_credentials(**kwargs)

1. See DeleteVoiceConnectorTerminationCredentialsRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_profile method usage example with argument unpacking

kwargs: DeleteVoiceProfileRequestTypeDef = {  # (1)
    "VoiceProfileId": ...,
}

parent.delete_voice_profile(**kwargs)

1. See DeleteVoiceProfileRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_profile_domain method usage example with argument unpacking

kwargs: DeleteVoiceProfileDomainRequestTypeDef = {  # (1)
    "VoiceProfileDomainId": ...,
}

parent.delete_voice_profile_domain(**kwargs)

1. See DeleteVoiceProfileDomainRequestTypeDef

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)
    ...

1. See DisassociatePhoneNumbersFromVoiceConnectorResponseTypeDef

# disassociate_phone_numbers_from_voice_connector method usage example with argument unpacking

kwargs: DisassociatePhoneNumbersFromVoiceConnectorRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "E164PhoneNumbers": ...,
}

parent.disassociate_phone_numbers_from_voice_connector(**kwargs)

1. See DisassociatePhoneNumbersFromVoiceConnectorRequestTypeDef

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)
    ...

1. See DisassociatePhoneNumbersFromVoiceConnectorGroupResponseTypeDef

# disassociate_phone_numbers_from_voice_connector_group method usage example with argument unpacking

kwargs: DisassociatePhoneNumbersFromVoiceConnectorGroupRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
    "E164PhoneNumbers": ...,
}

parent.disassociate_phone_numbers_from_voice_connector_group(**kwargs)

1. See DisassociatePhoneNumbersFromVoiceConnectorGroupRequestTypeDef

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)
    ...

1. See GetGlobalSettingsResponseTypeDef

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)
    ...

1. See GetPhoneNumberResponseTypeDef

# get_phone_number method usage example with argument unpacking

kwargs: GetPhoneNumberRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.get_phone_number(**kwargs)

1. See GetPhoneNumberRequestTypeDef

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)
    ...

1. See GetPhoneNumberOrderResponseTypeDef

# get_phone_number_order method usage example with argument unpacking

kwargs: GetPhoneNumberOrderRequestTypeDef = {  # (1)
    "PhoneNumberOrderId": ...,
}

parent.get_phone_number_order(**kwargs)

1. See GetPhoneNumberOrderRequestTypeDef

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)
    ...

1. See GetPhoneNumberSettingsResponseTypeDef

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)
    ...

1. See GetProxySessionResponseTypeDef

# get_proxy_session method usage example with argument unpacking

kwargs: GetProxySessionRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "ProxySessionId": ...,
}

parent.get_proxy_session(**kwargs)

1. See GetProxySessionRequestTypeDef

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)
    ...

1. See GetSipMediaApplicationResponseTypeDef

# get_sip_media_application method usage example with argument unpacking

kwargs: GetSipMediaApplicationRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.get_sip_media_application(**kwargs)

1. See GetSipMediaApplicationRequestTypeDef

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)
    ...

1. See GetSipMediaApplicationAlexaSkillConfigurationResponseTypeDef

# get_sip_media_application_alexa_skill_configuration method usage example with argument unpacking

kwargs: GetSipMediaApplicationAlexaSkillConfigurationRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.get_sip_media_application_alexa_skill_configuration(**kwargs)

1. See GetSipMediaApplicationAlexaSkillConfigurationRequestTypeDef

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)
    ...

1. See GetSipMediaApplicationLoggingConfigurationResponseTypeDef

# get_sip_media_application_logging_configuration method usage example with argument unpacking

kwargs: GetSipMediaApplicationLoggingConfigurationRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.get_sip_media_application_logging_configuration(**kwargs)

1. See GetSipMediaApplicationLoggingConfigurationRequestTypeDef

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)
    ...

1. See GetSipRuleResponseTypeDef

# get_sip_rule method usage example with argument unpacking

kwargs: GetSipRuleRequestTypeDef = {  # (1)
    "SipRuleId": ...,
}

parent.get_sip_rule(**kwargs)

1. See GetSipRuleRequestTypeDef

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)
    ...

1. See GetSpeakerSearchTaskResponseTypeDef

# get_speaker_search_task method usage example with argument unpacking

kwargs: GetSpeakerSearchTaskRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "SpeakerSearchTaskId": ...,
}

parent.get_speaker_search_task(**kwargs)

1. See GetSpeakerSearchTaskRequestTypeDef

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)
    ...

1. See GetVoiceConnectorResponseTypeDef

# get_voice_connector method usage example with argument unpacking

kwargs: GetVoiceConnectorRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector(**kwargs)

1. See GetVoiceConnectorRequestTypeDef

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)
    ...

1. See GetVoiceConnectorEmergencyCallingConfigurationResponseTypeDef

# get_voice_connector_emergency_calling_configuration method usage example with argument unpacking

kwargs: GetVoiceConnectorEmergencyCallingConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_emergency_calling_configuration(**kwargs)

1. See GetVoiceConnectorEmergencyCallingConfigurationRequestTypeDef

get_voice_connector_external_systems_configuration

Gets information about an external systems configuration for a Voice Connector.

Type annotations and code completion for boto3.client("chime-sdk-voice").get_voice_connector_external_systems_configuration method. boto3 documentation

# get_voice_connector_external_systems_configuration method definition

def get_voice_connector_external_systems_configuration(
    self,
    *,
    VoiceConnectorId: str,
) -> GetVoiceConnectorExternalSystemsConfigurationResponseTypeDef:  # (1)
    ...

1. See GetVoiceConnectorExternalSystemsConfigurationResponseTypeDef

# get_voice_connector_external_systems_configuration method usage example with argument unpacking

kwargs: GetVoiceConnectorExternalSystemsConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_external_systems_configuration(**kwargs)

1. See GetVoiceConnectorExternalSystemsConfigurationRequestTypeDef

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)
    ...

1. See GetVoiceConnectorGroupResponseTypeDef

# get_voice_connector_group method usage example with argument unpacking

kwargs: GetVoiceConnectorGroupRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
}

parent.get_voice_connector_group(**kwargs)

1. See GetVoiceConnectorGroupRequestTypeDef

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)
    ...

1. See GetVoiceConnectorLoggingConfigurationResponseTypeDef

# get_voice_connector_logging_configuration method usage example with argument unpacking

kwargs: GetVoiceConnectorLoggingConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_logging_configuration(**kwargs)

1. See GetVoiceConnectorLoggingConfigurationRequestTypeDef

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)
    ...

1. See GetVoiceConnectorOriginationResponseTypeDef

# get_voice_connector_origination method usage example with argument unpacking

kwargs: GetVoiceConnectorOriginationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_origination(**kwargs)

1. See GetVoiceConnectorOriginationRequestTypeDef

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)
    ...

1. See GetVoiceConnectorProxyResponseTypeDef

# get_voice_connector_proxy method usage example with argument unpacking

kwargs: GetVoiceConnectorProxyRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_proxy(**kwargs)

1. See GetVoiceConnectorProxyRequestTypeDef

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)
    ...

1. See GetVoiceConnectorStreamingConfigurationResponseTypeDef

# get_voice_connector_streaming_configuration method usage example with argument unpacking

kwargs: GetVoiceConnectorStreamingConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_streaming_configuration(**kwargs)

1. See GetVoiceConnectorStreamingConfigurationRequestTypeDef

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)
    ...

1. See GetVoiceConnectorTerminationResponseTypeDef

# get_voice_connector_termination method usage example with argument unpacking

kwargs: GetVoiceConnectorTerminationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_termination(**kwargs)

1. See GetVoiceConnectorTerminationRequestTypeDef

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)
    ...

1. See GetVoiceConnectorTerminationHealthResponseTypeDef

# get_voice_connector_termination_health method usage example with argument unpacking

kwargs: GetVoiceConnectorTerminationHealthRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_termination_health(**kwargs)

1. See GetVoiceConnectorTerminationHealthRequestTypeDef

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)
    ...

1. See GetVoiceProfileResponseTypeDef

# get_voice_profile method usage example with argument unpacking

kwargs: GetVoiceProfileRequestTypeDef = {  # (1)
    "VoiceProfileId": ...,
}

parent.get_voice_profile(**kwargs)

1. See GetVoiceProfileRequestTypeDef

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)
    ...

1. See GetVoiceProfileDomainResponseTypeDef

# get_voice_profile_domain method usage example with argument unpacking

kwargs: GetVoiceProfileDomainRequestTypeDef = {  # (1)
    "VoiceProfileDomainId": ...,
}

parent.get_voice_profile_domain(**kwargs)

1. See GetVoiceProfileDomainRequestTypeDef

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)
    ...

1. See GetVoiceToneAnalysisTaskResponseTypeDef

# get_voice_tone_analysis_task method usage example with argument unpacking

kwargs: GetVoiceToneAnalysisTaskRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "VoiceToneAnalysisTaskId": ...,
    "IsCaller": ...,
}

parent.get_voice_tone_analysis_task(**kwargs)

1. See GetVoiceToneAnalysisTaskRequestTypeDef

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)
    ...

1. See ListAvailableVoiceConnectorRegionsResponseTypeDef

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)
    ...

1. See ListPhoneNumberOrdersResponseTypeDef

# list_phone_number_orders method usage example with argument unpacking

kwargs: ListPhoneNumberOrdersRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_phone_number_orders(**kwargs)

1. See ListPhoneNumberOrdersRequestTypeDef

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)
    ...

1. See PhoneNumberProductTypeType
2. See PhoneNumberAssociationNameType
3. See ListPhoneNumbersResponseTypeDef

# list_phone_numbers method usage example with argument unpacking

kwargs: ListPhoneNumbersRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_phone_numbers(**kwargs)

1. See ListPhoneNumbersRequestTypeDef

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)
    ...

1. See ProxySessionStatusType
2. See ListProxySessionsResponseTypeDef

# list_proxy_sessions method usage example with argument unpacking

kwargs: ListProxySessionsRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.list_proxy_sessions(**kwargs)

1. See ListProxySessionsRequestTypeDef

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)
    ...

1. See ListSipMediaApplicationsResponseTypeDef

# list_sip_media_applications method usage example with argument unpacking

kwargs: ListSipMediaApplicationsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_sip_media_applications(**kwargs)

1. See ListSipMediaApplicationsRequestTypeDef

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)
    ...

1. See ListSipRulesResponseTypeDef

# list_sip_rules method usage example with argument unpacking

kwargs: ListSipRulesRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.list_sip_rules(**kwargs)

1. See ListSipRulesRequestTypeDef

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)
    ...

1. See PhoneNumberProductTypeType
2. See ListSupportedPhoneNumberCountriesResponseTypeDef

# list_supported_phone_number_countries method usage example with argument unpacking

kwargs: ListSupportedPhoneNumberCountriesRequestTypeDef = {  # (1)
    "ProductType": ...,
}

parent.list_supported_phone_number_countries(**kwargs)

1. See ListSupportedPhoneNumberCountriesRequestTypeDef

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)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

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)
    ...

1. See ListVoiceConnectorGroupsResponseTypeDef

# list_voice_connector_groups method usage example with argument unpacking

kwargs: ListVoiceConnectorGroupsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_voice_connector_groups(**kwargs)

1. See ListVoiceConnectorGroupsRequestTypeDef

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)
    ...

1. See ListVoiceConnectorTerminationCredentialsResponseTypeDef

# list_voice_connector_termination_credentials method usage example with argument unpacking

kwargs: ListVoiceConnectorTerminationCredentialsRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.list_voice_connector_termination_credentials(**kwargs)

1. See ListVoiceConnectorTerminationCredentialsRequestTypeDef

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)
    ...

1. See ListVoiceConnectorsResponseTypeDef

# list_voice_connectors method usage example with argument unpacking

kwargs: ListVoiceConnectorsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_voice_connectors(**kwargs)

1. See ListVoiceConnectorsRequestTypeDef

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)
    ...

1. See ListVoiceProfileDomainsResponseTypeDef

# list_voice_profile_domains method usage example with argument unpacking

kwargs: ListVoiceProfileDomainsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_voice_profile_domains(**kwargs)

1. See ListVoiceProfileDomainsRequestTypeDef

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)
    ...

1. See ListVoiceProfilesResponseTypeDef

# list_voice_profiles method usage example with argument unpacking

kwargs: ListVoiceProfilesRequestTypeDef = {  # (1)
    "VoiceProfileDomainId": ...,
}

parent.list_voice_profiles(**kwargs)

1. See ListVoiceProfilesRequestTypeDef

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: SipMediaApplicationAlexaSkillConfigurationUnionTypeDef = ...,  # (1)
) -> PutSipMediaApplicationAlexaSkillConfigurationResponseTypeDef:  # (2)
    ...

1. See SipMediaApplicationAlexaSkillConfigurationUnionTypeDef
2. See PutSipMediaApplicationAlexaSkillConfigurationResponseTypeDef

# put_sip_media_application_alexa_skill_configuration method usage example with argument unpacking

kwargs: PutSipMediaApplicationAlexaSkillConfigurationRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.put_sip_media_application_alexa_skill_configuration(**kwargs)

1. See PutSipMediaApplicationAlexaSkillConfigurationRequestTypeDef

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)
    ...

1. See SipMediaApplicationLoggingConfigurationTypeDef
2. See PutSipMediaApplicationLoggingConfigurationResponseTypeDef

# put_sip_media_application_logging_configuration method usage example with argument unpacking

kwargs: PutSipMediaApplicationLoggingConfigurationRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.put_sip_media_application_logging_configuration(**kwargs)

1. See PutSipMediaApplicationLoggingConfigurationRequestTypeDef

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: EmergencyCallingConfigurationUnionTypeDef,  # (1)
) -> PutVoiceConnectorEmergencyCallingConfigurationResponseTypeDef:  # (2)
    ...

1. See EmergencyCallingConfigurationUnionTypeDef
2. See PutVoiceConnectorEmergencyCallingConfigurationResponseTypeDef

# put_voice_connector_emergency_calling_configuration method usage example with argument unpacking

kwargs: PutVoiceConnectorEmergencyCallingConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "EmergencyCallingConfiguration": ...,
}

parent.put_voice_connector_emergency_calling_configuration(**kwargs)

1. See PutVoiceConnectorEmergencyCallingConfigurationRequestTypeDef

put_voice_connector_external_systems_configuration

Adds an external systems configuration to a Voice Connector.

Type annotations and code completion for boto3.client("chime-sdk-voice").put_voice_connector_external_systems_configuration method. boto3 documentation

# put_voice_connector_external_systems_configuration method definition

def put_voice_connector_external_systems_configuration(
    self,
    *,
    VoiceConnectorId: str,
    SessionBorderControllerTypes: Sequence[SessionBorderControllerTypeType] = ...,  # (1)
    ContactCenterSystemTypes: Sequence[ContactCenterSystemTypeType] = ...,  # (2)
) -> PutVoiceConnectorExternalSystemsConfigurationResponseTypeDef:  # (3)
    ...

1. See Sequence[SessionBorderControllerTypeType]
2. See Sequence[ContactCenterSystemTypeType]
3. See PutVoiceConnectorExternalSystemsConfigurationResponseTypeDef

# put_voice_connector_external_systems_configuration method usage example with argument unpacking

kwargs: PutVoiceConnectorExternalSystemsConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.put_voice_connector_external_systems_configuration(**kwargs)

1. See PutVoiceConnectorExternalSystemsConfigurationRequestTypeDef

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)
    ...

1. See LoggingConfigurationTypeDef
2. See PutVoiceConnectorLoggingConfigurationResponseTypeDef

# put_voice_connector_logging_configuration method usage example with argument unpacking

kwargs: PutVoiceConnectorLoggingConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "LoggingConfiguration": ...,
}

parent.put_voice_connector_logging_configuration(**kwargs)

1. See PutVoiceConnectorLoggingConfigurationRequestTypeDef

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: OriginationUnionTypeDef,  # (1)
) -> PutVoiceConnectorOriginationResponseTypeDef:  # (2)
    ...

1. See OriginationUnionTypeDef
2. See PutVoiceConnectorOriginationResponseTypeDef

# put_voice_connector_origination method usage example with argument unpacking

kwargs: PutVoiceConnectorOriginationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "Origination": ...,
}

parent.put_voice_connector_origination(**kwargs)

1. See PutVoiceConnectorOriginationRequestTypeDef

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)
    ...

1. See PutVoiceConnectorProxyResponseTypeDef

# put_voice_connector_proxy method usage example with argument unpacking

kwargs: PutVoiceConnectorProxyRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "DefaultSessionExpiryMinutes": ...,
    "PhoneNumberPoolCountries": ...,
}

parent.put_voice_connector_proxy(**kwargs)

1. See PutVoiceConnectorProxyRequestTypeDef

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: StreamingConfigurationUnionTypeDef,  # (1)
) -> PutVoiceConnectorStreamingConfigurationResponseTypeDef:  # (2)
    ...

1. See StreamingConfigurationUnionTypeDef
2. See PutVoiceConnectorStreamingConfigurationResponseTypeDef

# put_voice_connector_streaming_configuration method usage example with argument unpacking

kwargs: PutVoiceConnectorStreamingConfigurationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "StreamingConfiguration": ...,
}

parent.put_voice_connector_streaming_configuration(**kwargs)

1. See PutVoiceConnectorStreamingConfigurationRequestTypeDef

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: TerminationUnionTypeDef,  # (1)
) -> PutVoiceConnectorTerminationResponseTypeDef:  # (2)
    ...

1. See TerminationUnionTypeDef
2. See PutVoiceConnectorTerminationResponseTypeDef

# put_voice_connector_termination method usage example with argument unpacking

kwargs: PutVoiceConnectorTerminationRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "Termination": ...,
}

parent.put_voice_connector_termination(**kwargs)

1. See PutVoiceConnectorTerminationRequestTypeDef

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)
    ...

1. See Sequence[CredentialTypeDef]
2. See EmptyResponseMetadataTypeDef

# put_voice_connector_termination_credentials method usage example with argument unpacking

kwargs: PutVoiceConnectorTerminationCredentialsRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.put_voice_connector_termination_credentials(**kwargs)

1. See PutVoiceConnectorTerminationCredentialsRequestTypeDef

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)
    ...

1. See RestorePhoneNumberResponseTypeDef

# restore_phone_number method usage example with argument unpacking

kwargs: RestorePhoneNumberRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.restore_phone_number(**kwargs)

1. See RestorePhoneNumberRequestTypeDef

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)
    ...

1. See PhoneNumberTypeType
2. See SearchAvailablePhoneNumbersResponseTypeDef

# search_available_phone_numbers method usage example with argument unpacking

kwargs: SearchAvailablePhoneNumbersRequestTypeDef = {  # (1)
    "AreaCode": ...,
}

parent.search_available_phone_numbers(**kwargs)

1. See SearchAvailablePhoneNumbersRequestTypeDef

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)
    ...

1. See CallLegTypeType
2. See StartSpeakerSearchTaskResponseTypeDef

# start_speaker_search_task method usage example with argument unpacking

kwargs: StartSpeakerSearchTaskRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "TransactionId": ...,
    "VoiceProfileDomainId": ...,
}

parent.start_speaker_search_task(**kwargs)

1. See StartSpeakerSearchTaskRequestTypeDef

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)
    ...

1. See LanguageCodeType
2. See StartVoiceToneAnalysisTaskResponseTypeDef

# start_voice_tone_analysis_task method usage example with argument unpacking

kwargs: StartVoiceToneAnalysisTaskRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "TransactionId": ...,
    "LanguageCode": ...,
}

parent.start_voice_tone_analysis_task(**kwargs)

1. See StartVoiceToneAnalysisTaskRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_speaker_search_task method usage example with argument unpacking

kwargs: StopSpeakerSearchTaskRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "SpeakerSearchTaskId": ...,
}

parent.stop_speaker_search_task(**kwargs)

1. See StopSpeakerSearchTaskRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_voice_tone_analysis_task method usage example with argument unpacking

kwargs: StopVoiceToneAnalysisTaskRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "VoiceToneAnalysisTaskId": ...,
}

parent.stop_voice_tone_analysis_task(**kwargs)

1. See StopVoiceToneAnalysisTaskRequestTypeDef

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)
    ...

1. See Sequence[TagTypeDef]
2. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

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)
    ...

1. See VoiceConnectorSettingsTypeDef
2. See EmptyResponseMetadataTypeDef

# update_global_settings method usage example with argument unpacking

kwargs: UpdateGlobalSettingsRequestTypeDef = {  # (1)
    "VoiceConnector": ...,
}

parent.update_global_settings(**kwargs)

1. See UpdateGlobalSettingsRequestTypeDef

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)
    ...

1. See PhoneNumberProductTypeType
2. See UpdatePhoneNumberResponseTypeDef

# update_phone_number method usage example with argument unpacking

kwargs: UpdatePhoneNumberRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.update_phone_number(**kwargs)

1. See UpdatePhoneNumberRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# update_phone_number_settings method usage example with argument unpacking

kwargs: UpdatePhoneNumberSettingsRequestTypeDef = {  # (1)
    "CallingName": ...,
}

parent.update_phone_number_settings(**kwargs)

1. See UpdatePhoneNumberSettingsRequestTypeDef

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)
    ...

1. See Sequence[CapabilityType]
2. See UpdateProxySessionResponseTypeDef

# update_proxy_session method usage example with argument unpacking

kwargs: UpdateProxySessionRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "ProxySessionId": ...,
    "Capabilities": ...,
}

parent.update_proxy_session(**kwargs)

1. See UpdateProxySessionRequestTypeDef

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)
    ...

1. See Sequence[SipMediaApplicationEndpointTypeDef]
2. See UpdateSipMediaApplicationResponseTypeDef

# update_sip_media_application method usage example with argument unpacking

kwargs: UpdateSipMediaApplicationRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.update_sip_media_application(**kwargs)

1. See UpdateSipMediaApplicationRequestTypeDef

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)
    ...

1. See UpdateSipMediaApplicationCallResponseTypeDef

# update_sip_media_application_call method usage example with argument unpacking

kwargs: UpdateSipMediaApplicationCallRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
    "TransactionId": ...,
    "Arguments": ...,
}

parent.update_sip_media_application_call(**kwargs)

1. See UpdateSipMediaApplicationCallRequestTypeDef

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)
    ...

1. See Sequence[SipRuleTargetApplicationTypeDef]
2. See UpdateSipRuleResponseTypeDef

# update_sip_rule method usage example with argument unpacking

kwargs: UpdateSipRuleRequestTypeDef = {  # (1)
    "SipRuleId": ...,
    "Name": ...,
}

parent.update_sip_rule(**kwargs)

1. See UpdateSipRuleRequestTypeDef

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)
    ...

1. See UpdateVoiceConnectorResponseTypeDef

# update_voice_connector method usage example with argument unpacking

kwargs: UpdateVoiceConnectorRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "Name": ...,
    "RequireEncryption": ...,
}

parent.update_voice_connector(**kwargs)

1. See UpdateVoiceConnectorRequestTypeDef

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)
    ...

1. See Sequence[VoiceConnectorItemTypeDef]
2. See UpdateVoiceConnectorGroupResponseTypeDef

# update_voice_connector_group method usage example with argument unpacking

kwargs: UpdateVoiceConnectorGroupRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
    "Name": ...,
    "VoiceConnectorItems": ...,
}

parent.update_voice_connector_group(**kwargs)

1. See UpdateVoiceConnectorGroupRequestTypeDef

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)
    ...

1. See UpdateVoiceProfileResponseTypeDef

# update_voice_profile method usage example with argument unpacking

kwargs: UpdateVoiceProfileRequestTypeDef = {  # (1)
    "VoiceProfileId": ...,
    "SpeakerSearchTaskId": ...,
}

parent.update_voice_profile(**kwargs)

1. See UpdateVoiceProfileRequestTypeDef

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)
    ...

1. See UpdateVoiceProfileDomainResponseTypeDef

# update_voice_profile_domain method usage example with argument unpacking

kwargs: UpdateVoiceProfileDomainRequestTypeDef = {  # (1)
    "VoiceProfileDomainId": ...,
}

parent.update_voice_profile_domain(**kwargs)

1. See UpdateVoiceProfileDomainRequestTypeDef

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)
    ...

1. See ValidateE911AddressResponseTypeDef

# validate_e911_address method usage example with argument unpacking

kwargs: ValidateE911AddressRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "StreetNumber": ...,
    "StreetInfo": ...,
    "City": ...,
    "State": ...,
    "Country": ...,
    "PostalCode": ...,
}

parent.validate_e911_address(**kwargs)

1. See ValidateE911AddressRequestTypeDef

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") -> ListSipMediaApplicationsPaginator
• client.get_paginator("list_sip_rules") -> ListSipRulesPaginator