Class: Aws::PinpointSMSVoiceV2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::PinpointSMSVoiceV2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb
Overview
An API client for PinpointSMSVoiceV2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::PinpointSMSVoiceV2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_origination_identity(params = {}) ⇒ Types::AssociateOriginationIdentityResult
Associates the specified origination identity with a pool.
-
#create_configuration_set(params = {}) ⇒ Types::CreateConfigurationSetResult
Creates a new configuration set.
-
#create_event_destination(params = {}) ⇒ Types::CreateEventDestinationResult
Creates a new event destination in a configuration set.
-
#create_opt_out_list(params = {}) ⇒ Types::CreateOptOutListResult
Creates a new opt-out list.
-
#create_pool(params = {}) ⇒ Types::CreatePoolResult
Creates a new pool and associates the specified origination identity to the pool.
-
#delete_configuration_set(params = {}) ⇒ Types::DeleteConfigurationSetResult
Deletes an existing configuration set.
-
#delete_default_message_type(params = {}) ⇒ Types::DeleteDefaultMessageTypeResult
Deletes an existing default message type on a configuration set.
-
#delete_default_sender_id(params = {}) ⇒ Types::DeleteDefaultSenderIdResult
Deletes an existing default sender ID on a configuration set.
-
#delete_event_destination(params = {}) ⇒ Types::DeleteEventDestinationResult
Deletes an existing event destination.
-
#delete_keyword(params = {}) ⇒ Types::DeleteKeywordResult
Deletes an existing keyword from an origination phone number or pool.
-
#delete_opt_out_list(params = {}) ⇒ Types::DeleteOptOutListResult
Deletes an existing opt-out list.
-
#delete_opted_out_number(params = {}) ⇒ Types::DeleteOptedOutNumberResult
Deletes an existing opted out destination phone number from the specified opt-out list.
-
#delete_pool(params = {}) ⇒ Types::DeletePoolResult
Deletes an existing pool.
-
#delete_text_message_spend_limit_override(params = {}) ⇒ Types::DeleteTextMessageSpendLimitOverrideResult
Deletes an account-level monthly spending limit override for sending text messages.
-
#delete_voice_message_spend_limit_override(params = {}) ⇒ Types::DeleteVoiceMessageSpendLimitOverrideResult
Deletes an account level monthly spend limit override for sending voice messages.
-
#describe_account_attributes(params = {}) ⇒ Types::DescribeAccountAttributesResult
Describes attributes of your Amazon Web Services account.
-
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsResult
Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account.
-
#describe_configuration_sets(params = {}) ⇒ Types::DescribeConfigurationSetsResult
Describes the specified configuration sets or all in your account.
-
#describe_keywords(params = {}) ⇒ Types::DescribeKeywordsResult
Describes the specified keywords or all keywords on your origination phone number or pool.
-
#describe_opt_out_lists(params = {}) ⇒ Types::DescribeOptOutListsResult
Describes the specified opt-out list or all opt-out lists in your account.
-
#describe_opted_out_numbers(params = {}) ⇒ Types::DescribeOptedOutNumbersResult
Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
-
#describe_phone_numbers(params = {}) ⇒ Types::DescribePhoneNumbersResult
Describes the specified origination phone number, or all the phone numbers in your account.
-
#describe_pools(params = {}) ⇒ Types::DescribePoolsResult
Retrieves the specified pools or all pools associated with your Amazon Web Services account.
-
#describe_sender_ids(params = {}) ⇒ Types::DescribeSenderIdsResult
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
-
#describe_spend_limits(params = {}) ⇒ Types::DescribeSpendLimitsResult
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
-
#disassociate_origination_identity(params = {}) ⇒ Types::DisassociateOriginationIdentityResult
Removes the specified origination identity from an existing pool.
-
#list_pool_origination_identities(params = {}) ⇒ Types::ListPoolOriginationIdentitiesResult
Lists all associated origination identities in your pool.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
List all tags associated with a resource.
-
#put_keyword(params = {}) ⇒ Types::PutKeywordResult
Creates or updates a keyword configuration on an origination phone number or pool.
-
#put_opted_out_number(params = {}) ⇒ Types::PutOptedOutNumberResult
Creates an opted out destination phone number in the opt-out list.
-
#release_phone_number(params = {}) ⇒ Types::ReleasePhoneNumberResult
Releases an existing origination phone number in your account.
-
#request_phone_number(params = {}) ⇒ Types::RequestPhoneNumberResult
Request an origination phone number for use in your account.
-
#send_text_message(params = {}) ⇒ Types::SendTextMessageResult
Creates a new text message and sends it to a recipient's phone number.
-
#send_voice_message(params = {}) ⇒ Types::SendVoiceMessageResult
Allows you to send a request that sends a text message through Amazon Pinpoint.
-
#set_default_message_type(params = {}) ⇒ Types::SetDefaultMessageTypeResult
Sets the default message type on a configuration set.
-
#set_default_sender_id(params = {}) ⇒ Types::SetDefaultSenderIdResult
Sets default sender ID on a configuration set.
-
#set_text_message_spend_limit_override(params = {}) ⇒ Types::SetTextMessageSpendLimitOverrideResult
Sets an account level monthly spend limit override for sending text messages.
-
#set_voice_message_spend_limit_override(params = {}) ⇒ Types::SetVoiceMessageSpendLimitOverrideResult
Sets an account level monthly spend limit override for sending voice messages.
-
#tag_resource(params = {}) ⇒ Struct
Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource.
-
#update_event_destination(params = {}) ⇒ Types::UpdateEventDestinationResult
Updates an existing event destination in a configuration set.
-
#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResult
Updates the configuration of an existing origination phone number.
-
#update_pool(params = {}) ⇒ Types::UpdatePoolResult
Updates the configuration of an existing pool.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
358 359 360 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 358 def initialize(*args) super end |
Instance Method Details
#associate_origination_identity(params = {}) ⇒ Types::AssociateOriginationIdentityResult
Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an Error is returned.
426 427 428 429 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 426 def associate_origination_identity(params = {}, = {}) req = build_request(:associate_origination_identity, params) req.send_request() end |
#create_configuration_set(params = {}) ⇒ Types::CreateConfigurationSetResult
Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
489 490 491 492 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 489 def create_configuration_set(params = {}, = {}) req = build_request(:create_configuration_set, params) req.send_request() end |
#create_event_destination(params = {}) ⇒ Types::CreateEventDestinationResult
Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
585 586 587 588 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 585 def create_event_destination(params = {}, = {}) req = build_request(:create_event_destination, params) req.send_request() end |
#create_opt_out_list(params = {}) ⇒ Types::CreateOptOutListResult
Creates a new opt-out list.
If the opt-out list name already exists, an Error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
655 656 657 658 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 655 def create_opt_out_list(params = {}, = {}) req = build_request(:create_opt_out_list, params) req.send_request() end |
#create_pool(params = {}) ⇒ Types::CreatePoolResult
Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.
758 759 760 761 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 758 def create_pool(params = {}, = {}) req = build_request(:create_pool, params) req.send_request() end |
#delete_configuration_set(params = {}) ⇒ Types::DeleteConfigurationSetResult
Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
812 813 814 815 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 812 def delete_configuration_set(params = {}, = {}) req = build_request(:delete_configuration_set, params) req.send_request() end |
#delete_default_message_type(params = {}) ⇒ Types::DeleteDefaultMessageTypeResult
Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
854 855 856 857 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 854 def (params = {}, = {}) req = build_request(:delete_default_message_type, params) req.send_request() end |
#delete_default_sender_id(params = {}) ⇒ Types::DeleteDefaultSenderIdResult
Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
893 894 895 896 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 893 def delete_default_sender_id(params = {}, = {}) req = build_request(:delete_default_sender_id, params) req.send_request() end |
#delete_event_destination(params = {}) ⇒ Types::DeleteEventDestinationResult
Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
946 947 948 949 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 946 def delete_event_destination(params = {}, = {}) req = build_request(:delete_event_destination, params) req.send_request() end |
#delete_keyword(params = {}) ⇒ Types::DeleteKeywordResult
Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
Keywords "HELP" and "STOP" can't be deleted or modified.
998 999 1000 1001 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 998 def delete_keyword(params = {}, = {}) req = build_request(:delete_keyword, params) req.send_request() end |
#delete_opt_out_list(params = {}) ⇒ Types::DeleteOptOutListResult
Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an Error is returned.
1036 1037 1038 1039 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1036 def delete_opt_out_list(params = {}, = {}) req = build_request(:delete_opt_out_list, params) req.send_request() end |
#delete_opted_out_number(params = {}) ⇒ Types::DeleteOptedOutNumberResult
Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an Error is returned.
1082 1083 1084 1085 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1082 def delete_opted_out_number(params = {}, = {}) req = build_request(:delete_opted_out_number, params) req.send_request() end |
#delete_pool(params = {}) ⇒ Types::DeletePoolResult
Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an Error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
1137 1138 1139 1140 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1137 def delete_pool(params = {}, = {}) req = build_request(:delete_pool, params) req.send_request() end |
#delete_text_message_spend_limit_override(params = {}) ⇒ Types::DeleteTextMessageSpendLimitOverrideResult
Deletes an account-level monthly spending limit override for sending
text messages. Deleting a spend limit override will set the
EnforcedLimit
to equal the MaxLimit
, which is controlled by Amazon
Web Services. For more information on spend limits (quotas) see
Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
1164 1165 1166 1167 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1164 def (params = {}, = {}) req = build_request(:delete_text_message_spend_limit_override, params) req.send_request() end |
#delete_voice_message_spend_limit_override(params = {}) ⇒ Types::DeleteVoiceMessageSpendLimitOverrideResult
Deletes an account level monthly spend limit override for sending
voice messages. Deleting a spend limit override sets the
EnforcedLimit
equal to the MaxLimit
, which is controlled by Amazon
Web Services. For more information on spending limits (quotas) see
Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1191 def (params = {}, = {}) req = build_request(:delete_voice_message_spend_limit_override, params) req.send_request() end |
#describe_account_attributes(params = {}) ⇒ Types::DescribeAccountAttributesResult
Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1238 1239 1240 1241 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1238 def describe_account_attributes(params = {}, = {}) req = build_request(:describe_account_attributes, params) req.send_request() end |
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsResult
Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1290 1291 1292 1293 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1290 def describe_account_limits(params = {}, = {}) req = build_request(:describe_account_limits, params) req.send_request() end |
#describe_configuration_sets(params = {}) ⇒ Types::DescribeConfigurationSetsResult
Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1366 1367 1368 1369 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1366 def describe_configuration_sets(params = {}, = {}) req = build_request(:describe_configuration_sets, params) req.send_request() end |
#describe_keywords(params = {}) ⇒ Types::DescribeKeywordsResult
Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an Error is returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1441 1442 1443 1444 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1441 def describe_keywords(params = {}, = {}) req = build_request(:describe_keywords, params) req.send_request() end |
#describe_opt_out_lists(params = {}) ⇒ Types::DescribeOptOutListsResult
Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an Error is returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1496 1497 1498 1499 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1496 def describe_opt_out_lists(params = {}, = {}) req = build_request(:describe_opt_out_lists, params) req.send_request() end |
#describe_opted_out_numbers(params = {}) ⇒ Types::DescribeOptedOutNumbersResult
Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an Error is returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1570 1571 1572 1573 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1570 def describe_opted_out_numbers(params = {}, = {}) req = build_request(:describe_opted_out_numbers, params) req.send_request() end |
#describe_phone_numbers(params = {}) ⇒ Types::DescribePhoneNumbersResult
Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an Error is returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1649 1650 1651 1652 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1649 def describe_phone_numbers(params = {}, = {}) req = build_request(:describe_phone_numbers, params) req.send_request() end |
#describe_pools(params = {}) ⇒ Types::DescribePoolsResult
Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an Error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1724 1725 1726 1727 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1724 def describe_pools(params = {}, = {}) req = build_request(:describe_pools, params) req.send_request() end |
#describe_sender_ids(params = {}) ⇒ Types::DescribeSenderIdsResult
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an Error is returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1794 1795 1796 1797 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1794 def describe_sender_ids(params = {}, = {}) req = build_request(:describe_sender_ids, params) req.send_request() end |
#describe_spend_limits(params = {}) ⇒ Types::DescribeSpendLimitsResult
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1846 1847 1848 1849 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1846 def describe_spend_limits(params = {}, = {}) req = build_request(:describe_spend_limits, params) req.send_request() end |
#disassociate_origination_identity(params = {}) ⇒ Types::DisassociateOriginationIdentityResult
Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an Error is returned.
1909 1910 1911 1912 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1909 def disassociate_origination_identity(params = {}, = {}) req = build_request(:disassociate_origination_identity, params) req.send_request() end |
#list_pool_origination_identities(params = {}) ⇒ Types::ListPoolOriginationIdentitiesResult
Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1973 1974 1975 1976 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1973 def list_pool_origination_identities(params = {}, = {}) req = build_request(:list_pool_origination_identities, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
List all tags associated with a resource.
2005 2006 2007 2008 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2005 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_keyword(params = {}) ⇒ Types::PutKeywordResult
Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an Error is returned.
2073 2074 2075 2076 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2073 def put_keyword(params = {}, = {}) req = build_request(:put_keyword, params) req.send_request() end |
#put_opted_out_number(params = {}) ⇒ Types::PutOptedOutNumberResult
Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an Error is returned.
2116 2117 2118 2119 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2116 def put_opted_out_number(params = {}, = {}) req = build_request(:put_opted_out_number, params) req.send_request() end |
#release_phone_number(params = {}) ⇒ Types::ReleasePhoneNumberResult
Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an Error is returned.
2177 2178 2179 2180 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2177 def release_phone_number(params = {}, = {}) req = build_request(:release_phone_number, params) req.send_request() end |
#request_phone_number(params = {}) ⇒ Types::RequestPhoneNumberResult
Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
2302 2303 2304 2305 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2302 def request_phone_number(params = {}, = {}) req = build_request(:request_phone_number, params) req.send_request() end |
#send_text_message(params = {}) ⇒ Types::SendTextMessageResult
Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
2402 2403 2404 2405 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2402 def (params = {}, = {}) req = build_request(:send_text_message, params) req.send_request() end |
#send_voice_message(params = {}) ⇒ Types::SendVoiceMessageResult
Allows you to send a request that sends a text message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
2494 2495 2496 2497 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2494 def (params = {}, = {}) req = build_request(:send_voice_message, params) req.send_request() end |
#set_default_message_type(params = {}) ⇒ Types::SetDefaultMessageTypeResult
Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
2540 2541 2542 2543 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2540 def (params = {}, = {}) req = build_request(:set_default_message_type, params) req.send_request() end |
#set_default_sender_id(params = {}) ⇒ Types::SetDefaultSenderIdResult
Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
2587 2588 2589 2590 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2587 def set_default_sender_id(params = {}, = {}) req = build_request(:set_default_sender_id, params) req.send_request() end |
#set_text_message_spend_limit_override(params = {}) ⇒ Types::SetTextMessageSpendLimitOverrideResult
Sets an account level monthly spend limit override for sending text
messages. The requested spend limit must be less than or equal to the
MaxLimit
, which is set by Amazon Web Services.
2617 2618 2619 2620 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2617 def (params = {}, = {}) req = build_request(:set_text_message_spend_limit_override, params) req.send_request() end |
#set_voice_message_spend_limit_override(params = {}) ⇒ Types::SetVoiceMessageSpendLimitOverrideResult
Sets an account level monthly spend limit override for sending voice
messages. The requested spend limit must be less than or equal to the
MaxLimit
, which is set by Amazon Web Services.
2647 2648 2649 2650 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2647 def (params = {}, = {}) req = build_request(:set_voice_message_spend_limit_override, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
2689 2690 2691 2692 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2689 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
2722 2723 2724 2725 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2722 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_event_destination(params = {}) ⇒ Types::UpdateEventDestinationResult
Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
2806 2807 2808 2809 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2806 def update_event_destination(params = {}, = {}) req = build_request(:update_event_destination, params) req.send_request() end |
#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResult
Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an Error is returned.
2898 2899 2900 2901 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2898 def update_phone_number(params = {}, = {}) req = build_request(:update_phone_number, params) req.send_request() end |
#update_pool(params = {}) ⇒ Types::UpdatePoolResult
Updates the configuration of an existing pool. You can update the
opt-out list, enable or disable two-way messaging, change the
TwoWayChannelArn
, enable or disable self-managed opt-outs, enable or
disable deletion protection, and enable or disable shared routes.
2981 2982 2983 2984 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2981 def update_pool(params = {}, = {}) req = build_request(:update_pool, params) req.send_request() end |