PinpointSMSVoiceClient#
Index > PinpointSMSVoice > PinpointSMSVoiceClient
Auto-generated documentation for PinpointSMSVoice type annotations stubs module mypy-boto3-sms-voice.
PinpointSMSVoiceClient#
Type annotations and code completion for boto3.client("sms-voice").
boto3 documentation
# PinpointSMSVoiceClient usage example
from boto3.session import Session
from mypy_boto3_sms_voice.client import PinpointSMSVoiceClient
def get_sms-voice_client() -> PinpointSMSVoiceClient:
return Session().client("sms-voice")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("sms-voice").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("sms-voice")
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)# Exceptions.exceptions type checking example
from mypy_boto3_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 boto3.client("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 boto3.client("sms-voice").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_configuration_set#
Create a new configuration set.
Type annotations and code completion for boto3.client("sms-voice").create_configuration_set method.
boto3 documentation
# create_configuration_set method definition
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 boto3.client("sms-voice").create_configuration_set_event_destination method.
boto3 documentation
# create_configuration_set_event_destination method definition
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 boto3.client("sms-voice").delete_configuration_set method.
boto3 documentation
# delete_configuration_set method definition
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 boto3.client("sms-voice").delete_configuration_set_event_destination method.
boto3 documentation
# delete_configuration_set_event_destination method definition
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 boto3.client("sms-voice").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_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 boto3.client("sms-voice").get_configuration_set_event_destinations method.
boto3 documentation
# get_configuration_set_event_destinations method definition
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)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 boto3.client("sms-voice").list_configuration_sets method.
boto3 documentation
# list_configuration_sets method definition
def list_configuration_sets(
self,
*,
NextToken: str = ...,
PageSize: str = ...,
) -> ListConfigurationSetsResponseTypeDef: # (1)
...# list_configuration_sets method usage example with argument unpacking
kwargs: ListConfigurationSetsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_configuration_sets(**kwargs)send_voice_message#
Create a new voice message and send it to a recipient's phone number.
Type annotations and code completion for boto3.client("sms-voice").send_voice_message method.
boto3 documentation
# send_voice_message method definition
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 boto3.client("sms-voice").update_configuration_set_event_destination method.
boto3 documentation
# update_configuration_set_event_destination method definition
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)