Skip to content

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)
    ...
  1. See AssociatePhoneNumbersWithVoiceConnectorResponseTypeDef
# 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)
  1. See AssociatePhoneNumbersWithVoiceConnectorRequestRequestTypeDef

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: AssociatePhoneNumbersWithVoiceConnectorGroupRequestRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
    "E164PhoneNumbers": ...,
}

parent.associate_phone_numbers_with_voice_connector_group(**kwargs)
  1. See AssociatePhoneNumbersWithVoiceConnectorGroupRequestRequestTypeDef

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: BatchDeletePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberIds": ...,
}

parent.batch_delete_phone_number(**kwargs)
  1. See BatchDeletePhoneNumberRequestRequestTypeDef

batch_update_phone_number#

Updates one or more phone numbers.

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 UpdatePhoneNumberRequestItemTypeDef
  2. See BatchUpdatePhoneNumberResponseTypeDef
# batch_update_phone_number method usage example with argument unpacking

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

parent.batch_update_phone_number(**kwargs)
  1. See BatchUpdatePhoneNumberRequestRequestTypeDef

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)
    ...
  1. See PhoneNumberProductTypeType
  2. See CreatePhoneNumberOrderResponseTypeDef
# create_phone_number_order method usage example with argument unpacking

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

parent.create_phone_number_order(**kwargs)
  1. See CreatePhoneNumberOrderRequestRequestTypeDef

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 CapabilityType
  2. See NumberSelectionBehaviorType
  3. See GeoMatchLevelType
  4. See GeoMatchParamsTypeDef
  5. See CreateProxySessionResponseTypeDef
# create_proxy_session method usage example with argument unpacking

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

parent.create_proxy_session(**kwargs)
  1. See CreateProxySessionRequestRequestTypeDef

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.