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.
-
#associate_protect_configuration(params = {}) ⇒ Types::AssociateProtectConfigurationResult
Associate a protect configuration with a configuration set.
-
#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.
-
#create_protect_configuration(params = {}) ⇒ Types::CreateProtectConfigurationResult
Create a new protect configuration.
-
#create_registration(params = {}) ⇒ Types::CreateRegistrationResult
Creates a new registration based on the RegistrationType field.
-
#create_registration_association(params = {}) ⇒ Types::CreateRegistrationAssociationResult
Associate the registration with an origination identity such as a phone number or sender ID.
-
#create_registration_attachment(params = {}) ⇒ Types::CreateRegistrationAttachmentResult
Create a new registration attachment to use for uploading a file or a URL to a file.
-
#create_registration_version(params = {}) ⇒ Types::CreateRegistrationVersionResult
Create a new version of the registration and increase the VersionNumber.
-
#create_verified_destination_number(params = {}) ⇒ Types::CreateVerifiedDestinationNumberResult
You can only send messages to verified destination numbers when your account is in the sandbox.
-
#delete_account_default_protect_configuration(params = {}) ⇒ Types::DeleteAccountDefaultProtectConfigurationResult
Removes the current account default protect configuration.
-
#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_media_message_spend_limit_override(params = {}) ⇒ Types::DeleteMediaMessageSpendLimitOverrideResult
Deletes an account-level monthly spending limit override for sending multimedia messages (MMS).
-
#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_protect_configuration(params = {}) ⇒ Types::DeleteProtectConfigurationResult
Permanently delete the protect configuration.
-
#delete_registration(params = {}) ⇒ Types::DeleteRegistrationResult
Permanently delete an existing registration from your account.
-
#delete_registration_attachment(params = {}) ⇒ Types::DeleteRegistrationAttachmentResult
Permanently delete the specified registration attachment.
-
#delete_registration_field_value(params = {}) ⇒ Types::DeleteRegistrationFieldValueResult
Delete the value in a registration form field.
-
#delete_resource_policy(params = {}) ⇒ Types::DeleteResourcePolicyResult
Deletes the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource.
-
#delete_text_message_spend_limit_override(params = {}) ⇒ Types::DeleteTextMessageSpendLimitOverrideResult
Deletes an account-level monthly spending limit override for sending text messages.
-
#delete_verified_destination_number(params = {}) ⇒ Types::DeleteVerifiedDestinationNumberResult
Delete a verified destination phone number.
-
#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 AWS End User Messaging SMS and Voice 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_protect_configurations(params = {}) ⇒ Types::DescribeProtectConfigurationsResult
Retrieves the protect configurations that match any of filters.
-
#describe_registration_attachments(params = {}) ⇒ Types::DescribeRegistrationAttachmentsResult
Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
-
#describe_registration_field_definitions(params = {}) ⇒ Types::DescribeRegistrationFieldDefinitionsResult
Retrieves the specified registration type field definitions.
-
#describe_registration_field_values(params = {}) ⇒ Types::DescribeRegistrationFieldValuesResult
Retrieves the specified registration field values.
-
#describe_registration_section_definitions(params = {}) ⇒ Types::DescribeRegistrationSectionDefinitionsResult
Retrieves the specified registration section definitions.
-
#describe_registration_type_definitions(params = {}) ⇒ Types::DescribeRegistrationTypeDefinitionsResult
Retrieves the specified registration type definitions.
-
#describe_registration_versions(params = {}) ⇒ Types::DescribeRegistrationVersionsResult
Retrieves the specified registration version.
-
#describe_registrations(params = {}) ⇒ Types::DescribeRegistrationsResult
Retrieves the specified registrations.
-
#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 monthly spend limits for sending voice and text messages.
-
#describe_verified_destination_numbers(params = {}) ⇒ Types::DescribeVerifiedDestinationNumbersResult
Retrieves the specified verified destiona numbers.
-
#disassociate_origination_identity(params = {}) ⇒ Types::DisassociateOriginationIdentityResult
Removes the specified origination identity from an existing pool.
-
#disassociate_protect_configuration(params = {}) ⇒ Types::DisassociateProtectConfigurationResult
Disassociate a protect configuration from a configuration set.
-
#discard_registration_version(params = {}) ⇒ Types::DiscardRegistrationVersionResult
Discard the current version of the registration.
-
#get_protect_configuration_country_rule_set(params = {}) ⇒ Types::GetProtectConfigurationCountryRuleSetResult
Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResult
Retrieves the JSON text of the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource.
-
#list_pool_origination_identities(params = {}) ⇒ Types::ListPoolOriginationIdentitiesResult
Lists all associated origination identities in your pool.
-
#list_registration_associations(params = {}) ⇒ Types::ListRegistrationAssociationsResult
Retreive all of the origination identies that are associated with a registration.
-
#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.
-
#put_registration_field_value(params = {}) ⇒ Types::PutRegistrationFieldValueResult
Creates or updates a field value for a registration.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResult
Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the resource.
-
#release_phone_number(params = {}) ⇒ Types::ReleasePhoneNumberResult
Releases an existing origination phone number in your account.
-
#release_sender_id(params = {}) ⇒ Types::ReleaseSenderIdResult
Releases an existing sender ID in your account.
-
#request_phone_number(params = {}) ⇒ Types::RequestPhoneNumberResult
Request an origination phone number for use in your account.
-
#request_sender_id(params = {}) ⇒ Types::RequestSenderIdResult
Request a new sender ID that doesn't require registration.
-
#send_destination_number_verification_code(params = {}) ⇒ Types::SendDestinationNumberVerificationCodeResult
Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number.
-
#send_media_message(params = {}) ⇒ Types::SendMediaMessageResult
Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
-
#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 voice message.
-
#set_account_default_protect_configuration(params = {}) ⇒ Types::SetAccountDefaultProtectConfigurationResult
Set a protect configuration as your account default.
-
#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_media_message_spend_limit_override(params = {}) ⇒ Types::SetMediaMessageSpendLimitOverrideResult
Sets an account level monthly spend limit override for sending MMS messages.
-
#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.
-
#submit_registration_version(params = {}) ⇒ Types::SubmitRegistrationVersionResult
Submit the specified registration for review and approval.
-
#tag_resource(params = {}) ⇒ Struct
Adds or overwrites only the specified tags for the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the association of the specified tags from a 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.
-
#update_protect_configuration(params = {}) ⇒ Types::UpdateProtectConfigurationResult
Update the setting for an existing protect configuration.
-
#update_protect_configuration_country_rule_set(params = {}) ⇒ Types::UpdateProtectConfigurationCountryRuleSetResult
Update a country rule set to
ALLOW
orBLOCK
messages to be sent to the specified destination counties. -
#update_sender_id(params = {}) ⇒ Types::UpdateSenderIdResult
Updates the configuration of an existing sender ID.
-
#verify_destination_number(params = {}) ⇒ Types::VerifyDestinationNumberResult
Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
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.
451 452 453 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 451 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.
525 526 527 528 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 525 def associate_origination_identity(params = {}, = {}) req = build_request(:associate_origination_identity, params) req.send_request() end |
#associate_protect_configuration(params = {}) ⇒ Types::AssociateProtectConfigurationResult
Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
567 568 569 570 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 567 def associate_protect_configuration(params = {}, = {}) req = build_request(:associate_protect_configuration, 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.
630 631 632 633 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 630 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 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 Firehose destination.
730 731 732 733 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 730 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 AWS End User Messaging SMS User Guide.
800 801 802 803 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 800 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.
916 917 918 919 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 916 def create_pool(params = {}, = {}) req = build_request(:create_pool, params) req.send_request() end |
#create_protect_configuration(params = {}) ⇒ Types::CreateProtectConfigurationResult
Create a new protect configuration. By default all country rule sets
for each capability are set to ALLOW
. Update the country rule sets
using UpdateProtectConfigurationCountryRuleSet
. A protect
configurations name is stored as a Tag with the key set to Name
and
value as the name of the protect configuration.
981 982 983 984 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 981 def create_protect_configuration(params = {}, = {}) req = build_request(:create_protect_configuration, params) req.send_request() end |
#create_registration(params = {}) ⇒ Types::CreateRegistrationResult
Creates a new registration based on the RegistrationType field.
1048 1049 1050 1051 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1048 def create_registration(params = {}, = {}) req = build_request(:create_registration, params) req.send_request() end |
#create_registration_association(params = {}) ⇒ Types::CreateRegistrationAssociationResult
Associate the registration with an origination identity such as a phone number or sender ID.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1096 def create_registration_association(params = {}, = {}) req = build_request(:create_registration_association, params) req.send_request() end |
#create_registration_attachment(params = {}) ⇒ Types::CreateRegistrationAttachmentResult
Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
Use either AttachmentUrl
or AttachmentBody
to upload your
attachment. If both are specified then an exception is returned.
1167 1168 1169 1170 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1167 def (params = {}, = {}) req = build_request(:create_registration_attachment, params) req.send_request() end |
#create_registration_version(params = {}) ⇒ Types::CreateRegistrationVersionResult
Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
1213 1214 1215 1216 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1213 def create_registration_version(params = {}, = {}) req = build_request(:create_registration_version, params) req.send_request() end |
#create_verified_destination_number(params = {}) ⇒ Types::CreateVerifiedDestinationNumberResult
You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
1275 1276 1277 1278 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1275 def create_verified_destination_number(params = {}, = {}) req = build_request(:create_verified_destination_number, params) req.send_request() end |
#delete_account_default_protect_configuration(params = {}) ⇒ Types::DeleteAccountDefaultProtectConfigurationResult
Removes the current account default protect configuration.
1296 1297 1298 1299 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1296 def delete_account_default_protect_configuration(params = {}, = {}) req = build_request(:delete_account_default_protect_configuration, 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.
1350 1351 1352 1353 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1350 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.
1392 1393 1394 1395 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1392 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.
1431 1432 1433 1434 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1431 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.
1484 1485 1486 1487 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1484 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, AWS End User Messaging SMS and Voice responds with a customizable message.
Keywords "HELP" and "STOP" can't be deleted or modified.
1539 1540 1541 1542 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1539 def delete_keyword(params = {}, = {}) req = build_request(:delete_keyword, params) req.send_request() end |
#delete_media_message_spend_limit_override(params = {}) ⇒ Types::DeleteMediaMessageSpendLimitOverrideResult
Deletes an account-level monthly spending limit override for sending
multimedia messages (MMS). 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
Quotas for Server Migration Service in the Server Migration
Service User Guide.
1567 1568 1569 1570 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1567 def (params = {}, = {}) req = build_request(:delete_media_message_spend_limit_override, 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.
1608 1609 1610 1611 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1608 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.
1657 1658 1659 1660 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1657 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.
1717 1718 1719 1720 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1717 def delete_pool(params = {}, = {}) req = build_request(:delete_pool, params) req.send_request() end |
#delete_protect_configuration(params = {}) ⇒ Types::DeleteProtectConfigurationResult
Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.
1756 1757 1758 1759 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1756 def delete_protect_configuration(params = {}, = {}) req = build_request(:delete_protect_configuration, params) req.send_request() end |
#delete_registration(params = {}) ⇒ Types::DeleteRegistrationResult
Permanently delete an existing registration from your account.
1801 1802 1803 1804 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1801 def delete_registration(params = {}, = {}) req = build_request(:delete_registration, params) req.send_request() end |
#delete_registration_attachment(params = {}) ⇒ Types::DeleteRegistrationAttachmentResult
Permanently delete the specified registration attachment.
1837 1838 1839 1840 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1837 def (params = {}, = {}) req = build_request(:delete_registration_attachment, params) req.send_request() end |
#delete_registration_field_value(params = {}) ⇒ Types::DeleteRegistrationFieldValueResult
Delete the value in a registration form field.
1883 1884 1885 1886 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1883 def delete_registration_field_value(params = {}, = {}) req = build_request(:delete_registration_field_value, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Types::DeleteResourcePolicyResult
Deletes the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.
1918 1919 1920 1921 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1918 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, 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
Quotas in the AWS End User Messaging SMS User Guide.
1945 1946 1947 1948 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1945 def (params = {}, = {}) req = build_request(:delete_text_message_spend_limit_override, params) req.send_request() end |
#delete_verified_destination_number(params = {}) ⇒ Types::DeleteVerifiedDestinationNumberResult
Delete a verified destination phone number.
1979 1980 1981 1982 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1979 def delete_verified_destination_number(params = {}, = {}) req = build_request(:delete_verified_destination_number, 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
Quotas in the AWS End User Messaging SMS User Guide.
2006 2007 2008 2009 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2006 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 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.
2053 2054 2055 2056 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2053 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 AWS End User Messaging SMS and Voice 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 Quotas in the AWS End User Messaging SMS User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2106 2107 2108 2109 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2106 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.
2183 2184 2185 2186 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2183 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, AWS End User Messaging SMS and Voice 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.
2261 2262 2263 2264 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2261 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.
2326 2327 2328 2329 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2326 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 exception is returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2406 2407 2408 2409 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2406 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.
2497 2498 2499 2500 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2497 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.
2582 2583 2584 2585 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2582 def describe_pools(params = {}, = {}) req = build_request(:describe_pools, params) req.send_request() end |
#describe_protect_configurations(params = {}) ⇒ Types::DescribeProtectConfigurationsResult
Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2638 2639 2640 2641 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2638 def describe_protect_configurations(params = {}, = {}) req = build_request(:describe_protect_configurations, params) req.send_request() end |
#describe_registration_attachments(params = {}) ⇒ Types::DescribeRegistrationAttachmentsResult
Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2696 2697 2698 2699 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2696 def (params = {}, = {}) req = build_request(:describe_registration_attachments, params) req.send_request() end |
#describe_registration_field_definitions(params = {}) ⇒ Types::DescribeRegistrationFieldDefinitionsResult
Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2772 2773 2774 2775 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2772 def describe_registration_field_definitions(params = {}, = {}) req = build_request(:describe_registration_field_definitions, params) req.send_request() end |
#describe_registration_field_values(params = {}) ⇒ Types::DescribeRegistrationFieldValuesResult
Retrieves the specified registration field values.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2837 2838 2839 2840 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2837 def describe_registration_field_values(params = {}, = {}) req = build_request(:describe_registration_field_values, params) req.send_request() end |
#describe_registration_section_definitions(params = {}) ⇒ Types::DescribeRegistrationSectionDefinitionsResult
Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2893 2894 2895 2896 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2893 def describe_registration_section_definitions(params = {}, = {}) req = build_request(:describe_registration_section_definitions, params) req.send_request() end |
#describe_registration_type_definitions(params = {}) ⇒ Types::DescribeRegistrationTypeDefinitionsResult
Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2957 2958 2959 2960 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2957 def describe_registration_type_definitions(params = {}, = {}) req = build_request(:describe_registration_type_definitions, params) req.send_request() end |
#describe_registration_versions(params = {}) ⇒ Types::DescribeRegistrationVersionsResult
Retrieves the specified registration version.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3032 3033 3034 3035 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3032 def describe_registration_versions(params = {}, = {}) req = build_request(:describe_registration_versions, params) req.send_request() end |
#describe_registrations(params = {}) ⇒ Types::DescribeRegistrationsResult
Retrieves the specified registrations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3092 3093 3094 3095 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3092 def describe_registrations(params = {}, = {}) req = build_request(:describe_registrations, 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.
3174 3175 3176 3177 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3174 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 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, MMS, or Voice spending quota in the AWS End User Messaging SMS User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3226 3227 3228 3229 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3226 def describe_spend_limits(params = {}, = {}) req = build_request(:describe_spend_limits, params) req.send_request() end |
#describe_verified_destination_numbers(params = {}) ⇒ Types::DescribeVerifiedDestinationNumbersResult
Retrieves the specified verified destiona numbers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3286 3287 3288 3289 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3286 def describe_verified_destination_numbers(params = {}, = {}) req = build_request(:describe_verified_destination_numbers, 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.
3355 3356 3357 3358 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3355 def disassociate_origination_identity(params = {}, = {}) req = build_request(:disassociate_origination_identity, params) req.send_request() end |
#disassociate_protect_configuration(params = {}) ⇒ Types::DisassociateProtectConfigurationResult
Disassociate a protect configuration from a configuration set.
3393 3394 3395 3396 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3393 def disassociate_protect_configuration(params = {}, = {}) req = build_request(:disassociate_protect_configuration, params) req.send_request() end |
#discard_registration_version(params = {}) ⇒ Types::DiscardRegistrationVersionResult
Discard the current version of the registration.
3437 3438 3439 3440 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3437 def discard_registration_version(params = {}, = {}) req = build_request(:discard_registration_version, params) req.send_request() end |
#get_protect_configuration_country_rule_set(params = {}) ⇒ Types::GetProtectConfigurationCountryRuleSetResult
Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
3478 3479 3480 3481 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3478 def get_protect_configuration_country_rule_set(params = {}, = {}) req = build_request(:get_protect_configuration_country_rule_set, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResult
Retrieves the JSON text of the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.
3513 3514 3515 3516 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3513 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, 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.
3581 3582 3583 3584 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3581 def list_pool_origination_identities(params = {}, = {}) req = build_request(:list_pool_origination_identities, params) req.send_request() end |
#list_registration_associations(params = {}) ⇒ Types::ListRegistrationAssociationsResult
Retreive all of the origination identies that are associated with a registration.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3644 3645 3646 3647 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3644 def list_registration_associations(params = {}, = {}) req = build_request(:list_registration_associations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
List all tags associated with a resource.
3676 3677 3678 3679 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3676 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, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
3747 3748 3749 3750 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3747 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.
3793 3794 3795 3796 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3793 def put_opted_out_number(params = {}, = {}) req = build_request(:put_opted_out_number, params) req.send_request() end |
#put_registration_field_value(params = {}) ⇒ Types::PutRegistrationFieldValueResult
Creates or updates a field value for a registration.
3851 3852 3853 3854 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3851 def put_registration_field_value(params = {}, = {}) req = build_request(:put_registration_field_value, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResult
Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.
3897 3898 3899 3900 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3897 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, 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.
3965 3966 3967 3968 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3965 def release_phone_number(params = {}, = {}) req = build_request(:release_phone_number, params) req.send_request() end |
#release_sender_id(params = {}) ⇒ Types::ReleaseSenderIdResult
Releases an existing sender ID in your account.
4011 4012 4013 4014 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4011 def release_sender_id(params = {}, = {}) req = build_request(:release_sender_id, 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 Request a phone number in the AWS End User Messaging SMS User Guide.
4146 4147 4148 4149 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4146 def request_phone_number(params = {}, = {}) req = build_request(:request_phone_number, params) req.send_request() end |
#request_sender_id(params = {}) ⇒ Types::RequestSenderIdResult
Request a new sender ID that doesn't require registration.
4227 4228 4229 4230 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4227 def request_sender_id(params = {}, = {}) req = build_request(:request_sender_id, params) req.send_request() end |
#send_destination_number_verification_code(params = {}) ⇒ Types::SendDestinationNumberVerificationCodeResult
Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
4303 4304 4305 4306 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4303 def send_destination_number_verification_code(params = {}, = {}) req = build_request(:send_destination_number_verification_code, params) req.send_request() end |
#send_media_message(params = {}) ⇒ Types::SendMediaMessageResult
Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
4391 4392 4393 4394 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4391 def (params = {}, = {}) req = build_request(:send_media_message, 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. SendTextMessage only sends an SMS message to one recipient each time it is invoked.
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 about MPS, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide.
4526 4527 4528 4529 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4526 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 voice message. This operation uses Amazon Polly to convert a text script into a voice message.
4625 4626 4627 4628 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4625 def (params = {}, = {}) req = build_request(:send_voice_message, params) req.send_request() end |
#set_account_default_protect_configuration(params = {}) ⇒ Types::SetAccountDefaultProtectConfigurationResult
Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
4658 4659 4660 4661 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4658 def set_account_default_protect_configuration(params = {}, = {}) req = build_request(:set_account_default_protect_configuration, 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.
4704 4705 4706 4707 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4704 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.
4751 4752 4753 4754 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4751 def set_default_sender_id(params = {}, = {}) req = build_request(:set_default_sender_id, params) req.send_request() end |
#set_media_message_spend_limit_override(params = {}) ⇒ Types::SetMediaMessageSpendLimitOverrideResult
Sets an account level monthly spend limit override for sending MMS
messages. The requested spend limit must be less than or equal to the
MaxLimit
, which is set by Amazon Web Services.
4781 4782 4783 4784 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4781 def (params = {}, = {}) req = build_request(:set_media_message_spend_limit_override, 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.
4811 4812 4813 4814 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4811 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.
4841 4842 4843 4844 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4841 def (params = {}, = {}) req = build_request(:set_voice_message_spend_limit_override, params) req.send_request() end |
#submit_registration_version(params = {}) ⇒ Types::SubmitRegistrationVersionResult
Submit the specified registration for review and approval.
4885 4886 4887 4888 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4885 def submit_registration_version(params = {}, = {}) req = build_request(:submit_registration_version, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or overwrites only the specified tags for the specified 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 Tags in the AWS End User Messaging SMS User Guide.
4926 4927 4928 4929 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4926 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 a resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide.
4958 4959 4960 4961 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4958 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 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, Firehose, and Amazon SNS.
5046 5047 5048 5049 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5046 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.
5151 5152 5153 5154 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5151 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.
5248 5249 5250 5251 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5248 def update_pool(params = {}, = {}) req = build_request(:update_pool, params) req.send_request() end |
#update_protect_configuration(params = {}) ⇒ Types::UpdateProtectConfigurationResult
Update the setting for an existing protect configuration.
5289 5290 5291 5292 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5289 def update_protect_configuration(params = {}, = {}) req = build_request(:update_protect_configuration, params) req.send_request() end |
#update_protect_configuration_country_rule_set(params = {}) ⇒ Types::UpdateProtectConfigurationCountryRuleSetResult
Update a country rule set to ALLOW
or BLOCK
messages to be sent to
the specified destination counties. You can update one or multiple
countries at a time. The updates are only applied to the specified
NumberCapability type.
5347 5348 5349 5350 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5347 def update_protect_configuration_country_rule_set(params = {}, = {}) req = build_request(:update_protect_configuration_country_rule_set, params) req.send_request() end |
#update_sender_id(params = {}) ⇒ Types::UpdateSenderIdResult
Updates the configuration of an existing sender ID.
5400 5401 5402 5403 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5400 def update_sender_id(params = {}, = {}) req = build_request(:update_sender_id, params) req.send_request() end |
#verify_destination_number(params = {}) ⇒ Types::VerifyDestinationNumberResult
Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
5443 5444 5445 5446 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5443 def verify_destination_number(params = {}, = {}) req = build_request(:verify_destination_number, params) req.send_request() end |