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 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_protect_configuration#

Create a new protect configuration.

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

# create_protect_configuration method definition

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

kwargs: CreateProtectConfigurationRequestRequestTypeDef = {  # (1)
    "ClientToken": ...,
}

parent.create_protect_configuration(**kwargs)
  1. See CreateProtectConfigurationRequestRequestTypeDef

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: BlobTypeDef = ...,
    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_account_default_protect_configuration#

Removes the current account default protect configuration.

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

# delete_account_default_protect_configuration method definition

def delete_account_default_protect_configuration(
    self,
) -> DeleteAccountDefaultProtectConfigurationResultTypeDef:  # (1)
    ...
  1. See DeleteAccountDefaultProtectConfigurationResultTypeDef

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. boto3 documentation

# delete_keyword method definition

def delete_keyword(
    self,
    *,
    OriginationIdentity: str,
    Keyword: str,
) -> DeleteKeywordResultTypeDef:  # (1)
    ...
  1. See DeleteKeywordResultTypeDef 
# delete_keyword method usage example with argument unpacking

kwargs: DeleteKeywordRequestRequestTypeDef = {  # (1)
    "OriginationIdentity": ...,
    "Keyword": ...,
}

parent.delete_keyword(**kwargs)
  1. See DeleteKeywordRequestRequestTypeDef

delete_media_message_spend_limit_override#

Deletes an account-level monthly spending limit override for sending multimedia messages (MMS).

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

# delete_media_message_spend_limit_override method definition

def delete_media_message_spend_limit_override(
    self,
) -> DeleteMediaMessageSpendLimitOverrideResultTypeDef:  # (1)
    ...
  1. See DeleteMediaMessageSpendLimitOverrideResultTypeDef

delete_opt_out_list#

Deletes an existing opt-out list.

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

# delete_opt_out_list method definition

def delete_opt_out_list(
    self,
    *,
    OptOutListName: str,
) -> DeleteOptOutListResultTypeDef:  # (1)
    ...
  1. See DeleteOptOutListResultTypeDef 
# delete_opt_out_list method usage example with argument unpacking

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

parent.delete_opt_out_list(**kwargs)
  1. See DeleteOptOutListRequestRequestTypeDef

delete_opted_out_number#

Deletes an existing opted out destination phone number from the specified opt-out list.

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

# delete_opted_out_number method definition

def delete_opted_out_number(
    self,
    *,
    OptOutListName: str,
    OptedOutNumber: str,
) -> DeleteOptedOutNumberResultTypeDef:  # (1)
    ...
  1. See DeleteOptedOutNumberResultTypeDef 
# delete_opted_out_number method usage example with argument unpacking

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

parent.delete_opted_out_number(**kwargs)
  1. See DeleteOptedOutNumberRequestRequestTypeDef

delete_pool#

Deletes an existing pool.

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

# delete_pool method definition

def delete_pool(
    self,
    *,
    PoolId: str,
) -> DeletePoolResultTypeDef:  # (1)
    ...
  1. See DeletePoolResultTypeDef 
# delete_pool method usage example with argument unpacking

kwargs: DeletePoolRequestRequestTypeDef = {  # (1)
    "PoolId": ...,
}

parent.delete_pool(**kwargs)
  1. See DeletePoolRequestRequestTypeDef

delete_protect_configuration#

Permanently delete the protect configuration.

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

# delete_protect_configuration method definition

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

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

parent.delete_protect_configuration(**kwargs)
  1. See DeleteProtectConfigurationRequestRequestTypeDef

delete_registration#

Permanently delete an existing registration from your account.

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

# delete_registration method definition

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

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

parent.delete_registration(**kwargs)
  1. See DeleteRegistrationRequestRequestTypeDef

delete_registration_attachment#

Permanently delete the specified registration attachment.

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

# delete_registration_attachment method definition

def delete_registration_attachment(
    self,
    *,
    RegistrationAttachmentId: str,
) -> DeleteRegistrationAttachmentResultTypeDef:  # (1)
    ...
  1. See DeleteRegistrationAttachmentResultTypeDef 
# delete_registration_attachment method usage example with argument unpacking

kwargs: DeleteRegistrationAttachmentRequestRequestTypeDef = {  # (1)
    "RegistrationAttachmentId": ...,
}

parent.delete_registration_attachment(**kwargs)
  1. See DeleteRegistrationAttachmentRequestRequestTypeDef

delete_registration_field_value#

Delete the value in a registration form field.

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

# delete_registration_field_value method definition

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

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

parent.delete_registration_field_value(**kwargs)
  1. See DeleteRegistrationFieldValueRequestRequestTypeDef

delete_resource_policy#

Deletes the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource.

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

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> DeleteResourcePolicyResultTypeDef:  # (1)
    ...
  1. See DeleteResourcePolicyResultTypeDef 
# delete_resource_policy method usage example with argument unpacking

kwargs: DeleteResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_resource_policy(**kwargs)
  1. See DeleteResourcePolicyRequestRequestTypeDef

delete_text_message_spend_limit_override#

Deletes an account-level monthly spending limit override for sending text messages.

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

