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

associate_protect_configuration#

Associate a protect configuration with a configuration set.

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

# associate_protect_configuration method definition

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

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

parent.associate_protect_configuration(**kwargs)
  1. See AssociateProtectConfigurationRequestRequestTypeDef

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