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)
...
# associate_origination_identity method usage example with argument unpacking
kwargs: AssociateOriginationIdentityRequestRequestTypeDef = { # (1)
"PoolId": ...,
"OriginationIdentity": ...,
"IsoCountryCode": ...,
}
parent.associate_origination_identity(**kwargs)
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)
...
# create_configuration_set method usage example with argument unpacking
kwargs: CreateConfigurationSetRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.create_configuration_set(**kwargs)
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)
...
- See EventTypeType
- See CloudWatchLogsDestinationTypeDef
- See KinesisFirehoseDestinationTypeDef
- See SnsDestinationTypeDef
- See CreateEventDestinationResultTypeDef
# create_event_destination method usage example with argument unpacking
kwargs: CreateEventDestinationRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"EventDestinationName": ...,
"MatchingEventTypes": ...,
}
parent.create_event_destination(**kwargs)
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)
...
# create_opt_out_list method usage example with argument unpacking
kwargs: CreateOptOutListRequestRequestTypeDef = { # (1)
"OptOutListName": ...,
}
parent.create_opt_out_list(**kwargs)
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)
...
- See MessageTypeType
- See TagTypeDef
- See CreatePoolResultTypeDef
# create_pool method usage example with argument unpacking
kwargs: CreatePoolRequestRequestTypeDef = { # (1)
"OriginationIdentity": ...,
"IsoCountryCode": ...,
"MessageType": ...,
}
parent.create_pool(**kwargs)
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)
...
# delete_configuration_set method usage example with argument unpacking
kwargs: DeleteConfigurationSetRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.delete_configuration_set(**kwargs)
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)
...
# delete_default_message_type method usage example with argument unpacking
kwargs: DeleteDefaultMessageTypeRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.delete_default_message_type(**kwargs)
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)
...
# delete_default_sender_id method usage example with argument unpacking
kwargs: DeleteDefaultSenderIdRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.delete_default_sender_id(**kwargs)
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)
...
# delete_event_destination method usage example with argument unpacking
kwargs: DeleteEventDestinationRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"EventDestinationName": ...,
}
parent.delete_event_destination(**kwargs)
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)
...
# delete_keyword method usage example with argument unpacking
kwargs: DeleteKeywordRequestRequestTypeDef = { # (1)
"OriginationIdentity": ...,
"Keyword": ...,
}
parent.delete_keyword(**kwargs)
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)
...
# delete_opt_out_list method usage example with argument unpacking
kwargs: DeleteOptOutListRequestRequestTypeDef = { # (1)
"OptOutListName": ...,
}
parent.delete_opt_out_list(**kwargs)
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)
...
# delete_opted_out_number method usage example with argument unpacking
kwargs: DeleteOptedOutNumberRequestRequestTypeDef = { # (1)
"OptOutListName": ...,
"OptedOutNumber": ...,
}
parent.delete_opted_out_number(**kwargs)
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)
...
# delete_pool method usage example with argument unpacking
kwargs: DeletePoolRequestRequestTypeDef = { # (1)
"PoolId": ...,
}
parent.delete_pool(**kwargs)
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)
...
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)
...
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)
...
# describe_account_attributes method usage example with argument unpacking
kwargs: DescribeAccountAttributesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.describe_account_attributes(**kwargs)
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
# describe_account_limits method definition
def describe_account_limits(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeAccountLimitsResultTypeDef: # (1)
...
# describe_account_limits method usage example with argument unpacking
kwargs: DescribeAccountLimitsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.describe_account_limits(**kwargs)
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)
...
# describe_configuration_sets method usage example with argument unpacking
kwargs: DescribeConfigurationSetsRequestRequestTypeDef = { # (1)
"ConfigurationSetNames": ...,
}
parent.describe_configuration_sets(**kwargs)
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)
...
# describe_keywords method usage example with argument unpacking
kwargs: DescribeKeywordsRequestRequestTypeDef = { # (1)
"OriginationIdentity": ...,
}
parent.describe_keywords(**kwargs)
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 = ...,
) -> DescribeOptOutListsResultTypeDef: # (1)
...
# describe_opt_out_lists method usage example with argument unpacking
kwargs: DescribeOptOutListsRequestRequestTypeDef = { # (1)
"OptOutListNames": ...,
}
parent.describe_opt_out_lists(**kwargs)
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)
...
# describe_opted_out_numbers method usage example with argument unpacking
kwargs: DescribeOptedOutNumbersRequestRequestTypeDef = { # (1)
"OptOutListName": ...,
}
parent.describe_opted_out_numbers(**kwargs)
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 = ...,
) -> DescribePhoneNumbersResultTypeDef: # (2)
...
# describe_phone_numbers method usage example with argument unpacking
kwargs: DescribePhoneNumbersRequestRequestTypeDef = { # (1)
"PhoneNumberIds": ...,
}
parent.describe_phone_numbers(**kwargs)
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 = ...,
) -> DescribePoolsResultTypeDef: # (2)
...
# describe_pools method usage example with argument unpacking
kwargs: DescribePoolsRequestRequestTypeDef = { # (1)
"PoolIds": ...,
}
parent.describe_pools(**kwargs)
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 = ...,
) -> DescribeSenderIdsResultTypeDef: # (3)
...
# describe_sender_ids method usage example with argument unpacking
kwargs: DescribeSenderIdsRequestRequestTypeDef = { # (1)
"SenderIds": ...,
}
parent.describe_sender_ids(**kwargs)
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
# describe_spend_limits method definition
def describe_spend_limits(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeSpendLimitsResultTypeDef: # (1)
...
# describe_spend_limits method usage example with argument unpacking
kwargs: DescribeSpendLimitsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.describe_spend_limits(**kwargs)
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)
...
# disassociate_origination_identity method usage example with argument unpacking
kwargs: DisassociateOriginationIdentityRequestRequestTypeDef = { # (1)
"PoolId": ...,
"OriginationIdentity": ...,
"IsoCountryCode": ...,
}
parent.disassociate_origination_identity(**kwargs)
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:
...
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)
...
# list_pool_origination_identities method usage example with argument unpacking
kwargs: ListPoolOriginationIdentitiesRequestRequestTypeDef = { # (1)
"PoolId": ...,
}
parent.list_pool_origination_identities(**kwargs)
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)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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)
...
# put_keyword method usage example with argument unpacking
kwargs: PutKeywordRequestRequestTypeDef = { # (1)
"OriginationIdentity": ...,
"Keyword": ...,
"KeywordMessage": ...,
}
parent.put_keyword(**kwargs)
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)
...
# put_opted_out_number method usage example with argument unpacking
kwargs: PutOptedOutNumberRequestRequestTypeDef = { # (1)
"OptOutListName": ...,
"OptedOutNumber": ...,
}
parent.put_opted_out_number(**kwargs)
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)
...
# release_phone_number method usage example with argument unpacking
kwargs: ReleasePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.release_phone_number(**kwargs)
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)
...
- See MessageTypeType
- See NumberCapabilityType
- See RequestableNumberTypeType
- See TagTypeDef
- See RequestPhoneNumberResultTypeDef
# request_phone_number method usage example with argument unpacking
kwargs: RequestPhoneNumberRequestRequestTypeDef = { # (1)
"IsoCountryCode": ...,
"MessageType": ...,
"NumberCapabilities": ...,
"NumberType": ...,
}
parent.request_phone_number(**kwargs)
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 = ...,
) -> SendTextMessageResultTypeDef: # (3)
...
# send_text_message method usage example with argument unpacking
kwargs: SendTextMessageRequestRequestTypeDef = { # (1)
"DestinationPhoneNumber": ...,
}
parent.send_text_message(**kwargs)
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
# 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 = ...,
) -> SendVoiceMessageResultTypeDef: # (3)
...
# send_voice_message method usage example with argument unpacking
kwargs: SendVoiceMessageRequestRequestTypeDef = { # (1)
"DestinationPhoneNumber": ...,
"OriginationIdentity": ...,
}
parent.send_voice_message(**kwargs)
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)
...
# set_default_message_type method usage example with argument unpacking
kwargs: SetDefaultMessageTypeRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"MessageType": ...,
}
parent.set_default_message_type(**kwargs)
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)
...
# set_default_sender_id method usage example with argument unpacking
kwargs: SetDefaultSenderIdRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"SenderId": ...,
}
parent.set_default_sender_id(**kwargs)
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)
...
# set_text_message_spend_limit_override method usage example with argument unpacking
kwargs: SetTextMessageSpendLimitOverrideRequestRequestTypeDef = { # (1)
"MonthlyLimit": ...,
}
parent.set_text_message_spend_limit_override(**kwargs)
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)
...
# set_voice_message_spend_limit_override method usage example with argument unpacking
kwargs: SetVoiceMessageSpendLimitOverrideRequestRequestTypeDef = { # (1)
"MonthlyLimit": ...,
}
parent.set_voice_message_spend_limit_override(**kwargs)
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
# tag_resource method definition
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
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
# 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)
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)
...
- See EventTypeType
- See CloudWatchLogsDestinationTypeDef
- See KinesisFirehoseDestinationTypeDef
- See SnsDestinationTypeDef
- See UpdateEventDestinationResultTypeDef
# update_event_destination method usage example with argument unpacking
kwargs: UpdateEventDestinationRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"EventDestinationName": ...,
}
parent.update_event_destination(**kwargs)
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 = ...,
SelfManagedOptOutsEnabled: bool = ...,
OptOutListName: str = ...,
DeletionProtectionEnabled: bool = ...,
) -> UpdatePhoneNumberResultTypeDef: # (1)
...
# update_phone_number method usage example with argument unpacking
kwargs: UpdatePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.update_phone_number(**kwargs)
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 = ...,
SelfManagedOptOutsEnabled: bool = ...,
OptOutListName: str = ...,
SharedRoutesEnabled: bool = ...,
DeletionProtectionEnabled: bool = ...,
) -> UpdatePoolResultTypeDef: # (1)
...
# update_pool method usage example with argument unpacking
kwargs: UpdatePoolRequestRequestTypeDef = { # (1)
"PoolId": ...,
}
parent.update_pool(**kwargs)
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")
-> DescribeAccountAttributesPaginatorclient.get_paginator("describe_account_limits")
-> DescribeAccountLimitsPaginatorclient.get_paginator("describe_configuration_sets")
-> DescribeConfigurationSetsPaginatorclient.get_paginator("describe_keywords")
-> DescribeKeywordsPaginatorclient.get_paginator("describe_opt_out_lists")
-> DescribeOptOutListsPaginatorclient.get_paginator("describe_opted_out_numbers")
-> DescribeOptedOutNumbersPaginatorclient.get_paginator("describe_phone_numbers")
-> DescribePhoneNumbersPaginatorclient.get_paginator("describe_pools")
-> DescribePoolsPaginatorclient.get_paginator("describe_sender_ids")
-> DescribeSenderIdsPaginatorclient.get_paginator("describe_spend_limits")
-> DescribeSpendLimitsPaginatorclient.get_paginator("list_pool_origination_identities")
-> ListPoolOriginationIdentitiesPaginator