# delete_text_message_spend_limit_override method definition

def delete_text_message_spend_limit_override(
    self,
) -> DeleteTextMessageSpendLimitOverrideResultTypeDef:  # (1)
    ...
  1. See DeleteTextMessageSpendLimitOverrideResultTypeDef

delete_verified_destination_number#

Delete a verified destination phone number.

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

# delete_verified_destination_number method definition

def delete_verified_destination_number(
    self,
    *,
    VerifiedDestinationNumberId: str,
) -> DeleteVerifiedDestinationNumberResultTypeDef:  # (1)
    ...
  1. See DeleteVerifiedDestinationNumberResultTypeDef 
# delete_verified_destination_number method usage example with argument unpacking

kwargs: DeleteVerifiedDestinationNumberRequestRequestTypeDef = {  # (1)
    "VerifiedDestinationNumberId": ...,
}

parent.delete_verified_destination_number(**kwargs)
  1. See DeleteVerifiedDestinationNumberRequestRequestTypeDef

delete_voice_message_spend_limit_override#

Deletes an account level monthly spend limit override for sending voice messages.

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

# delete_voice_message_spend_limit_override method definition

def delete_voice_message_spend_limit_override(
    self,
) -> DeleteVoiceMessageSpendLimitOverrideResultTypeDef:  # (1)
    ...
  1. See DeleteVoiceMessageSpendLimitOverrideResultTypeDef

describe_account_attributes#

Describes attributes of your Amazon Web Services account.

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

# describe_account_attributes method definition

