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

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.

Usage example

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

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

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

Method definition

def associate_origination_identity(
    self,
    *,
    PoolId: str,
    OriginationIdentity: str,
    IsoCountryCode: str,
    ClientToken: str = ...,
) -> AssociateOriginationIdentityResultTypeDef:  # (1)
    ...

1. See AssociateOriginationIdentityResultTypeDef

Usage example with kwargs

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

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

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

Method definition

def create_configuration_set(
    self,
    *,
    ConfigurationSetName: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    ClientToken: str = ...,
) -> CreateConfigurationSetResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateConfigurationSetResultTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def create_opt_out_list(
    self,
    *,
    OptOutListName: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    ClientToken: str = ...,
) -> CreateOptOutListResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateOptOutListResultTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

parent.create_pool(**kwargs)

1. See CreatePoolRequestRequestTypeDef

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

Method definition

def delete_configuration_set(
    self,
    *,
    ConfigurationSetName: str,
) -> DeleteConfigurationSetResultTypeDef:  # (1)
    ...

1. See DeleteConfigurationSetResultTypeDef

Usage example with kwargs

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

Method definition

def delete_default_message_type(
    self,
    *,
    ConfigurationSetName: str,
) -> DeleteDefaultMessageTypeResultTypeDef:  # (1)
    ...

1. See DeleteDefaultMessageTypeResultTypeDef

Usage example with kwargs

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

Method definition

def delete_default_sender_id(
    self,
    *,
    ConfigurationSetName: str,
) -> DeleteDefaultSenderIdResultTypeDef:  # (1)
    ...

1. See DeleteDefaultSenderIdResultTypeDef

Usage example with kwargs

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

Method definition

def delete_event_destination(
    self,
    *,
    ConfigurationSetName: str,
    EventDestinationName: str,
) -> DeleteEventDestinationResultTypeDef:  # (1)
    ...

1. See DeleteEventDestinationResultTypeDef

Usage example with kwargs

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

Method definition

def delete_keyword(
    self,
    *,
    OriginationIdentity: str,
    Keyword: str,
) -> DeleteKeywordResultTypeDef:  # (1)
    ...

1. See DeleteKeywordResultTypeDef

Usage example with kwargs

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

parent.delete_keyword(**kwargs)

1. See DeleteKeywordRequestRequestTypeDef

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

Method definition

def delete_opt_out_list(
    self,
    *,
    OptOutListName: str,
) -> DeleteOptOutListResultTypeDef:  # (1)
    ...

1. See DeleteOptOutListResultTypeDef

Usage example with kwargs

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

Method definition

def delete_opted_out_number(
    self,
    *,
    OptOutListName: str,
    OptedOutNumber: str,
) -> DeleteOptedOutNumberResultTypeDef:  # (1)
    ...

1. See DeleteOptedOutNumberResultTypeDef

Usage example with kwargs

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

Method definition

def delete_pool(
    self,
    *,
    PoolId: str,
) -> DeletePoolResultTypeDef:  # (1)
    ...

1. See DeletePoolResultTypeDef

Usage example with kwargs

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

parent.delete_pool(**kwargs)

1. See DeletePoolRequestRequestTypeDef

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

Method definition

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

1. See DeleteTextMessageSpendLimitOverrideResultTypeDef

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

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

Method definition

