PinpointSMSVoiceClient

Index > PinpointSMSVoice > PinpointSMSVoiceClient

Auto-generated documentation for PinpointSMSVoice type annotations stubs module types-aiobotocore-sms-voice.

PinpointSMSVoiceClient

Type annotations and code completion for session.client("sms-voice") boto3 documentation

Usage example

from aioboto3.session import Session
from types_aiobotocore_sms_voice.client import PinpointSMSVoiceClient

session = Session()
async with session.client("sms-voice") as client:
    client: PinpointSMSVoiceClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("sms-voice").exceptions structure.

Usage example

async with session.client("sms-voice") as client:
    try:
        do_something(client)
    except (
            client.AlreadyExistsException,
        client.BadRequestException,
        client.ClientError,
        client.InternalServiceErrorException,
        client.LimitExceededException,
        client.NotFoundException,
        client.TooManyRequestsException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_sms_voice.client import Exceptions

def handle_error(exc: Exceptions.AlreadyExistsException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.client("sms-voice").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for session.client("sms-voice").close method. boto3 documentation

Method definition

await def close(
    self,
) -> None:
    ...

create_configuration_set

Create a new configuration set.

Type annotations and code completion for session.client("sms-voice").create_configuration_set method. boto3 documentation

Method definition

await def create_configuration_set(
    self,
    *,
    ConfigurationSetName: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: CreateConfigurationSetRequestRequestTypeDef = {  # (1)
    "ConfigurationSetName": ...,
}

parent.create_configuration_set(**kwargs)

1. See CreateConfigurationSetRequestRequestTypeDef

create_configuration_set_event_destination

Create a new event destination in a configuration set.

Type annotations and code completion for session.client("sms-voice").create_configuration_set_event_destination method. boto3 documentation

Method definition

await def create_configuration_set_event_destination(
    self,
    *,
    ConfigurationSetName: str,
    EventDestination: EventDestinationDefinitionTypeDef = ...,  # (1)
    EventDestinationName: str = ...,
) -> Dict[str, Any]:
    ...

1. See EventDestinationDefinitionTypeDef

Usage example with kwargs

kwargs: CreateConfigurationSetEventDestinationRequestRequestTypeDef = {  # (1)
    "ConfigurationSetName": ...,
}

parent.create_configuration_set_event_destination(**kwargs)

1. See CreateConfigurationSetEventDestinationRequestRequestTypeDef

delete_configuration_set

Deletes an existing configuration set.

Type annotations and code completion for session.client("sms-voice").delete_configuration_set method. boto3 documentation

Method definition

await def delete_configuration_set(
    self,
    *,
    ConfigurationSetName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteConfigurationSetRequestRequestTypeDef = {  # (1)
    "ConfigurationSetName": ...,
}

parent.delete_configuration_set(**kwargs)

1. See DeleteConfigurationSetRequestRequestTypeDef

delete_configuration_set_event_destination

Deletes an event destination in a configuration set.

Type annotations and code completion for session.client("sms-voice").delete_configuration_set_event_destination method. boto3 documentation

Method definition

await def delete_configuration_set_event_destination(
    self,
    *,
    ConfigurationSetName: str,
    EventDestinationName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteConfigurationSetEventDestinationRequestRequestTypeDef = {  # (1)
    "ConfigurationSetName": ...,
    "EventDestinationName": ...,
}

parent.delete_configuration_set_event_destination(**kwargs)

1. See DeleteConfigurationSetEventDestinationRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for session.client("sms-voice").generate_presigned_url method. boto3 documentation

Method definition

await def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_configuration_set_event_destinations

Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

Type annotations and code completion for session.client("sms-voice").get_configuration_set_event_destinations method. boto3 documentation

Method definition

await def get_configuration_set_event_destinations(
    self,
    *,
    ConfigurationSetName: str,
) -> GetConfigurationSetEventDestinationsResponseTypeDef:  # (1)
    ...

1. See GetConfigurationSetEventDestinationsResponseTypeDef

Usage example with kwargs

kwargs: GetConfigurationSetEventDestinationsRequestRequestTypeDef = {  # (1)
    "ConfigurationSetName": ...,
}

parent.get_configuration_set_event_destinations(**kwargs)

1. See GetConfigurationSetEventDestinationsRequestRequestTypeDef

list_configuration_sets

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

Type annotations and code completion for session.client("sms-voice").list_configuration_sets method. boto3 documentation

Method definition

await def list_configuration_sets(
    self,
    *,
    NextToken: str = ...,
    PageSize: str = ...,
) -> ListConfigurationSetsResponseTypeDef:  # (1)
    ...

1. See ListConfigurationSetsResponseTypeDef

Usage example with kwargs

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

parent.list_configuration_sets(**kwargs)

1. See ListConfigurationSetsRequestRequestTypeDef

send_voice_message

Create a new voice message and send it to a recipient's phone number.

Type annotations and code completion for session.client("sms-voice").send_voice_message method. boto3 documentation

Method definition

await def send_voice_message(
    self,
    *,
    CallerId: str = ...,
    ConfigurationSetName: str = ...,
    Content: VoiceMessageContentTypeDef = ...,  # (1)
    DestinationPhoneNumber: str = ...,
    OriginationPhoneNumber: str = ...,
) -> SendVoiceMessageResponseTypeDef:  # (2)
    ...

1. See VoiceMessageContentTypeDef
2. See SendVoiceMessageResponseTypeDef

Usage example with kwargs

kwargs: SendVoiceMessageRequestRequestTypeDef = {  # (1)
    "CallerId": ...,
}

parent.send_voice_message(**kwargs)

1. See SendVoiceMessageRequestRequestTypeDef

update_configuration_set_event_destination

Update an event destination in a configuration set.

Type annotations and code completion for session.client("sms-voice").update_configuration_set_event_destination method. boto3 documentation

Method definition

await def update_configuration_set_event_destination(
    self,
    *,
    ConfigurationSetName: str,
    EventDestinationName: str,
    EventDestination: EventDestinationDefinitionTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See EventDestinationDefinitionTypeDef

Usage example with kwargs

kwargs: UpdateConfigurationSetEventDestinationRequestRequestTypeDef = {  # (1)
    "ConfigurationSetName": ...,
    "EventDestinationName": ...,
}

parent.update_configuration_set_event_destination(**kwargs)

1. See UpdateConfigurationSetEventDestinationRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.client("sms-voice").__aenter__ method. boto3 documentation

Method definition

await def __aenter__(
    self,
) -> PinpointSMSVoiceClient:
    ...

__aexit__

Type annotations and code completion for session.client("sms-voice").__aexit__ method. boto3 documentation

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...