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_protect_configuration_rule_set_number_override(params = {}) ⇒ Types::DeleteProtectConfigurationRuleSetNumberOverrideResult
Permanently delete the protect configuration rule set number override.
-
#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 destination 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_protect_configuration_rule_set_number_overrides(params = {}) ⇒ Types::ListProtectConfigurationRuleSetNumberOverridesResult
Retrieve all of the protect configuration rule set number overrides that match the filters.
-
#list_registration_associations(params = {}) ⇒ Types::ListRegistrationAssociationsResult
Retrieve all of the origination identities 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_message_feedback(params = {}) ⇒ Types::PutMessageFeedbackResult
Set the MessageFeedbackStatus as
RECEIVED
orFAILED
for the passed in MessageId. -
#put_opted_out_number(params = {}) ⇒ Types::PutOptedOutNumberResult
Creates an opted out destination phone number in the opt-out list.
-
#put_protect_configuration_rule_set_number_override(params = {}) ⇒ Types::PutProtectConfigurationRuleSetNumberOverrideResult
Create or update a RuleSetNumberOverride and associate it with a protect configuration.
-
#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_feedback_enabled(params = {}) ⇒ Types::SetDefaultMessageFeedbackEnabledResult
Sets a configuration set's default for message feedback.
-
#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.
474 475 476 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 474 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.
548 549 550 551 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 548 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.
590 591 592 593 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 590 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.
653 654 655 656 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 653 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.
753 754 755 756 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 753 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.
823 824 825 826 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 823 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.
939 940 941 942 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 939 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.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1004 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.
1071 1072 1073 1074 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1071 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.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1119 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.
1190 1191 1192 1193 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1190 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.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1236 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.
1298 1299 1300 1301 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1298 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.
1319 1320 1321 1322 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1319 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.
1375 1376 1377 1378 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1375 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.
1417 1418 1419 1420 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1417 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.
1456 1457 1458 1459 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1456 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.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1509 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.
1564 1565 1566 1567 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1564 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.
1592 1593 1594 1595 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1592 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.
1633 1634 1635 1636 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1633 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.
1682 1683 1684 1685 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1682 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.
1742 1743 1744 1745 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1742 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.
1781 1782 1783 1784 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1781 def delete_protect_configuration(params = {}, = {}) req = build_request(:delete_protect_configuration, params) req.send_request() end |
#delete_protect_configuration_rule_set_number_override(params = {}) ⇒ Types::DeleteProtectConfigurationRuleSetNumberOverrideResult
Permanently delete the protect configuration rule set number override.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1825 def delete_protect_configuration_rule_set_number_override(params = {}, = {}) req = build_request(:delete_protect_configuration_rule_set_number_override, params) req.send_request() end |
#delete_registration(params = {}) ⇒ Types::DeleteRegistrationResult
Permanently delete an existing registration from your account.
1870 1871 1872 1873 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1870 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.
1906 1907 1908 1909 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1906 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.
1952 1953 1954 1955 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1952 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.
1987 1988 1989 1990 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1987 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.
2014 2015 2016 2017 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2014 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.
2048 2049 2050 2051 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2048 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.
2075 2076 2077 2078 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2075 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.
2122 2123 2124 2125 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2122 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.
2175 2176 2177 2178 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2175 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.
2253 2254 2255 2256 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2253 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.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2331 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.
2396 2397 2398 2399 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2396 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.
2476 2477 2478 2479 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2476 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.
2567 2568 2569 2570 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2567 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.
2652 2653 2654 2655 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2652 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.
2708 2709 2710 2711 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2708 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.
2766 2767 2768 2769 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2766 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.
2842 2843 2844 2845 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2842 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.
2907 2908 2909 2910 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2907 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.
2963 2964 2965 2966 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2963 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.
3027 3028 3029 3030 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3027 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.
3102 3103 3104 3105 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3102 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.
3162 3163 3164 3165 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3162 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.
3244 3245 3246 3247 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3244 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.
3296 3297 3298 3299 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3296 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 destination numbers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3356 3357 3358 3359 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3356 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.
3425 3426 3427 3428 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3425 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.
3463 3464 3465 3466 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3463 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.
3507 3508 3509 3510 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3507 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.
3548 3549 3550 3551 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3548 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.
3583 3584 3585 3586 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3583 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.
3651 3652 3653 3654 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3651 def list_pool_origination_identities(params = {}, = {}) req = build_request(:list_pool_origination_identities, params) req.send_request() end |
#list_protect_configuration_rule_set_number_overrides(params = {}) ⇒ Types::ListProtectConfigurationRuleSetNumberOverridesResult
Retrieve all of the protect configuration rule set number overrides that match the filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3712 3713 3714 3715 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3712 def list_protect_configuration_rule_set_number_overrides(params = {}, = {}) req = build_request(:list_protect_configuration_rule_set_number_overrides, params) req.send_request() end |
#list_registration_associations(params = {}) ⇒ Types::ListRegistrationAssociationsResult
Retrieve all of the origination identities that are associated with a registration.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3775 3776 3777 3778 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3775 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.
3807 3808 3809 3810 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3807 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.
3878 3879 3880 3881 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3878 def put_keyword(params = {}, = {}) req = build_request(:put_keyword, params) req.send_request() end |
#put_message_feedback(params = {}) ⇒ Types::PutMessageFeedbackResult
Set the MessageFeedbackStatus as RECEIVED
or FAILED
for the passed
in MessageId.
If you use message feedback then you must update message feedback
record. When you receive a signal that a user has received the message
you must use PutMessageFeedback
to set the message feedback record
as RECEIVED
; Otherwise, an hour after the message feedback record is
set to FAILED
.
3919 3920 3921 3922 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3919 def (params = {}, = {}) req = build_request(:put_message_feedback, 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.
3965 3966 3967 3968 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3965 def put_opted_out_number(params = {}, = {}) req = build_request(:put_opted_out_number, params) req.send_request() end |
#put_protect_configuration_rule_set_number_override(params = {}) ⇒ Types::PutProtectConfigurationRuleSetNumberOverrideResult
Create or update a RuleSetNumberOverride and associate it with a protect configuration.
4030 4031 4032 4033 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4030 def put_protect_configuration_rule_set_number_override(params = {}, = {}) req = build_request(:put_protect_configuration_rule_set_number_override, params) req.send_request() end |
#put_registration_field_value(params = {}) ⇒ Types::PutRegistrationFieldValueResult
Creates or updates a field value for a registration.
4088 4089 4090 4091 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4088 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.
4134 4135 4136 4137 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4134 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.
4202 4203 4204 4205 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4202 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.
4248 4249 4250 4251 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4248 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.
4383 4384 4385 4386 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4383 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.
4464 4465 4466 4467 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4464 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.
4540 4541 4542 4543 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4540 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.
4634 4635 4636 4637 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4634 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.
4775 4776 4777 4778 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4775 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.
4880 4881 4882 4883 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4880 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.
4913 4914 4915 4916 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4913 def set_account_default_protect_configuration(params = {}, = {}) req = build_request(:set_account_default_protect_configuration, params) req.send_request() end |
#set_default_message_feedback_enabled(params = {}) ⇒ Types::SetDefaultMessageFeedbackEnabledResult
Sets a configuration set's default for message feedback.
4950 4951 4952 4953 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4950 def (params = {}, = {}) req = build_request(:set_default_message_feedback_enabled, 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.
4996 4997 4998 4999 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4996 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.
5043 5044 5045 5046 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5043 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.
5073 5074 5075 5076 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5073 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.
5103 5104 5105 5106 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5103 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.
5133 5134 5135 5136 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5133 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.
5177 5178 5179 5180 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5177 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.
5218 5219 5220 5221 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5218 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.
5250 5251 5252 5253 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5250 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.
5338 5339 5340 5341 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5338 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.
5443 5444 5445 5446 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5443 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.
5540 5541 5542 5543 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5540 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.
5581 5582 5583 5584 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5581 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.
5639 5640 5641 5642 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5639 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.
5692 5693 5694 5695 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5692 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.
5735 5736 5737 5738 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 5735 def verify_destination_number(params = {}, = {}) req = build_request(:verify_destination_number, params) req.send_request() end |