Skip to content

PinpointSMSVoiceV2Client#

Index > PinpointSMSVoiceV2 > PinpointSMSVoiceV2Client

Auto-generated documentation for PinpointSMSVoiceV2 type annotations stubs module mypy-boto3-pinpoint-sms-voice-v2.

PinpointSMSVoiceV2Client#

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

# PinpointSMSVoiceV2Client usage example

from boto3.session import Session
from mypy_boto3_pinpoint_sms_voice_v2.client import PinpointSMSVoiceV2Client

def get_pinpoint-sms-voice-v2_client() -> PinpointSMSVoiceV2Client:
    return Session().client("pinpoint-sms-voice-v2")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("pinpoint-sms-voice-v2")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_pinpoint_sms_voice_v2.client import Exceptions

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

Methods#

associate_origination_identity#

Associates the specified origination identity with a pool.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").associate_origination_identity method. boto3 documentation

# associate_origination_identity method definition

def associate_origination_identity(
    self,
    *,
    PoolId: str,
    OriginationIdentity: str,
    IsoCountryCode: str,
    ClientToken: str = ...,
) -> AssociateOriginationIdentityResultTypeDef:  # (1)
    ...
  1. See AssociateOriginationIdentityResultTypeDef 
# associate_origination_identity method usage example with argument unpacking

kwargs: AssociateOriginationIdentityRequestRequestTypeDef = {  # (1)
    "PoolId": ...,
    "OriginationIdentity": ...,
    "IsoCountryCode": ...,
}

parent.associate_origination_identity(**kwargs)
  1. See AssociateOriginationIdentityRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").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("pinpoint-sms-voice-v2").close method. boto3 documentation

# close method definition

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

create_configuration_set#

Creates a new configuration set.

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

# create_configuration_set method definition

def create_configuration_set(
    self,
    *,
    ConfigurationSetName: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    ClientToken: str = ...,
) -> CreateConfigurationSetResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateConfigurationSetResultTypeDef 
# create_configuration_set method usage example with argument unpacking

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

parent.create_configuration_set(**kwargs)
  1. See CreateConfigurationSetRequestRequestTypeDef

create_event_destination#

Creates a new event destination in a configuration set.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").create_event_destination method. boto3 documentation

# create_event_destination method definition

def create_event_destination(
    self,
    *,
    ConfigurationSetName: str,
    EventDestinationName: str,
    MatchingEventTypes: Sequence[EventTypeType],  # (1)
    CloudWatchLogsDestination: CloudWatchLogsDestinationTypeDef = ...,  # (2)
    KinesisFirehoseDestination: KinesisFirehoseDestinationTypeDef = ...,  # (3)
    SnsDestination: SnsDestinationTypeDef = ...,  # (4)
    ClientToken: str = ...,
) -> CreateEventDestinationResultTypeDef:  # (5)
    ...
  1. See EventTypeType
  2. See CloudWatchLogsDestinationTypeDef
  3. See KinesisFirehoseDestinationTypeDef
  4. See SnsDestinationTypeDef
  5. See CreateEventDestinationResultTypeDef 
# create_event_destination method usage example with argument unpacking

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

parent.create_event_destination(**kwargs)
  1. See CreateEventDestinationRequestRequestTypeDef

create_opt_out_list#

Creates a new opt-out list.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").create_opt_out_list method. boto3 documentation

# create_opt_out_list method definition

def create_opt_out_list(
    self,
    *,
    OptOutListName: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    ClientToken: str = ...,
) -> CreateOptOutListResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateOptOutListResultTypeDef 
# create_opt_out_list method usage example with argument unpacking

kwargs: CreateOptOutListRequestRequestTypeDef = {  # (1)
    "OptOutListName": ...,
}

parent.create_opt_out_list(**kwargs)
  1. See CreateOptOutListRequestRequestTypeDef

create_pool#

Creates a new pool and associates the specified origination identity to the pool.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").create_pool method. boto3 documentation

# create_pool method definition

def create_pool(
    self,
    *,
    OriginationIdentity: str,
    IsoCountryCode: str,
    MessageType: MessageTypeType,  # (1)
    DeletionProtectionEnabled: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ClientToken: str = ...,
) -> CreatePoolResultTypeDef:  # (3)
    ...
  1. See MessageTypeType
  2. See TagTypeDef
  3. See CreatePoolResultTypeDef 
# create_pool method usage example with argument unpacking

kwargs: CreatePoolRequestRequestTypeDef = {  # (1)
    "OriginationIdentity": ...,
    "IsoCountryCode": ...,
    "MessageType": ...,
}

parent.create_pool(**kwargs)
  1. See CreatePoolRequestRequestTypeDef

create_registration#

Creates a new registration based on the RegistrationType field.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").create_registration method. boto3 documentation

# create_registration method definition

def create_registration(
    self,
    *,
    RegistrationType: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    ClientToken: str = ...,
) -> CreateRegistrationResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateRegistrationResultTypeDef 
# create_registration method usage example with argument unpacking

kwargs: CreateRegistrationRequestRequestTypeDef = {  # (1)
    "RegistrationType": ...,
}

parent.create_registration(**kwargs)
  1. See CreateRegistrationRequestRequestTypeDef