def describe_account_attributes(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeAccountAttributesResultTypeDef:  # (1)
    ...
  1. See DescribeAccountAttributesResultTypeDef 
# describe_account_attributes method usage example with argument unpacking

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

parent.describe_account_attributes(**kwargs)
  1. See DescribeAccountAttributesRequestRequestTypeDef

describe_account_limits#

Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your account.

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

# describe_account_limits method definition

def describe_account_limits(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeAccountLimitsResultTypeDef:  # (1)
    ...
  1. See DescribeAccountLimitsResultTypeDef 
# describe_account_limits method usage example with argument unpacking

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

parent.describe_account_limits(**kwargs)
  1. See DescribeAccountLimitsRequestRequestTypeDef

describe_configuration_sets#

Describes the specified configuration sets or all in your account.

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

# describe_configuration_sets method definition

def describe_configuration_sets(
    self,
    *,
    ConfigurationSetNames: Sequence[str] = ...,
    Filters: Sequence[ConfigurationSetFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeConfigurationSetsResultTypeDef:  # (2)
    ...
  1. See ConfigurationSetFilterTypeDef
  2. See DescribeConfigurationSetsResultTypeDef 
# describe_configuration_sets method usage example with argument unpacking

kwargs: DescribeConfigurationSetsRequestRequestTypeDef = {  # (1)
    "ConfigurationSetNames": ...,
}

parent.describe_configuration_sets(**kwargs)
  1. See DescribeConfigurationSetsRequestRequestTypeDef

describe_keywords#

Describes the specified keywords or all keywords on your origination phone number or pool.

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

# describe_keywords method definition

def describe_keywords(
    self,
    *,
    OriginationIdentity: str,
    Keywords: Sequence[str] = ...,
    Filters: Sequence[KeywordFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeKeywordsResultTypeDef:  # (2)
    ...
  1. See KeywordFilterTypeDef
  2. See DescribeKeywordsResultTypeDef 
# describe_keywords method usage example with argument unpacking

kwargs: DescribeKeywordsRequestRequestTypeDef = {  # (1)
    "OriginationIdentity": ...,
}

parent.describe_keywords(**kwargs)
  1. See DescribeKeywordsRequestRequestTypeDef

describe_opt_out_lists#

Describes the specified opt-out list or all opt-out lists in your account.

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

# describe_opt_out_lists method definition

def describe_opt_out_lists(
    self,
    *,
    OptOutListNames: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    Owner: OwnerType = ...,  # (1)
) -> DescribeOptOutListsResultTypeDef:  # (2)
    ...
  1. See OwnerType
  2. See DescribeOptOutListsResultTypeDef 
# describe_opt_out_lists method usage example with argument unpacking

kwargs: DescribeOptOutListsRequestRequestTypeDef = {  # (1)
    "OptOutListNames": ...,
}

parent.describe_opt_out_lists(**kwargs)
  1. See DescribeOptOutListsRequestRequestTypeDef

describe_opted_out_numbers#

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

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

# describe_opted_out_numbers method definition

def describe_opted_out_numbers(
    self,
    *,
    OptOutListName: str,
    OptedOutNumbers: Sequence[str] = ...,
    Filters: Sequence[OptedOutFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeOptedOutNumbersResultTypeDef:  # (2)
    ...
  1. See OptedOutFilterTypeDef
  2. See DescribeOptedOutNumbersResultTypeDef 
# describe_opted_out_numbers method usage example with argument unpacking

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

parent.describe_opted_out_numbers(**kwargs)
  1. See DescribeOptedOutNumbersRequestRequestTypeDef

describe_phone_numbers#

Describes the specified origination phone number, or all the phone numbers in your account.

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

# describe_phone_numbers method definition

def describe_phone_numbers(
    self,
    *,
    PhoneNumberIds: Sequence[str] = ...,
    Filters: Sequence[PhoneNumberFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    Owner: OwnerType = ...,  # (2)
) -> DescribePhoneNumbersResultTypeDef:  # (3)
    ...
  1. See PhoneNumberFilterTypeDef
  2. See OwnerType
  3. See DescribePhoneNumbersResultTypeDef 
# describe_phone_numbers method usage example with argument unpacking

kwargs: DescribePhoneNumbersRequestRequestTypeDef = {  # (1)
    "PhoneNumberIds": ...,
}

parent.describe_phone_numbers(**kwargs)
  1. See DescribePhoneNumbersRequestRequestTypeDef

describe_pools#

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

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

# describe_pools method definition

def describe_pools(
    self,
    *,
    PoolIds: Sequence[str] = ...,
    Filters: Sequence[PoolFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    Owner: OwnerType = ...,  # (2)
) -> DescribePoolsResultTypeDef:  # (3)
    ...
  1. See PoolFilterTypeDef
  2. See OwnerType
  3. See DescribePoolsResultTypeDef 
# describe_pools method usage example with argument unpacking

kwargs: DescribePoolsRequestRequestTypeDef = {  # (1)
    "PoolIds": ...,
}

parent.describe_pools(**kwargs)
  1. See DescribePoolsRequestRequestTypeDef

describe_protect_configurations#

Retrieves the protect configurations that match any of filters.

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

# describe_protect_configurations method definition

def describe_protect_configurations(
    self,
    *,
    ProtectConfigurationIds: Sequence[str] = ...,
    Filters: Sequence[ProtectConfigurationFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeProtectConfigurationsResultTypeDef:  # (2)
    ...
  1. See ProtectConfigurationFilterTypeDef
  2. See DescribeProtectConfigurationsResultTypeDef 
# describe_protect_configurations method usage example with argument unpacking

kwargs: DescribeProtectConfigurationsRequestRequestTypeDef = {  # (1)
    "ProtectConfigurationIds": ...,
}

parent.describe_protect_configurations(**kwargs)
  1. See DescribeProtectConfigurationsRequestRequestTypeDef

describe_registration_attachments#

Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.

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

# describe_registration_attachments method definition

def describe_registration_attachments(
    self,
    *,
    RegistrationAttachmentIds: Sequence[str] = ...,
    Filters: Sequence[RegistrationAttachmentFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeRegistrationAttachmentsResultTypeDef:  # (2)
    ...
  1. See RegistrationAttachmentFilterTypeDef
  2. See DescribeRegistrationAttachmentsResultTypeDef 
# describe_registration_attachments method usage example with argument unpacking

kwargs: DescribeRegistrationAttachmentsRequestRequestTypeDef = {  # (1)
    "RegistrationAttachmentIds": ...,
}

parent.describe_registration_attachments(**kwargs)
  1. See DescribeRegistrationAttachmentsRequestRequestTypeDef

describe_registration_field_definitions#

Retrieves the specified registration type field definitions.

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

# describe_registration_field_definitions method definition

def describe_registration_field_definitions(
    self,
    *,
    RegistrationType: str,
    SectionPath: str = ...,
    FieldPaths: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeRegistrationFieldDefinitionsResultTypeDef:  # (1)
    ...
  1. See DescribeRegistrationFieldDefinitionsResultTypeDef 
# describe_registration_field_definitions method usage example with argument unpacking

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

parent.describe_registration_field_definitions(**kwargs)
  1. See DescribeRegistrationFieldDefinitionsRequestRequestTypeDef

describe_registration_field_values#

Retrieves the specified registration field values.

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

# describe_registration_field_values method definition

def describe_registration_field_values(
    self,
    *,
    RegistrationId: str,
    VersionNumber: int = ...,
    SectionPath: str = ...,
    FieldPaths: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeRegistrationFieldValuesResultTypeDef:  # (1)
    ...
  1. See DescribeRegistrationFieldValuesResultTypeDef 
# describe_registration_field_values method usage example with argument unpacking

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

parent.describe_registration_field_values(**kwargs)
  1. See DescribeRegistrationFieldValuesRequestRequestTypeDef

describe_registration_section_definitions#

Retrieves the specified registration section definitions.

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

# describe_registration_section_definitions method definition

def describe_registration_section_definitions(
    self,
    *,
    RegistrationType: str,
    SectionPaths: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeRegistrationSectionDefinitionsResultTypeDef:  # (1)
    ...
  1. See DescribeRegistrationSectionDefinitionsResultTypeDef 
# describe_registration_section_definitions method usage example with argument unpacking

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

parent.describe_registration_section_definitions(**kwargs)
  1. See DescribeRegistrationSectionDefinitionsRequestRequestTypeDef

describe_registration_type_definitions#

Retrieves the specified registration type definitions.

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

# describe_registration_type_definitions method definition

def describe_registration_type_definitions(
    self,
    *,
    RegistrationTypes: Sequence[str] = ...,
    Filters: Sequence[RegistrationTypeFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeRegistrationTypeDefinitionsResultTypeDef:  # (2)
    ...
  1. See RegistrationTypeFilterTypeDef
  2. See DescribeRegistrationTypeDefinitionsResultTypeDef 
# describe_registration_type_definitions method usage example with argument unpacking

kwargs: DescribeRegistrationTypeDefinitionsRequestRequestTypeDef = {  # (1)
    "RegistrationTypes": ...,
}

parent.describe_registration_type_definitions(**kwargs)
  1. See DescribeRegistrationTypeDefinitionsRequestRequestTypeDef

describe_registration_versions#

Retrieves the specified registration version.

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

# describe_registration_versions method definition

def describe_registration_versions(
    self,
    *,
    RegistrationId: str,
    VersionNumbers: Sequence[int] = ...,
    Filters: Sequence[RegistrationVersionFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeRegistrationVersionsResultTypeDef:  # (2)
    ...
  1. See RegistrationVersionFilterTypeDef
  2. See DescribeRegistrationVersionsResultTypeDef 
# describe_registration_versions method usage example with argument unpacking

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

parent.describe_registration_versions(**kwargs)
  1. See DescribeRegistrationVersionsRequestRequestTypeDef

describe_registrations#

Retrieves the specified registrations.

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

# describe_registrations method definition

def describe_registrations(
    self,
    *,
    RegistrationIds: Sequence[str] = ...,
    Filters: Sequence[RegistrationFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeRegistrationsResultTypeDef:  # (2)
    ...
  1. See RegistrationFilterTypeDef
  2. See DescribeRegistrationsResultTypeDef 
# describe_registrations method usage example with argument unpacking

kwargs: DescribeRegistrationsRequestRequestTypeDef = {  # (1)
    "RegistrationIds": ...,
}

parent.describe_registrations(**kwargs)
  1. See DescribeRegistrationsRequestRequestTypeDef

describe_sender_ids#

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

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

# describe_sender_ids method definition

def describe_sender_ids(
    self,
    *,
    SenderIds: Sequence[SenderIdAndCountryTypeDef] = ...,  # (1)
    Filters: Sequence[SenderIdFilterTypeDef] = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    Owner: OwnerType = ...,  # (3)
) -> DescribeSenderIdsResultTypeDef:  # (4)
    ...
  1. See SenderIdAndCountryTypeDef
  2. See SenderIdFilterTypeDef
  3. See OwnerType
  4. See DescribeSenderIdsResultTypeDef 
# describe_sender_ids method usage example with argument unpacking

kwargs: DescribeSenderIdsRequestRequestTypeDef = {  # (1)
    "SenderIds": ...,
}

parent.describe_sender_ids(**kwargs)
  1. See DescribeSenderIdsRequestRequestTypeDef

describe_spend_limits#

Describes the current monthly spend limits for sending voice and text messages.

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

# describe_spend_limits method definition

def describe_spend_limits(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeSpendLimitsResultTypeDef:  # (1)
    ...
  1. See DescribeSpendLimitsResultTypeDef 
# describe_spend_limits method usage example with argument unpacking

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

parent.describe_spend_limits(**kwargs)
  1. See DescribeSpendLimitsRequestRequestTypeDef

describe_verified_destination_numbers#

Retrieves the specified verified destiona numbers.

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

# describe_verified_destination_numbers method definition

def describe_verified_destination_numbers(
    self,
    *,
    VerifiedDestinationNumberIds: Sequence[str] = ...,
    DestinationPhoneNumbers: Sequence[str] = ...,
    Filters: Sequence[VerifiedDestinationNumberFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeVerifiedDestinationNumbersResultTypeDef:  # (2)
    ...
  1. See VerifiedDestinationNumberFilterTypeDef
  2. See DescribeVerifiedDestinationNumbersResultTypeDef 
# describe_verified_destination_numbers method usage example with argument unpacking

kwargs: DescribeVerifiedDestinationNumbersRequestRequestTypeDef = {  # (1)
    "VerifiedDestinationNumberIds": ...,
}

parent.describe_verified_destination_numbers(**kwargs)
  1. See DescribeVerifiedDestinationNumbersRequestRequestTypeDef

disassociate_origination_identity#

Removes the specified origination identity from an existing pool.

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

# disassociate_origination_identity method definition

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

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

parent.disassociate_origination_identity(**kwargs)
  1. See DisassociateOriginationIdentityRequestRequestTypeDef

disassociate_protect_configuration#

Disassociate a protect configuration from a configuration set.

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

# disassociate_protect_configuration method definition

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

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

parent.disassociate_protect_configuration(**kwargs)
  1. See DisassociateProtectConfigurationRequestRequestTypeDef

discard_registration_version#

Discard the current version of the registration.

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

# discard_registration_version method definition

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

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

parent.discard_registration_version(**kwargs)
  1. See DiscardRegistrationVersionRequestRequestTypeDef

generate_presigned_url#

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

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

Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.

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

# get_protect_configuration_country_rule_set method definition

def get_protect_configuration_country_rule_set(
    self,
    *,
    ProtectConfigurationId: str,
    NumberCapability: NumberCapabilityType,  # (1)
) -> GetProtectConfigurationCountryRuleSetResultTypeDef:  # (2)
    ...
  1. See NumberCapabilityType
  2. See GetProtectConfigurationCountryRuleSetResultTypeDef 
# get_protect_configuration_country_rule_set method usage example with argument unpacking

kwargs: GetProtectConfigurationCountryRuleSetRequestRequestTypeDef = {  # (1)
    "ProtectConfigurationId": ...,
    "NumberCapability": ...,
}

parent.get_protect_configuration_country_rule_set(**kwargs)
  1. See GetProtectConfigurationCountryRuleSetRequestRequestTypeDef

get_resource_policy#

Retrieves the JSON text of the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource.

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

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> GetResourcePolicyResultTypeDef:  # (1)
    ...
  1. See GetResourcePolicyResultTypeDef 
# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_resource_policy(**kwargs)
  1. See GetResourcePolicyRequestRequestTypeDef

list_pool_origination_identities#

Lists all associated origination identities in your pool.

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

# list_pool_origination_identities method definition

def list_pool_origination_identities(
    self,
    *,
    PoolId: str,
    Filters: Sequence[PoolOriginationIdentitiesFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPoolOriginationIdentitiesResultTypeDef:  # (2)
    ...
  1. See PoolOriginationIdentitiesFilterTypeDef
  2. See ListPoolOriginationIdentitiesResultTypeDef 
# list_pool_origination_identities method usage example with argument unpacking

kwargs: ListPoolOriginationIdentitiesRequestRequestTypeDef = {  # (1)
    "PoolId": ...,
}

parent.list_pool_origination_identities(**kwargs)
  1. See ListPoolOriginationIdentitiesRequestRequestTypeDef

list_registration_associations#

Retreive all of the origination identies that are associated with a registration.

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

# list_registration_associations method definition

def list_registration_associations(
    self,
    *,
    RegistrationId: str,
    Filters: Sequence[RegistrationAssociationFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListRegistrationAssociationsResultTypeDef:  # (2)
    ...
  1. See RegistrationAssociationFilterTypeDef
  2. See ListRegistrationAssociationsResultTypeDef 
# list_registration_associations method usage example with argument unpacking

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

parent.list_registration_associations(**kwargs)
  1. See ListRegistrationAssociationsRequestRequestTypeDef

list_tags_for_resource#

List all tags associated with a resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResultTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

put_keyword#

Creates or updates a keyword configuration on an origination phone number or pool.

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

# put_keyword method definition

def put_keyword(
    self,
    *,
    OriginationIdentity: str,
    Keyword: str,
    KeywordMessage: str,
    KeywordAction: KeywordActionType = ...,  # (1)
) -> PutKeywordResultTypeDef:  # (2)
    ...
  1. See KeywordActionType
  2. See PutKeywordResultTypeDef 
# put_keyword method usage example with argument unpacking

kwargs: PutKeywordRequestRequestTypeDef = {  # (1)
    "OriginationIdentity": ...,
    "Keyword": ...,
    "KeywordMessage": ...,
}

parent.put_keyword(**kwargs)
  1. See PutKeywordRequestRequestTypeDef

put_opted_out_number#

Creates an opted out destination phone number in the opt-out list.

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

# put_opted_out_number method definition

def put_opted_out_number(
    self,
    *,
    OptOutListName: str,
    OptedOutNumber: str,
) -> PutOptedOutNumberResultTypeDef:  # (1)
    ...
  1. See PutOptedOutNumberResultTypeDef 
# put_opted_out_number method usage example with argument unpacking

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

parent.put_opted_out_number(**kwargs)
  1. See PutOptedOutNumberRequestRequestTypeDef

put_registration_field_value#

Creates or updates a field value for a registration.

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

# put_registration_field_value method definition

def put_registration_field_value(
    self,
    *,
    RegistrationId: str,
    FieldPath: str,
    SelectChoices: Sequence[str] = ...,
    TextValue: str = ...,
    RegistrationAttachmentId: str = ...,
) -> PutRegistrationFieldValueResultTypeDef:  # (1)
    ...
  1. See PutRegistrationFieldValueResultTypeDef 
# put_registration_field_value method usage example with argument unpacking

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

parent.put_registration_field_value(**kwargs)
  1. See PutRegistrationFieldValueRequestRequestTypeDef

put_resource_policy#

Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the resource.

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

# put_resource_policy method definition

def put_resource_policy(
    self,
    *,
    ResourceArn: str,
    Policy: str,
) -> PutResourcePolicyResultTypeDef:  # (1)
    ...
  1. See PutResourcePolicyResultTypeDef 
# put_resource_policy method usage example with argument unpacking

kwargs: PutResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Policy": ...,
}

parent.put_resource_policy(**kwargs)
  1. See PutResourcePolicyRequestRequestTypeDef

release_phone_number#

Releases an existing origination phone number in your account.

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

# release_phone_number method definition

def release_phone_number(
    self,
    *,
    PhoneNumberId: str,
) -> ReleasePhoneNumberResultTypeDef:  # (1)
    ...
  1. See ReleasePhoneNumberResultTypeDef 
# release_phone_number method usage example with argument unpacking

kwargs: ReleasePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.release_phone_number(**kwargs)
  1. See ReleasePhoneNumberRequestRequestTypeDef

release_sender_id#

Releases an existing sender ID in your account.

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

# release_sender_id method definition

def release_sender_id(
    self,
    *,
    SenderId: str,
    IsoCountryCode: str,
) -> ReleaseSenderIdResultTypeDef:  # (1)
    ...
  1. See ReleaseSenderIdResultTypeDef 
# release_sender_id method usage example with argument unpacking

kwargs: ReleaseSenderIdRequestRequestTypeDef = {  # (1)
    "SenderId": ...,
    "IsoCountryCode": ...,
}

parent.release_sender_id(**kwargs)
  1. See ReleaseSenderIdRequestRequestTypeDef

request_phone_number#

Request an origination phone number for use in your account.

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

# request_phone_number method definition

def request_phone_number(
    self,
    *,
    IsoCountryCode: str,
    MessageType: MessageTypeType,  # (1)
    NumberCapabilities: Sequence[NumberCapabilityType],  # (2)
    NumberType: RequestableNumberTypeType,  # (3)
    OptOutListName: str = ...,
    PoolId: str = ...,
    RegistrationId: str = ...,
    DeletionProtectionEnabled: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    ClientToken: str = ...,
) -> RequestPhoneNumberResultTypeDef:  # (5)
    ...
  1. See MessageTypeType
  2. See NumberCapabilityType
  3. See RequestableNumberTypeType
  4. See TagTypeDef
  5. See RequestPhoneNumberResultTypeDef 
# request_phone_number method usage example with argument unpacking

kwargs: RequestPhoneNumberRequestRequestTypeDef = {  # (1)
    "IsoCountryCode": ...,
    "MessageType": ...,
    "NumberCapabilities": ...,
    "NumberType": ...,
}

parent.request_phone_number(**kwargs)
  1. See RequestPhoneNumberRequestRequestTypeDef

request_sender_id#

Request a new sender ID that doesn't require registration.

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

# request_sender_id method definition

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

kwargs: RequestSenderIdRequestRequestTypeDef = {  # (1)
    "SenderId": ...,
    "IsoCountryCode": ...,
}

parent.request_sender_id(**kwargs)
  1. See RequestSenderIdRequestRequestTypeDef

send_destination_number_verification_code#

Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number.

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

# send_destination_number_verification_code method definition

def send_destination_number_verification_code(
    self,
    *,
    VerifiedDestinationNumberId: str,
    VerificationChannel: VerificationChannelType,  # (1)
    LanguageCode: LanguageCodeType = ...,  # (2)
    OriginationIdentity: str = ...,
    ConfigurationSetName: str = ...,
    Context: Mapping[str, str] = ...,
    DestinationCountryParameters: Mapping[DestinationCountryParameterKeyType, str] = ...,  # (3)
) -> SendDestinationNumberVerificationCodeResultTypeDef:  # (4)
    ...
  1. See VerificationChannelType
  2. See LanguageCodeType
  3. See DestinationCountryParameterKeyType
  4. See SendDestinationNumberVerificationCodeResultTypeDef 
# send_destination_number_verification_code method usage example with argument unpacking

kwargs: SendDestinationNumberVerificationCodeRequestRequestTypeDef = {  # (1)
    "VerifiedDestinationNumberId": ...,
    "VerificationChannel": ...,
}

parent.send_destination_number_verification_code(**kwargs)
  1. See SendDestinationNumberVerificationCodeRequestRequestTypeDef

send_media_message#

Creates a new multimedia message (MMS) and sends it to a recipient's phone number.

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

# send_media_message method definition

def send_media_message(
    self,
    *,
    DestinationPhoneNumber: str,
    OriginationIdentity: str,
    MessageBody: str = ...,
    MediaUrls: Sequence[str] = ...,
    ConfigurationSetName: str = ...,
    MaxPrice: str = ...,
    TimeToLive: int = ...,
    Context: Mapping[str, str] = ...,
    DryRun: bool = ...,
    ProtectConfigurationId: str = ...,
) -> SendMediaMessageResultTypeDef:  # (1)
    ...
  1. See SendMediaMessageResultTypeDef 
# send_media_message method usage example with argument unpacking

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

parent.send_media_message(**kwargs)
  1. See SendMediaMessageRequestRequestTypeDef

send_text_message#

Creates a new text message and sends it to a recipient's phone number.

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

# send_text_message method definition

def send_text_message(
    self,
    *,
    DestinationPhoneNumber: str,
    OriginationIdentity: str = ...,
    MessageBody: str = ...,
    MessageType: MessageTypeType = ...,  # (1)
    Keyword: str = ...,
    ConfigurationSetName: str = ...,
    MaxPrice: str = ...,
    TimeToLive: int = ...,
    Context: Mapping[str, str] = ...,
    DestinationCountryParameters: Mapping[DestinationCountryParameterKeyType, str] = ...,  # (2)
    DryRun: bool = ...,
    ProtectConfigurationId: str = ...,
) -> SendTextMessageResultTypeDef:  # (3)
    ...
  1. See MessageTypeType
  2. See DestinationCountryParameterKeyType
  3. See SendTextMessageResultTypeDef 
# send_text_message method usage example with argument unpacking

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

parent.send_text_message(**kwargs)
  1. See SendTextMessageRequestRequestTypeDef

send_voice_message#

Allows you to send a request that sends a voice message.

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

# send_voice_message method definition

def send_voice_message(
    self,
    *,
    DestinationPhoneNumber: str,
    OriginationIdentity: str,
    MessageBody: str = ...,
    MessageBodyTextType: VoiceMessageBodyTextTypeType = ...,  # (1)
    VoiceId: VoiceIdType = ...,  # (2)
    ConfigurationSetName: str = ...,
    MaxPricePerMinute: str = ...,
    TimeToLive: int = ...,
    Context: Mapping[str, str] = ...,
    DryRun: bool = ...,
    ProtectConfigurationId: str = ...,
) -> SendVoiceMessageResultTypeDef:  # (3)
    ...
  1. See VoiceMessageBodyTextTypeType
  2. See VoiceIdType
  3. See SendVoiceMessageResultTypeDef 
# send_voice_message method usage example with argument unpacking

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

parent.send_voice_message(**kwargs)
  1. See SendVoiceMessageRequestRequestTypeDef

set_account_default_protect_configuration#

Set a protect configuration as your account default.

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

# set_account_default_protect_configuration method definition

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

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

parent.set_account_default_protect_configuration(**kwargs)
  1. See SetAccountDefaultProtectConfigurationRequestRequestTypeDef

set_default_message_type#

Sets the default message type on a configuration set.

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

# set_default_message_type method definition

def set_default_message_type(
    self,
    *,
    ConfigurationSetName: str,
    MessageType: MessageTypeType,  # (1)
) -> SetDefaultMessageTypeResultTypeDef:  # (2)
    ...
  1. See MessageTypeType
  2. See SetDefaultMessageTypeResultTypeDef 
# set_default_message_type method usage example with argument unpacking

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

parent.set_default_message_type(**kwargs)
  1. See SetDefaultMessageTypeRequestRequestTypeDef

set_default_sender_id#

Sets default sender ID on a configuration set.

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

# set_default_sender_id method definition

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

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

parent.set_default_sender_id(**kwargs)
  1. See SetDefaultSenderIdRequestRequestTypeDef

set_media_message_spend_limit_override#

Sets an account level monthly spend limit override for sending MMS messages.

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

# set_media_message_spend_limit_override method definition

def set_media_message_spend_limit_override(
    self,
    *,
    MonthlyLimit: int,
) -> SetMediaMessageSpendLimitOverrideResultTypeDef:  # (1)
    ...
  1. See SetMediaMessageSpendLimitOverrideResultTypeDef 
# set_media_message_spend_limit_override method usage example with argument unpacking

kwargs: SetMediaMessageSpendLimitOverrideRequestRequestTypeDef = {  # (1)
    "MonthlyLimit": ...,
}

parent.set_media_message_spend_limit_override(**kwargs)
  1. See SetMediaMessageSpendLimitOverrideRequestRequestTypeDef

set_text_message_spend_limit_override#

Sets an account level monthly spend limit override for sending text messages.

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

# set_text_message_spend_limit_override method definition

def set_text_message_spend_limit_override(
    self,
    *,
    MonthlyLimit: int,
) -> SetTextMessageSpendLimitOverrideResultTypeDef:  # (1)
    ...
  1. See SetTextMessageSpendLimitOverrideResultTypeDef 
# set_text_message_spend_limit_override method usage example with argument unpacking

kwargs: SetTextMessageSpendLimitOverrideRequestRequestTypeDef = {  # (1)
    "MonthlyLimit": ...,
}

parent.set_text_message_spend_limit_override(**kwargs)
  1. See SetTextMessageSpendLimitOverrideRequestRequestTypeDef

set_voice_message_spend_limit_override#

Sets an account level monthly spend limit override for sending voice messages.

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

# set_voice_message_spend_limit_override method definition

def set_voice_message_spend_limit_override(
    self,
    *,
    MonthlyLimit: int,
) -> SetVoiceMessageSpendLimitOverrideResultTypeDef:  # (1)
    ...
  1. See SetVoiceMessageSpendLimitOverrideResultTypeDef 
# set_voice_message_spend_limit_override method usage example with argument unpacking

kwargs: SetVoiceMessageSpendLimitOverrideRequestRequestTypeDef = {  # (1)
    "MonthlyLimit": ...,
}

parent.set_voice_message_spend_limit_override(**kwargs)
  1. See SetVoiceMessageSpendLimitOverrideRequestRequestTypeDef

submit_registration_version#

Submit the specified registration for review and approval.

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

# submit_registration_version method definition

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

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

parent.submit_registration_version(**kwargs)
  1. See SubmitRegistrationVersionRequestRequestTypeDef

tag_resource#

Adds or overwrites only the specified tags for the specified resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes the association of the specified tags from a resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_event_destination#

Updates an existing event destination in a configuration set.

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

# update_event_destination method definition

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

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

parent.update_event_destination(**kwargs)
  1. See UpdateEventDestinationRequestRequestTypeDef

update_phone_number#

Updates the configuration of an existing origination phone number.

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

# update_phone_number method definition

def update_phone_number(
    self,
    *,
    PhoneNumberId: str,
    TwoWayEnabled: bool = ...,
    TwoWayChannelArn: str = ...,
    TwoWayChannelRole: str = ...,
    SelfManagedOptOutsEnabled: bool = ...,
    OptOutListName: str = ...,
    DeletionProtectionEnabled: bool = ...,
) -> UpdatePhoneNumberResultTypeDef:  # (1)
    ...
  1. See UpdatePhoneNumberResultTypeDef 
# update_phone_number method usage example with argument unpacking

kwargs: UpdatePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.update_phone_number(**kwargs)
  1. See UpdatePhoneNumberRequestRequestTypeDef

update_pool#

Updates the configuration of an existing pool.

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

# update_pool method definition

def update_pool(
    self,
    *,
    PoolId: str,
    TwoWayEnabled: bool = ...,
    TwoWayChannelArn: str = ...,
    TwoWayChannelRole: str = ...,
    SelfManagedOptOutsEnabled: bool = ...,
    OptOutListName: str = ...,
    SharedRoutesEnabled: bool = ...,
    DeletionProtectionEnabled: bool = ...,
) -> UpdatePoolResultTypeDef:  # (1)
    ...
  1. See UpdatePoolResultTypeDef 
# update_pool method usage example with argument unpacking

kwargs: UpdatePoolRequestRequestTypeDef = {  # (1)
    "PoolId": ...,
}

parent.update_pool(**kwargs)
  1. See UpdatePoolRequestRequestTypeDef

update_protect_configuration#

Update the setting for an existing protect configuration.

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

# update_protect_configuration method definition

def update_protect_configuration(
    self,
    *,
    ProtectConfigurationId: str,
    DeletionProtectionEnabled: bool = ...,
) -> UpdateProtectConfigurationResultTypeDef:  # (1)
    ...
  1. See UpdateProtectConfigurationResultTypeDef 
# update_protect_configuration method usage example with argument unpacking

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

parent.update_protect_configuration(**kwargs)
  1. See UpdateProtectConfigurationRequestRequestTypeDef

update_protect_configuration_country_rule_set#

Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties.

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

# update_protect_configuration_country_rule_set method definition

def update_protect_configuration_country_rule_set(
    self,
    *,
    ProtectConfigurationId: str,
    NumberCapability: NumberCapabilityType,  # (1)
    CountryRuleSetUpdates: Mapping[str, ProtectConfigurationCountryRuleSetInformationTypeDef],  # (2)
) -> UpdateProtectConfigurationCountryRuleSetResultTypeDef:  # (3)
    ...
  1. See NumberCapabilityType
  2. See ProtectConfigurationCountryRuleSetInformationTypeDef
  3. See UpdateProtectConfigurationCountryRuleSetResultTypeDef 
# update_protect_configuration_country_rule_set method usage example with argument unpacking

kwargs: UpdateProtectConfigurationCountryRuleSetRequestRequestTypeDef = {  # (1)
    "ProtectConfigurationId": ...,
    "NumberCapability": ...,
    "CountryRuleSetUpdates": ...,
}

parent.update_protect_configuration_country_rule_set(**kwargs)
  1. See UpdateProtectConfigurationCountryRuleSetRequestRequestTypeDef

update_sender_id#

Updates the configuration of an existing sender ID.

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

# update_sender_id method definition

def update_sender_id(
    self,
    *,
    SenderId: str,
    IsoCountryCode: str,
    DeletionProtectionEnabled: bool = ...,
) -> UpdateSenderIdResultTypeDef:  # (1)
    ...
  1. See UpdateSenderIdResultTypeDef 
# update_sender_id method usage example with argument unpacking

kwargs: UpdateSenderIdRequestRequestTypeDef = {  # (1)
    "SenderId": ...,
    "IsoCountryCode": ...,
}

parent.update_sender_id(**kwargs)
  1. See UpdateSenderIdRequestRequestTypeDef

verify_destination_number#

Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.

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

# verify_destination_number method definition

def verify_destination_number(
    self,
    *,
    VerifiedDestinationNumberId: str,
    VerificationCode: str,
) -> VerifyDestinationNumberResultTypeDef:  # (1)
    ...
  1. See VerifyDestinationNumberResultTypeDef 
# verify_destination_number method usage example with argument unpacking

kwargs: VerifyDestinationNumberRequestRequestTypeDef = {  # (1)
    "VerifiedDestinationNumberId": ...,
    "VerificationCode": ...,
}

parent.verify_destination_number(**kwargs)
  1. See VerifyDestinationNumberRequestRequestTypeDef

get_paginator#

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