PinpointSMSVoiceClient#
Index > PinpointSMSVoice > PinpointSMSVoiceClient
Auto-generated documentation for PinpointSMSVoice type annotations stubs module types-aiobotocore-pinpoint-sms-voice.
PinpointSMSVoiceClient#
Type annotations and code completion for session.client("pinpoint-sms-voice")
boto3 documentation
# PinpointSMSVoiceClient usage example
from aioboto3.session import Session
from types_aiobotocore_pinpoint_sms_voice.client import PinpointSMSVoiceClient
session = Session()
async with session.client("pinpoint-sms-voice") as client:
client: PinpointSMSVoiceClient
Exceptions#
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("pinpoint-sms-voice").exceptions
structure.
# PinpointSMSVoiceClient.exceptions usage example
async with session.client("pinpoint-sms-voice") as client:
try:
do_something(client)
except (
client.exceptions.AlreadyExistsException,
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.InternalServiceErrorException,
client.exceptions.LimitExceededException,
client.exceptions.NotFoundException,
client.exceptions.TooManyRequestsException,
) as e:
print(e)
# PinpointSMSVoiceClient.exceptions type checking example
from types_aiobotocore_pinpoint_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("pinpoint-sms-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 session.client("pinpoint-sms-voice").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_configuration_set#
Create a new configuration set.
Type annotations and code completion for session.client("pinpoint-sms-voice").create_configuration_set
method.
boto3 documentation
# create_configuration_set method definition
await def create_configuration_set(
self,
*,
ConfigurationSetName: str = ...,
) -> Dict[str, Any]:
...
# create_configuration_set method usage example with argument unpacking
kwargs: CreateConfigurationSetRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.create_configuration_set(**kwargs)
create_configuration_set_event_destination#
Create a new event destination in a configuration set.
Type annotations and code completion for session.client("pinpoint-sms-voice").create_configuration_set_event_destination
method.
boto3 documentation
# create_configuration_set_event_destination method definition
await def create_configuration_set_event_destination(
self,
*,
ConfigurationSetName: str,
EventDestination: EventDestinationDefinitionTypeDef = ..., # (1)
EventDestinationName: str = ...,
) -> Dict[str, Any]:
...
# create_configuration_set_event_destination method usage example with argument unpacking
kwargs: CreateConfigurationSetEventDestinationRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.create_configuration_set_event_destination(**kwargs)
delete_configuration_set#
Deletes an existing configuration set.
Type annotations and code completion for session.client("pinpoint-sms-voice").delete_configuration_set
method.
boto3 documentation
# delete_configuration_set method definition
await def delete_configuration_set(
self,
*,
ConfigurationSetName: str,
) -> Dict[str, Any]:
...
# delete_configuration_set method usage example with argument unpacking
kwargs: DeleteConfigurationSetRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.delete_configuration_set(**kwargs)
delete_configuration_set_event_destination#
Deletes an event destination in a configuration set.
Type annotations and code completion for session.client("pinpoint-sms-voice").delete_configuration_set_event_destination
method.
boto3 documentation
# delete_configuration_set_event_destination method definition
await def delete_configuration_set_event_destination(
self,
*,
ConfigurationSetName: str,
EventDestinationName: str,
) -> Dict[str, Any]:
...
# delete_configuration_set_event_destination method usage example with argument unpacking
kwargs: DeleteConfigurationSetEventDestinationRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"EventDestinationName": ...,
}
parent.delete_configuration_set_event_destination(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("pinpoint-sms-voice").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url 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("pinpoint-sms-voice").get_configuration_set_event_destinations
method.
boto3 documentation
# get_configuration_set_event_destinations method definition
await def get_configuration_set_event_destinations(
self,
*,
ConfigurationSetName: str,
) -> GetConfigurationSetEventDestinationsResponseTypeDef: # (1)
...
# get_configuration_set_event_destinations method usage example with argument unpacking
kwargs: GetConfigurationSetEventDestinationsRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.get_configuration_set_event_destinations(**kwargs)
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("pinpoint-sms-voice").send_voice_message
method.
boto3 documentation
# send_voice_message method definition
await def send_voice_message(
self,
*,
CallerId: str = ...,
ConfigurationSetName: str = ...,
Content: VoiceMessageContentTypeDef = ..., # (1)
DestinationPhoneNumber: str = ...,
OriginationPhoneNumber: str = ...,
) -> SendVoiceMessageResponseTypeDef: # (2)
...
# send_voice_message method usage example with argument unpacking
kwargs: SendVoiceMessageRequestRequestTypeDef = { # (1)
"CallerId": ...,
}
parent.send_voice_message(**kwargs)
update_configuration_set_event_destination#
Update an event destination in a configuration set.
Type annotations and code completion for session.client("pinpoint-sms-voice").update_configuration_set_event_destination
method.
boto3 documentation
# update_configuration_set_event_destination method definition
await def update_configuration_set_event_destination(
self,
*,
ConfigurationSetName: str,
EventDestinationName: str,
EventDestination: EventDestinationDefinitionTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
# update_configuration_set_event_destination method usage example with argument unpacking
kwargs: UpdateConfigurationSetEventDestinationRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"EventDestinationName": ...,
}
parent.update_configuration_set_event_destination(**kwargs)
__aenter__#
Type annotations and code completion for session.client("pinpoint-sms-voice").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> PinpointSMSVoiceClient:
...
__aexit__#
Type annotations and code completion for session.client("pinpoint-sms-voice").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...