create_registration_association#

Associate the registration with an origination identity such as a phone number or sender ID.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").create_registration_association method. boto3 documentation

# create_registration_association method definition

def create_registration_association(
    self,
    *,
    RegistrationId: str,
    ResourceId: str,
) -> CreateRegistrationAssociationResultTypeDef:  # (1)
    ...
  1. See CreateRegistrationAssociationResultTypeDef 
# create_registration_association method usage example with argument unpacking

kwargs: CreateRegistrationAssociationRequestRequestTypeDef = {  # (1)
    "RegistrationId": ...,
    "ResourceId": ...,
}

parent.create_registration_association(**kwargs)
  1. See CreateRegistrationAssociationRequestRequestTypeDef

create_registration_attachment#

Create a new registration attachment to use for uploading a file or a URL to a file.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").create_registration_attachment method. boto3 documentation

# create_registration_attachment method definition

def create_registration_attachment(
    self,
    *,
    AttachmentBody: Union[str, bytes, IO[Any], StreamingBody] = ...,
    AttachmentUrl: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    ClientToken: str = ...,
) -> CreateRegistrationAttachmentResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateRegistrationAttachmentResultTypeDef 
# create_registration_attachment method usage example with argument unpacking

kwargs: CreateRegistrationAttachmentRequestRequestTypeDef = {  # (1)
    "AttachmentBody": ...,
}

parent.create_registration_attachment(**kwargs)
  1. See CreateRegistrationAttachmentRequestRequestTypeDef

create_registration_version#

Create a new version of the registration and increase the VersionNumber.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").create_registration_version method. boto3 documentation

# create_registration_version method definition

def create_registration_version(
    self,
    *,
    RegistrationId: str,
) -> CreateRegistrationVersionResultTypeDef:  # (1)
    ...
  1. See CreateRegistrationVersionResultTypeDef 
# create_registration_version method usage example with argument unpacking

kwargs: CreateRegistrationVersionRequestRequestTypeDef = {  # (1)
    "RegistrationId": ...,
}

parent.create_registration_version(**kwargs)
  1. See CreateRegistrationVersionRequestRequestTypeDef

create_verified_destination_number#

You can only send messages to verified destination numbers when your account is in the sandbox.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").create_verified_destination_number method. boto3 documentation

# create_verified_destination_number method definition

def create_verified_destination_number(
    self,
    *,
    DestinationPhoneNumber: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    ClientToken: str = ...,
) -> CreateVerifiedDestinationNumberResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateVerifiedDestinationNumberResultTypeDef 
# create_verified_destination_number method usage example with argument unpacking

kwargs: CreateVerifiedDestinationNumberRequestRequestTypeDef = {  # (1)
    "DestinationPhoneNumber": ...,
}

parent.create_verified_destination_number(**kwargs)
  1. See CreateVerifiedDestinationNumberRequestRequestTypeDef

delete_configuration_set#

Deletes an existing configuration set.

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

# delete_configuration_set method definition

def delete_configuration_set(
    self,
    *,
    ConfigurationSetName: str,
) -> DeleteConfigurationSetResultTypeDef:  # (1)
    ...
  1. See DeleteConfigurationSetResultTypeDef 
# delete_configuration_set method usage example with argument unpacking

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

parent.delete_configuration_set(**kwargs)
  1. See DeleteConfigurationSetRequestRequestTypeDef

delete_default_message_type#

Deletes an existing default message type on a configuration set.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").delete_default_message_type method. boto3 documentation

# delete_default_message_type method definition

def delete_default_message_type(
    self,
    *,
    ConfigurationSetName: str,
) -> DeleteDefaultMessageTypeResultTypeDef:  # (1)
    ...
  1. See DeleteDefaultMessageTypeResultTypeDef 
# delete_default_message_type method usage example with argument unpacking

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

parent.delete_default_message_type(**kwargs)
  1. See DeleteDefaultMessageTypeRequestRequestTypeDef

delete_default_sender_id#

Deletes an existing default sender ID on a configuration set.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").delete_default_sender_id method. boto3 documentation

# delete_default_sender_id method definition

def delete_default_sender_id(
    self,
    *,
    ConfigurationSetName: str,
) -> DeleteDefaultSenderIdResultTypeDef:  # (1)
    ...
  1. See DeleteDefaultSenderIdResultTypeDef 
# delete_default_sender_id method usage example with argument unpacking

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

parent.delete_default_sender_id(**kwargs)
  1. See DeleteDefaultSenderIdRequestRequestTypeDef

delete_event_destination#

Deletes an existing event destination.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").delete_event_destination method. boto3 documentation

# delete_event_destination method definition

def delete_event_destination(
    self,
    *,
    ConfigurationSetName: str,
    EventDestinationName: str,
) -> DeleteEventDestinationResultTypeDef:  # (1)
    ...
  1. See DeleteEventDestinationResultTypeDef 
# delete_event_destination method usage example with argument unpacking

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

parent.delete_event_destination(**kwargs)
  1. See DeleteEventDestinationRequestRequestTypeDef

delete_keyword#

Deletes an existing keyword from an origination phone number or pool.

Type annotations and code completion for boto3.client("pinpoint-sms-voice-v2").delete_keyword method.