def describe_account_attributes(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeAccountAttributesResultTypeDef:  # (1)
    ...

1. See DescribeAccountAttributesResultTypeDef

Usage example with kwargs

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

parent.describe_account_attributes(**kwargs)

1. See DescribeAccountAttributesRequestRequestTypeDef

describe_account_limits

Describes the current Amazon Pinpoint 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

Method definition

def describe_account_limits(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeAccountLimitsResultTypeDef:  # (1)
    ...

1. See DescribeAccountLimitsResultTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def describe_opt_out_lists(
    self,
    *,
    OptOutListNames: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeOptOutListsResultTypeDef:  # (1)
    ...

1. See DescribeOptOutListsResultTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def describe_phone_numbers(
    self,
    *,
    PhoneNumberIds: Sequence[str] = ...,
    Filters: Sequence[PhoneNumberFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribePhoneNumbersResultTypeDef:  # (2)
    ...

1. See PhoneNumberFilterTypeDef
2. See DescribePhoneNumbersResultTypeDef

Usage example with kwargs

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

Method definition

def describe_pools(
    self,
    *,
    PoolIds: Sequence[str] = ...,
    Filters: Sequence[PoolFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribePoolsResultTypeDef:  # (2)
    ...

1. See PoolFilterTypeDef
2. See DescribePoolsResultTypeDef

Usage example with kwargs

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

parent.describe_pools(**kwargs)

1. See DescribePoolsRequestRequestTypeDef

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

Method definition

def describe_sender_ids(
    self,
    *,
    SenderIds: Sequence[SenderIdAndCountryTypeDef] = ...,  # (1)
    Filters: Sequence[SenderIdFilterTypeDef] = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeSenderIdsResultTypeDef:  # (3)
    ...

1. See SenderIdAndCountryTypeDef
2. See SenderIdFilterTypeDef
3. See DescribeSenderIdsResultTypeDef

Usage example with kwargs

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

parent.describe_sender_ids(**kwargs)

1. See DescribeSenderIdsRequestRequestTypeDef

describe_spend_limits

Describes the current Amazon Pinpoint 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

Method definition

def describe_spend_limits(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeSpendLimitsResultTypeDef:  # (1)
    ...

1. See DescribeSpendLimitsResultTypeDef

Usage example with kwargs

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

parent.describe_spend_limits(**kwargs)

1. See DescribeSpendLimitsRequestRequestTypeDef

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

Method definition

def disassociate_origination_identity(
    self,
    *,
    PoolId: str,
    OriginationIdentity: str,
    IsoCountryCode: str,
    ClientToken: str = ...,
) -> DisassociateOriginationIdentityResultTypeDef:  # (1)
    ...

1. See DisassociateOriginationIdentityResultTypeDef

Usage example with kwargs

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

parent.disassociate_origination_identity(**kwargs)

1. See DisassociateOriginationIdentityRequestRequestTypeDef

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

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

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

Usage example with kwargs

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

parent.list_pool_origination_identities(**kwargs)

1. See ListPoolOriginationIdentitiesRequestRequestTypeDef

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

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...

1. See ListTagsForResourceResultTypeDef

Usage example with kwargs

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

Method definition

def put_keyword(
    self,
    *,
    OriginationIdentity: str,
    Keyword: str,
    KeywordMessage: str,
    KeywordAction: KeywordActionType = ...,  # (1)
) -> PutKeywordResultTypeDef:  # (2)
    ...

1. See KeywordActionType
2. See PutKeywordResultTypeDef

Usage example with kwargs

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

Method definition

def put_opted_out_number(
    self,
    *,
    OptOutListName: str,
    OptedOutNumber: str,
) -> PutOptedOutNumberResultTypeDef:  # (1)
    ...

1. See PutOptedOutNumberResultTypeDef

Usage example with kwargs

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

parent.put_opted_out_number(**kwargs)

1. See PutOptedOutNumberRequestRequestTypeDef

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

Method definition

def release_phone_number(
    self,
    *,
    PhoneNumberId: str,
) -> ReleasePhoneNumberResultTypeDef:  # (1)
    ...

1. See ReleasePhoneNumberResultTypeDef

Usage example with kwargs

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

parent.release_phone_number(**kwargs)

1. See ReleasePhoneNumberRequestRequestTypeDef

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

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

Usage example with kwargs

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

parent.request_phone_number(**kwargs)

1. See RequestPhoneNumberRequestRequestTypeDef

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

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 = ...,
) -> SendTextMessageResultTypeDef:  # (3)
    ...

1. See MessageTypeType
2. See DestinationCountryParameterKeyType
3. See SendTextMessageResultTypeDef

Usage example with kwargs

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

parent.send_text_message(**kwargs)

1. See SendTextMessageRequestRequestTypeDef

send_voice_message

Allows you to send a request that sends a text message through Amazon Pinpoint.

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

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 = ...,
) -> SendVoiceMessageResultTypeDef:  # (3)
    ...

1. See VoiceMessageBodyTextTypeType
2. See VoiceIdType
3. See SendVoiceMessageResultTypeDef

Usage example with kwargs

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

parent.send_voice_message(**kwargs)

1. See SendVoiceMessageRequestRequestTypeDef

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

Method definition

def set_default_message_type(
    self,
    *,
    ConfigurationSetName: str,
    MessageType: MessageTypeType,  # (1)
) -> SetDefaultMessageTypeResultTypeDef:  # (2)
    ...

1. See MessageTypeType
2. See SetDefaultMessageTypeResultTypeDef

Usage example with kwargs

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

Method definition

def set_default_sender_id(
    self,
    *,
    ConfigurationSetName: str,
    SenderId: str,
) -> SetDefaultSenderIdResultTypeDef:  # (1)
    ...

1. See SetDefaultSenderIdResultTypeDef

Usage example with kwargs

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

parent.set_default_sender_id(**kwargs)

1. See SetDefaultSenderIdRequestRequestTypeDef

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

Method definition

def set_text_message_spend_limit_override(
    self,
    *,
    MonthlyLimit: int,
) -> SetTextMessageSpendLimitOverrideResultTypeDef:  # (1)
    ...

1. See SetTextMessageSpendLimitOverrideResultTypeDef

Usage example with kwargs

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

Method definition

def set_voice_message_spend_limit_override(
    self,
    *,
    MonthlyLimit: int,
) -> SetVoiceMessageSpendLimitOverrideResultTypeDef:  # (1)
    ...

1. See SetVoiceMessageSpendLimitOverrideResultTypeDef

Usage example with kwargs

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

parent.set_voice_message_spend_limit_override(**kwargs)

1. See SetVoiceMessageSpendLimitOverrideRequestRequestTypeDef

tag_resource

Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource.

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

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource.

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

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def update_phone_number(
    self,
    *,
    PhoneNumberId: str,
    TwoWayEnabled: bool = ...,
    TwoWayChannelArn: str = ...,
    SelfManagedOptOutsEnabled: bool = ...,
    OptOutListName: str = ...,
    DeletionProtectionEnabled: bool = ...,
) -> UpdatePhoneNumberResultTypeDef:  # (1)
    ...

1. See UpdatePhoneNumberResultTypeDef

Usage example with kwargs

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

Method definition

def update_pool(
    self,
    *,
    PoolId: str,
    TwoWayEnabled: bool = ...,
    TwoWayChannelArn: str = ...,
    SelfManagedOptOutsEnabled: bool = ...,
    OptOutListName: str = ...,
    SharedRoutesEnabled: bool = ...,
    DeletionProtectionEnabled: bool = ...,
) -> UpdatePoolResultTypeDef:  # (1)
    ...

1. See UpdatePoolResultTypeDef

Usage example with kwargs

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

parent.update_pool(**kwargs)

1. See UpdatePoolRequestRequestTypeDef

get_paginator

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

• client.get_paginator("describe_account_attributes") -> DescribeAccountAttributesPaginator
• client.get_paginator("describe_account_limits") -> DescribeAccountLimitsPaginator
• client.get_paginator("describe_configuration_sets") -> DescribeConfigurationSetsPaginator
• client.get_paginator("describe_keywords") -> DescribeKeywordsPaginator
• client.get_paginator("describe_opt_out_lists") -> DescribeOptOutListsPaginator
• client.get_paginator("describe_opted_out_numbers") -> DescribeOptedOutNumbersPaginator
• client.get_paginator("describe_phone_numbers") -> DescribePhoneNumbersPaginator
• client.get_paginator("describe_pools") -> DescribePoolsPaginator
• client.get_paginator("describe_sender_ids") -> DescribeSenderIdsPaginator
• client.get_paginator("describe_spend_limits") -> DescribeSpendLimitsPaginator
• client.get_paginator("list_pool_origination_identities") -> ListPoolOriginationIdentitiesPaginator