Class: Aws::PinpointSMSVoiceV2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::PinpointSMSVoiceV2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb
Overview
An API client for PinpointSMSVoiceV2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::PinpointSMSVoiceV2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_origination_identity(params = {}) ⇒ Types::AssociateOriginationIdentityResult
Associates the specified origination identity with a pool.
-
#create_configuration_set(params = {}) ⇒ Types::CreateConfigurationSetResult
Creates a new configuration set.
-
#create_event_destination(params = {}) ⇒ Types::CreateEventDestinationResult
Creates a new event destination in a configuration set.
-
#create_opt_out_list(params = {}) ⇒ Types::CreateOptOutListResult
Creates a new opt-out list.
-
#create_pool(params = {}) ⇒ Types::CreatePoolResult
Creates a new pool and associates the specified origination identity to the pool.
-
#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_configuration_set(params = {}) ⇒ Types::DeleteConfigurationSetResult
Deletes an existing configuration set.
-
#delete_default_message_type(params = {}) ⇒ Types::DeleteDefaultMessageTypeResult
Deletes an existing default message type on a configuration set.
-
#delete_default_sender_id(params = {}) ⇒ Types::DeleteDefaultSenderIdResult
Deletes an existing default sender ID on a configuration set.
-
#delete_event_destination(params = {}) ⇒ Types::DeleteEventDestinationResult
Deletes an existing event destination.
-
#delete_keyword(params = {}) ⇒ Types::DeleteKeywordResult
Deletes an existing keyword from an origination phone number or pool.
-
#delete_opt_out_list(params = {}) ⇒ Types::DeleteOptOutListResult
Deletes an existing opt-out list.
-
#delete_opted_out_number(params = {}) ⇒ Types::DeleteOptedOutNumberResult
Deletes an existing opted out destination phone number from the specified opt-out list.
-
#delete_pool(params = {}) ⇒ Types::DeletePoolResult
Deletes an existing pool.
-
#delete_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_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 Amazon Pinpoint SMS Voice V2 resource quotas for your account.
-
#describe_configuration_sets(params = {}) ⇒ Types::DescribeConfigurationSetsResult
Describes the specified configuration sets or all in your account.
-
#describe_keywords(params = {}) ⇒ Types::DescribeKeywordsResult
Describes the specified keywords or all keywords on your origination phone number or pool.
-
#describe_opt_out_lists(params = {}) ⇒ Types::DescribeOptOutListsResult
Describes the specified opt-out list or all opt-out lists in your account.
-
#describe_opted_out_numbers(params = {}) ⇒ Types::DescribeOptedOutNumbersResult
Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
-
#describe_phone_numbers(params = {}) ⇒ Types::DescribePhoneNumbersResult
Describes the specified origination phone number, or all the phone numbers in your account.
-
#describe_pools(params = {}) ⇒ Types::DescribePoolsResult
Retrieves the specified pools or all pools associated with your Amazon Web Services account.
-
#describe_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 Amazon Pinpoint 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.
-
#discard_registration_version(params = {}) ⇒ Types::DiscardRegistrationVersionResult
Discard the current version of the registration.
-
#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.
-
#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_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 through Amazon Pinpoint.
-
#set_default_message_type(params = {}) ⇒ Types::SetDefaultMessageTypeResult
Sets the default message type on a configuration set.
-
#set_default_sender_id(params = {}) ⇒ Types::SetDefaultSenderIdResult
Sets default sender ID on a configuration set.
-
#set_text_message_spend_limit_override(params = {}) ⇒ Types::SetTextMessageSpendLimitOverrideResult
Sets an account level monthly spend limit override for sending text messages.
-
#set_voice_message_spend_limit_override(params = {}) ⇒ Types::SetVoiceMessageSpendLimitOverrideResult
Sets an account level monthly spend limit override for sending voice messages.
-
#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 Amazon Pinpoint SMS Voice, version 2 resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource.
-
#update_event_destination(params = {}) ⇒ Types::UpdateEventDestinationResult
Updates an existing event destination in a configuration set.
-
#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResult
Updates the configuration of an existing origination phone number.
-
#update_pool(params = {}) ⇒ Types::UpdatePoolResult
Updates the configuration of an existing pool.
-
#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.
395 396 397 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 395 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.
463 464 465 466 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 463 def associate_origination_identity(params = {}, = {}) req = build_request(:associate_origination_identity, params) req.send_request() end |
#create_configuration_set(params = {}) ⇒ Types::CreateConfigurationSetResult
Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
526 527 528 529 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 526 def create_configuration_set(params = {}, = {}) req = build_request(:create_configuration_set, params) req.send_request() end |
#create_event_destination(params = {}) ⇒ Types::CreateEventDestinationResult
Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
626 627 628 629 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 626 def create_event_destination(params = {}, = {}) req = build_request(:create_event_destination, params) req.send_request() end |
#create_opt_out_list(params = {}) ⇒ Types::CreateOptOutListResult
Creates a new opt-out list.
If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
696 697 698 699 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 696 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.
801 802 803 804 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 801 def create_pool(params = {}, = {}) req = build_request(:create_pool, params) req.send_request() end |
#create_registration(params = {}) ⇒ Types::CreateRegistrationResult
Creates a new registration based on the RegistrationType field.
868 869 870 871 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 868 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.
916 917 918 919 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 916 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 1MiB 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.
983 984 985 986 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 983 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.
1028 1029 1030 1031 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1028 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.
1090 1091 1092 1093 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1090 def create_verified_destination_number(params = {}, = {}) req = build_request(:create_verified_destination_number, 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.
1144 1145 1146 1147 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1144 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.
1186 1187 1188 1189 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1186 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.
1225 1226 1227 1228 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1225 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.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1278 def delete_event_destination(params = {}, = {}) req = build_request(:delete_event_destination, params) req.send_request() end |
#delete_keyword(params = {}) ⇒ Types::DeleteKeywordResult
Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
Keywords "HELP" and "STOP" can't be deleted or modified.
1330 1331 1332 1333 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1330 def delete_keyword(params = {}, = {}) req = build_request(:delete_keyword, params) req.send_request() end |
#delete_opt_out_list(params = {}) ⇒ Types::DeleteOptOutListResult
Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
1368 1369 1370 1371 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1368 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.
1414 1415 1416 1417 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1414 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.
1471 1472 1473 1474 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1471 def delete_pool(params = {}, = {}) req = build_request(:delete_pool, params) req.send_request() end |
#delete_registration(params = {}) ⇒ Types::DeleteRegistrationResult
Permanently delete an existing registration from your account.
1516 1517 1518 1519 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1516 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.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1552 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.
1598 1599 1600 1601 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1598 def delete_registration_field_value(params = {}, = {}) req = build_request(:delete_registration_field_value, params) req.send_request() end |
#delete_text_message_spend_limit_override(params = {}) ⇒ Types::DeleteTextMessageSpendLimitOverrideResult
Deletes an account-level monthly spending limit override for sending
text messages. Deleting a spend limit override will set the
EnforcedLimit
to equal the MaxLimit
, which is controlled by Amazon
Web Services. For more information on spend limits (quotas) see
Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
1625 1626 1627 1628 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1625 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.
1659 1660 1661 1662 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1659 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
Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
1686 1687 1688 1689 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1686 def (params = {}, = {}) req = build_request(:delete_voice_message_spend_limit_override, params) req.send_request() end |
#describe_account_attributes(params = {}) ⇒ Types::DescribeAccountAttributesResult
Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1733 1734 1735 1736 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1733 def describe_account_attributes(params = {}, = {}) req = build_request(:describe_account_attributes, params) req.send_request() end |
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsResult
Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1785 1786 1787 1788 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1785 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.
1861 1862 1863 1864 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1861 def describe_configuration_sets(params = {}, = {}) req = build_request(:describe_configuration_sets, params) req.send_request() end |
#describe_keywords(params = {}) ⇒ Types::DescribeKeywordsResult
Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1936 1937 1938 1939 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1936 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.
1991 1992 1993 1994 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 1991 def describe_opt_out_lists(params = {}, = {}) req = build_request(:describe_opt_out_lists, params) req.send_request() end |
#describe_opted_out_numbers(params = {}) ⇒ Types::DescribeOptedOutNumbersResult
Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an error is returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2065 2066 2067 2068 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2065 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.
2146 2147 2148 2149 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2146 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.
2222 2223 2224 2225 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2222 def describe_pools(params = {}, = {}) req = build_request(:describe_pools, 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.
2280 2281 2282 2283 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2280 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.
2356 2357 2358 2359 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2356 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.
2421 2422 2423 2424 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2421 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.
2477 2478 2479 2480 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2477 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.
2541 2542 2543 2544 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2541 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.
2615 2616 2617 2618 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2615 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.
2675 2676 2677 2678 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2675 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.
2748 2749 2750 2751 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2748 def describe_sender_ids(params = {}, = {}) req = build_request(:describe_sender_ids, params) req.send_request() end |
#describe_spend_limits(params = {}) ⇒ Types::DescribeSpendLimitsResult
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2800 2801 2802 2803 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2800 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.
2860 2861 2862 2863 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2860 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.
2923 2924 2925 2926 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2923 def disassociate_origination_identity(params = {}, = {}) req = build_request(:disassociate_origination_identity, params) req.send_request() end |
#discard_registration_version(params = {}) ⇒ Types::DiscardRegistrationVersionResult
Discard the current version of the registration.
2966 2967 2968 2969 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 2966 def discard_registration_version(params = {}, = {}) req = build_request(:discard_registration_version, 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.
3031 3032 3033 3034 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3031 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.
3094 3095 3096 3097 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3094 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.
3126 3127 3128 3129 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3126 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_keyword(params = {}) ⇒ Types::PutKeywordResult
Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
3194 3195 3196 3197 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3194 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.
3237 3238 3239 3240 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3237 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.
3295 3296 3297 3298 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3295 def put_registration_field_value(params = {}, = {}) req = build_request(:put_registration_field_value, 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.
3360 3361 3362 3363 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3360 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.
3406 3407 3408 3409 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3406 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 Requesting a number in the Amazon Pinpoint User Guide.
3535 3536 3537 3538 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3535 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.
3616 3617 3618 3619 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3616 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.
3689 3690 3691 3692 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3689 def send_destination_number_verification_code(params = {}, = {}) req = build_request(:send_destination_number_verification_code, params) req.send_request() end |
#send_text_message(params = {}) ⇒ Types::SendTextMessageResult
Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
3789 3790 3791 3792 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3789 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 through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
3881 3882 3883 3884 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3881 def (params = {}, = {}) req = build_request(:send_voice_message, params) req.send_request() end |
#set_default_message_type(params = {}) ⇒ Types::SetDefaultMessageTypeResult
Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
3927 3928 3929 3930 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3927 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.
3974 3975 3976 3977 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 3974 def set_default_sender_id(params = {}, = {}) req = build_request(:set_default_sender_id, params) req.send_request() end |
#set_text_message_spend_limit_override(params = {}) ⇒ Types::SetTextMessageSpendLimitOverrideResult
Sets an account level monthly spend limit override for sending text
messages. The requested spend limit must be less than or equal to the
MaxLimit
, which is set by Amazon Web Services.
4004 4005 4006 4007 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4004 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.
4034 4035 4036 4037 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4034 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.
4077 4078 4079 4080 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4077 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 Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
4119 4120 4121 4122 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4119 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
4152 4153 4154 4155 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4152 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_event_destination(params = {}) ⇒ Types::UpdateEventDestinationResult
Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
4240 4241 4242 4243 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4240 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.
4341 4342 4343 4344 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4341 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.
4431 4432 4433 4434 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4431 def update_pool(params = {}, = {}) req = build_request(:update_pool, params) req.send_request() end |
#update_sender_id(params = {}) ⇒ Types::UpdateSenderIdResult
Updates the configuration of an existing sender ID.
4484 4485 4486 4487 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4484 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.
4527 4528 4529 4530 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 4527 def verify_destination_number(params = {}, = {}) req = build_request(:verify_destination_number, params) req.send_request() end |