aws-sdk-pinpointsmsvoicev2 1.14.0 → 1.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-pinpointsmsvoicev2/client.rb +604 -18
- data/lib/aws-sdk-pinpointsmsvoicev2/client_api.rb +371 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/endpoints.rb +182 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/plugins/endpoints.rb +26 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/types.rb +718 -11
- data/lib/aws-sdk-pinpointsmsvoicev2.rb +1 -1
- data/sig/client.rbs +199 -9
- data/sig/types.rbs +214 -17
- metadata +2 -2
@@ -489,6 +489,48 @@ module Aws::PinpointSMSVoiceV2
|
|
489
489
|
req.send_request(options)
|
490
490
|
end
|
491
491
|
|
492
|
+
# Associate a protect configuration with a configuration set. This
|
493
|
+
# replaces the configuration sets current protect configuration. A
|
494
|
+
# configuration set can only be associated with one protect
|
495
|
+
# configuration at a time. A protect configuration can be associated
|
496
|
+
# with multiple configuration sets.
|
497
|
+
#
|
498
|
+
# @option params [required, String] :protect_configuration_id
|
499
|
+
# The unique identifier for the protect configuration.
|
500
|
+
#
|
501
|
+
# @option params [required, String] :configuration_set_name
|
502
|
+
# The name of the ConfigurationSet.
|
503
|
+
#
|
504
|
+
# @return [Types::AssociateProtectConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
505
|
+
#
|
506
|
+
# * {Types::AssociateProtectConfigurationResult#configuration_set_arn #configuration_set_arn} => String
|
507
|
+
# * {Types::AssociateProtectConfigurationResult#configuration_set_name #configuration_set_name} => String
|
508
|
+
# * {Types::AssociateProtectConfigurationResult#protect_configuration_arn #protect_configuration_arn} => String
|
509
|
+
# * {Types::AssociateProtectConfigurationResult#protect_configuration_id #protect_configuration_id} => String
|
510
|
+
#
|
511
|
+
# @example Request syntax with placeholder values
|
512
|
+
#
|
513
|
+
# resp = client.associate_protect_configuration({
|
514
|
+
# protect_configuration_id: "ProtectConfigurationIdOrArn", # required
|
515
|
+
# configuration_set_name: "ConfigurationSetNameOrArn", # required
|
516
|
+
# })
|
517
|
+
#
|
518
|
+
# @example Response structure
|
519
|
+
#
|
520
|
+
# resp.configuration_set_arn #=> String
|
521
|
+
# resp.configuration_set_name #=> String
|
522
|
+
# resp.protect_configuration_arn #=> String
|
523
|
+
# resp.protect_configuration_id #=> String
|
524
|
+
#
|
525
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/AssociateProtectConfiguration AWS API Documentation
|
526
|
+
#
|
527
|
+
# @overload associate_protect_configuration(params = {})
|
528
|
+
# @param [Hash] params ({})
|
529
|
+
def associate_protect_configuration(params = {}, options = {})
|
530
|
+
req = build_request(:associate_protect_configuration, params)
|
531
|
+
req.send_request(options)
|
532
|
+
end
|
533
|
+
|
492
534
|
# Creates a new configuration set. After you create the configuration
|
493
535
|
# set, you can add one or more event destinations to it.
|
494
536
|
#
|
@@ -584,7 +626,7 @@ module Aws::PinpointSMSVoiceV2
|
|
584
626
|
#
|
585
627
|
# @option params [Types::CloudWatchLogsDestination] :cloud_watch_logs_destination
|
586
628
|
# An object that contains information about an event destination for
|
587
|
-
# logging to Amazon CloudWatch
|
629
|
+
# logging to Amazon CloudWatch Logs.
|
588
630
|
#
|
589
631
|
# @option params [Types::KinesisFirehoseDestination] :kinesis_firehose_destination
|
590
632
|
# An object that contains information about an event destination for
|
@@ -614,7 +656,7 @@ module Aws::PinpointSMSVoiceV2
|
|
614
656
|
# resp = client.create_event_destination({
|
615
657
|
# configuration_set_name: "ConfigurationSetNameOrArn", # required
|
616
658
|
# event_destination_name: "EventDestinationName", # required
|
617
|
-
# matching_event_types: ["ALL"], # required, accepts ALL, TEXT_ALL, TEXT_SENT, TEXT_PENDING, TEXT_QUEUED, TEXT_SUCCESSFUL, TEXT_DELIVERED, TEXT_INVALID, TEXT_INVALID_MESSAGE, TEXT_UNREACHABLE, TEXT_CARRIER_UNREACHABLE, TEXT_BLOCKED, TEXT_CARRIER_BLOCKED, TEXT_SPAM, TEXT_UNKNOWN, TEXT_TTL_EXPIRED, VOICE_ALL, VOICE_INITIATED, VOICE_RINGING, VOICE_ANSWERED, VOICE_COMPLETED, VOICE_BUSY, VOICE_NO_ANSWER, VOICE_FAILED, VOICE_TTL_EXPIRED
|
659
|
+
# matching_event_types: ["ALL"], # required, accepts ALL, TEXT_ALL, TEXT_SENT, TEXT_PENDING, TEXT_QUEUED, TEXT_SUCCESSFUL, TEXT_DELIVERED, TEXT_INVALID, TEXT_INVALID_MESSAGE, TEXT_UNREACHABLE, TEXT_CARRIER_UNREACHABLE, TEXT_BLOCKED, TEXT_CARRIER_BLOCKED, TEXT_SPAM, TEXT_UNKNOWN, TEXT_TTL_EXPIRED, VOICE_ALL, VOICE_INITIATED, VOICE_RINGING, VOICE_ANSWERED, VOICE_COMPLETED, VOICE_BUSY, VOICE_NO_ANSWER, VOICE_FAILED, VOICE_TTL_EXPIRED, MEDIA_ALL, MEDIA_PENDING, MEDIA_QUEUED, MEDIA_SUCCESSFUL, MEDIA_DELIVERED, MEDIA_INVALID, MEDIA_INVALID_MESSAGE, MEDIA_UNREACHABLE, MEDIA_CARRIER_UNREACHABLE, MEDIA_BLOCKED, MEDIA_CARRIER_BLOCKED, MEDIA_SPAM, MEDIA_UNKNOWN, MEDIA_TTL_EXPIRED, MEDIA_FILE_INACCESSIBLE, MEDIA_FILE_TYPE_UNSUPPORTED, MEDIA_FILE_SIZE_EXCEEDED
|
618
660
|
# cloud_watch_logs_destination: {
|
619
661
|
# iam_role_arn: "IamRoleArn", # required
|
620
662
|
# log_group_arn: "LogGroupArn", # required
|
@@ -636,7 +678,7 @@ module Aws::PinpointSMSVoiceV2
|
|
636
678
|
# resp.event_destination.event_destination_name #=> String
|
637
679
|
# resp.event_destination.enabled #=> Boolean
|
638
680
|
# resp.event_destination.matching_event_types #=> Array
|
639
|
-
# resp.event_destination.matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED"
|
681
|
+
# resp.event_destination.matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED", "MEDIA_ALL", "MEDIA_PENDING", "MEDIA_QUEUED", "MEDIA_SUCCESSFUL", "MEDIA_DELIVERED", "MEDIA_INVALID", "MEDIA_INVALID_MESSAGE", "MEDIA_UNREACHABLE", "MEDIA_CARRIER_UNREACHABLE", "MEDIA_BLOCKED", "MEDIA_CARRIER_BLOCKED", "MEDIA_SPAM", "MEDIA_UNKNOWN", "MEDIA_TTL_EXPIRED", "MEDIA_FILE_INACCESSIBLE", "MEDIA_FILE_TYPE_UNSUPPORTED", "MEDIA_FILE_SIZE_EXCEEDED"
|
640
682
|
# resp.event_destination.cloud_watch_logs_destination.iam_role_arn #=> String
|
641
683
|
# resp.event_destination.cloud_watch_logs_destination.log_group_arn #=> String
|
642
684
|
# resp.event_destination.kinesis_firehose_destination.iam_role_arn #=> String
|
@@ -827,6 +869,71 @@ module Aws::PinpointSMSVoiceV2
|
|
827
869
|
req.send_request(options)
|
828
870
|
end
|
829
871
|
|
872
|
+
# Create a new protect configuration. By default all country rule sets
|
873
|
+
# for each capability are set to `ALLOW`. Update the country rule sets
|
874
|
+
# using `UpdateProtectConfigurationCountryRuleSet`. A protect
|
875
|
+
# configurations name is stored as a Tag with the key set to `Name` and
|
876
|
+
# value as the name of the protect configuration.
|
877
|
+
#
|
878
|
+
# @option params [String] :client_token
|
879
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
880
|
+
# idempotency of the request. If you don't specify a client token, a
|
881
|
+
# randomly generated token is used for the request to ensure
|
882
|
+
# idempotency.
|
883
|
+
#
|
884
|
+
# **A suitable default value is auto-generated.** You should normally
|
885
|
+
# not need to pass this option.**
|
886
|
+
#
|
887
|
+
# @option params [Boolean] :deletion_protection_enabled
|
888
|
+
# When set to true deletion protection is enabled. By default this is
|
889
|
+
# set to false.
|
890
|
+
#
|
891
|
+
# @option params [Array<Types::Tag>] :tags
|
892
|
+
# An array of key and value pair tags that are associated with the
|
893
|
+
# resource.
|
894
|
+
#
|
895
|
+
# @return [Types::CreateProtectConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
896
|
+
#
|
897
|
+
# * {Types::CreateProtectConfigurationResult#protect_configuration_arn #protect_configuration_arn} => String
|
898
|
+
# * {Types::CreateProtectConfigurationResult#protect_configuration_id #protect_configuration_id} => String
|
899
|
+
# * {Types::CreateProtectConfigurationResult#created_timestamp #created_timestamp} => Time
|
900
|
+
# * {Types::CreateProtectConfigurationResult#account_default #account_default} => Boolean
|
901
|
+
# * {Types::CreateProtectConfigurationResult#deletion_protection_enabled #deletion_protection_enabled} => Boolean
|
902
|
+
# * {Types::CreateProtectConfigurationResult#tags #tags} => Array<Types::Tag>
|
903
|
+
#
|
904
|
+
# @example Request syntax with placeholder values
|
905
|
+
#
|
906
|
+
# resp = client.create_protect_configuration({
|
907
|
+
# client_token: "ClientToken",
|
908
|
+
# deletion_protection_enabled: false,
|
909
|
+
# tags: [
|
910
|
+
# {
|
911
|
+
# key: "TagKey", # required
|
912
|
+
# value: "TagValue", # required
|
913
|
+
# },
|
914
|
+
# ],
|
915
|
+
# })
|
916
|
+
#
|
917
|
+
# @example Response structure
|
918
|
+
#
|
919
|
+
# resp.protect_configuration_arn #=> String
|
920
|
+
# resp.protect_configuration_id #=> String
|
921
|
+
# resp.created_timestamp #=> Time
|
922
|
+
# resp.account_default #=> Boolean
|
923
|
+
# resp.deletion_protection_enabled #=> Boolean
|
924
|
+
# resp.tags #=> Array
|
925
|
+
# resp.tags[0].key #=> String
|
926
|
+
# resp.tags[0].value #=> String
|
927
|
+
#
|
928
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateProtectConfiguration AWS API Documentation
|
929
|
+
#
|
930
|
+
# @overload create_protect_configuration(params = {})
|
931
|
+
# @param [Hash] params ({})
|
932
|
+
def create_protect_configuration(params = {}, options = {})
|
933
|
+
req = build_request(:create_protect_configuration, params)
|
934
|
+
req.send_request(options)
|
935
|
+
end
|
936
|
+
|
830
937
|
# Creates a new registration based on the **RegistrationType** field.
|
831
938
|
#
|
832
939
|
# @option params [required, String] :registration_type
|
@@ -1116,6 +1223,27 @@ module Aws::PinpointSMSVoiceV2
|
|
1116
1223
|
req.send_request(options)
|
1117
1224
|
end
|
1118
1225
|
|
1226
|
+
# Removes the current account default protect configuration.
|
1227
|
+
#
|
1228
|
+
# @return [Types::DeleteAccountDefaultProtectConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1229
|
+
#
|
1230
|
+
# * {Types::DeleteAccountDefaultProtectConfigurationResult#default_protect_configuration_arn #default_protect_configuration_arn} => String
|
1231
|
+
# * {Types::DeleteAccountDefaultProtectConfigurationResult#default_protect_configuration_id #default_protect_configuration_id} => String
|
1232
|
+
#
|
1233
|
+
# @example Response structure
|
1234
|
+
#
|
1235
|
+
# resp.default_protect_configuration_arn #=> String
|
1236
|
+
# resp.default_protect_configuration_id #=> String
|
1237
|
+
#
|
1238
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteAccountDefaultProtectConfiguration AWS API Documentation
|
1239
|
+
#
|
1240
|
+
# @overload delete_account_default_protect_configuration(params = {})
|
1241
|
+
# @param [Hash] params ({})
|
1242
|
+
def delete_account_default_protect_configuration(params = {}, options = {})
|
1243
|
+
req = build_request(:delete_account_default_protect_configuration, params)
|
1244
|
+
req.send_request(options)
|
1245
|
+
end
|
1246
|
+
|
1119
1247
|
# Deletes an existing configuration set.
|
1120
1248
|
#
|
1121
1249
|
# A configuration set is a set of rules that you apply to voice and SMS
|
@@ -1151,7 +1279,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1151
1279
|
# resp.event_destinations[0].event_destination_name #=> String
|
1152
1280
|
# resp.event_destinations[0].enabled #=> Boolean
|
1153
1281
|
# resp.event_destinations[0].matching_event_types #=> Array
|
1154
|
-
# resp.event_destinations[0].matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED"
|
1282
|
+
# resp.event_destinations[0].matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED", "MEDIA_ALL", "MEDIA_PENDING", "MEDIA_QUEUED", "MEDIA_SUCCESSFUL", "MEDIA_DELIVERED", "MEDIA_INVALID", "MEDIA_INVALID_MESSAGE", "MEDIA_UNREACHABLE", "MEDIA_CARRIER_UNREACHABLE", "MEDIA_BLOCKED", "MEDIA_CARRIER_BLOCKED", "MEDIA_SPAM", "MEDIA_UNKNOWN", "MEDIA_TTL_EXPIRED", "MEDIA_FILE_INACCESSIBLE", "MEDIA_FILE_TYPE_UNSUPPORTED", "MEDIA_FILE_SIZE_EXCEEDED"
|
1155
1283
|
# resp.event_destinations[0].cloud_watch_logs_destination.iam_role_arn #=> String
|
1156
1284
|
# resp.event_destinations[0].cloud_watch_logs_destination.log_group_arn #=> String
|
1157
1285
|
# resp.event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
|
@@ -1288,7 +1416,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1288
1416
|
# resp.event_destination.event_destination_name #=> String
|
1289
1417
|
# resp.event_destination.enabled #=> Boolean
|
1290
1418
|
# resp.event_destination.matching_event_types #=> Array
|
1291
|
-
# resp.event_destination.matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED"
|
1419
|
+
# resp.event_destination.matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED", "MEDIA_ALL", "MEDIA_PENDING", "MEDIA_QUEUED", "MEDIA_SUCCESSFUL", "MEDIA_DELIVERED", "MEDIA_INVALID", "MEDIA_INVALID_MESSAGE", "MEDIA_UNREACHABLE", "MEDIA_CARRIER_UNREACHABLE", "MEDIA_BLOCKED", "MEDIA_CARRIER_BLOCKED", "MEDIA_SPAM", "MEDIA_UNKNOWN", "MEDIA_TTL_EXPIRED", "MEDIA_FILE_INACCESSIBLE", "MEDIA_FILE_TYPE_UNSUPPORTED", "MEDIA_FILE_SIZE_EXCEEDED"
|
1292
1420
|
# resp.event_destination.cloud_watch_logs_destination.iam_role_arn #=> String
|
1293
1421
|
# resp.event_destination.cloud_watch_logs_destination.log_group_arn #=> String
|
1294
1422
|
# resp.event_destination.kinesis_firehose_destination.iam_role_arn #=> String
|
@@ -1356,6 +1484,34 @@ module Aws::PinpointSMSVoiceV2
|
|
1356
1484
|
req.send_request(options)
|
1357
1485
|
end
|
1358
1486
|
|
1487
|
+
# Deletes an account-level monthly spending limit override for sending
|
1488
|
+
# multimedia messages (MMS). Deleting a spend limit override will set
|
1489
|
+
# the `EnforcedLimit` to equal the `MaxLimit`, which is controlled by
|
1490
|
+
# Amazon Web Services. For more information on spend limits (quotas) see
|
1491
|
+
# [Quotas for Server Migration Service][1] in the *Server Migration
|
1492
|
+
# Service User Guide*.
|
1493
|
+
#
|
1494
|
+
#
|
1495
|
+
#
|
1496
|
+
# [1]: https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html
|
1497
|
+
#
|
1498
|
+
# @return [Types::DeleteMediaMessageSpendLimitOverrideResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1499
|
+
#
|
1500
|
+
# * {Types::DeleteMediaMessageSpendLimitOverrideResult#monthly_limit #monthly_limit} => Integer
|
1501
|
+
#
|
1502
|
+
# @example Response structure
|
1503
|
+
#
|
1504
|
+
# resp.monthly_limit #=> Integer
|
1505
|
+
#
|
1506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteMediaMessageSpendLimitOverride AWS API Documentation
|
1507
|
+
#
|
1508
|
+
# @overload delete_media_message_spend_limit_override(params = {})
|
1509
|
+
# @param [Hash] params ({})
|
1510
|
+
def delete_media_message_spend_limit_override(params = {}, options = {})
|
1511
|
+
req = build_request(:delete_media_message_spend_limit_override, params)
|
1512
|
+
req.send_request(options)
|
1513
|
+
end
|
1514
|
+
|
1359
1515
|
# Deletes an existing opt-out list. All opted out phone numbers in the
|
1360
1516
|
# opt-out list are deleted.
|
1361
1517
|
#
|
@@ -1497,6 +1653,45 @@ module Aws::PinpointSMSVoiceV2
|
|
1497
1653
|
req.send_request(options)
|
1498
1654
|
end
|
1499
1655
|
|
1656
|
+
# Permanently delete the protect configuration. The protect
|
1657
|
+
# configuration must have deletion protection disabled and must not be
|
1658
|
+
# associated as the account default protect configuration or associated
|
1659
|
+
# with a configuration set.
|
1660
|
+
#
|
1661
|
+
# @option params [required, String] :protect_configuration_id
|
1662
|
+
# The unique identifier for the protect configuration.
|
1663
|
+
#
|
1664
|
+
# @return [Types::DeleteProtectConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1665
|
+
#
|
1666
|
+
# * {Types::DeleteProtectConfigurationResult#protect_configuration_arn #protect_configuration_arn} => String
|
1667
|
+
# * {Types::DeleteProtectConfigurationResult#protect_configuration_id #protect_configuration_id} => String
|
1668
|
+
# * {Types::DeleteProtectConfigurationResult#created_timestamp #created_timestamp} => Time
|
1669
|
+
# * {Types::DeleteProtectConfigurationResult#account_default #account_default} => Boolean
|
1670
|
+
# * {Types::DeleteProtectConfigurationResult#deletion_protection_enabled #deletion_protection_enabled} => Boolean
|
1671
|
+
#
|
1672
|
+
# @example Request syntax with placeholder values
|
1673
|
+
#
|
1674
|
+
# resp = client.delete_protect_configuration({
|
1675
|
+
# protect_configuration_id: "ProtectConfigurationIdOrArn", # required
|
1676
|
+
# })
|
1677
|
+
#
|
1678
|
+
# @example Response structure
|
1679
|
+
#
|
1680
|
+
# resp.protect_configuration_arn #=> String
|
1681
|
+
# resp.protect_configuration_id #=> String
|
1682
|
+
# resp.created_timestamp #=> Time
|
1683
|
+
# resp.account_default #=> Boolean
|
1684
|
+
# resp.deletion_protection_enabled #=> Boolean
|
1685
|
+
#
|
1686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteProtectConfiguration AWS API Documentation
|
1687
|
+
#
|
1688
|
+
# @overload delete_protect_configuration(params = {})
|
1689
|
+
# @param [Hash] params ({})
|
1690
|
+
def delete_protect_configuration(params = {}, options = {})
|
1691
|
+
req = build_request(:delete_protect_configuration, params)
|
1692
|
+
req.send_request(options)
|
1693
|
+
end
|
1694
|
+
|
1500
1695
|
# Permanently delete an existing registration from your account.
|
1501
1696
|
#
|
1502
1697
|
# @option params [required, String] :registration_id
|
@@ -1746,7 +1941,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1746
1941
|
# @example Response structure
|
1747
1942
|
#
|
1748
1943
|
# resp.account_attributes #=> Array
|
1749
|
-
# resp.account_attributes[0].name #=> String, one of "ACCOUNT_TIER"
|
1944
|
+
# resp.account_attributes[0].name #=> String, one of "ACCOUNT_TIER", "DEFAULT_PROTECT_CONFIGURATION_ID"
|
1750
1945
|
# resp.account_attributes[0].value #=> String
|
1751
1946
|
# resp.next_token #=> String
|
1752
1947
|
#
|
@@ -1850,7 +2045,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1850
2045
|
# configuration_set_names: ["ConfigurationSetNameOrArn"],
|
1851
2046
|
# filters: [
|
1852
2047
|
# {
|
1853
|
-
# name: "event-destination-name", # required, accepts event-destination-name, matching-event-types, default-message-type, default-sender-id
|
2048
|
+
# name: "event-destination-name", # required, accepts event-destination-name, matching-event-types, default-message-type, default-sender-id, protect-configuration-id
|
1854
2049
|
# values: ["FilterValue"], # required
|
1855
2050
|
# },
|
1856
2051
|
# ],
|
@@ -1867,7 +2062,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1867
2062
|
# resp.configuration_sets[0].event_destinations[0].event_destination_name #=> String
|
1868
2063
|
# resp.configuration_sets[0].event_destinations[0].enabled #=> Boolean
|
1869
2064
|
# resp.configuration_sets[0].event_destinations[0].matching_event_types #=> Array
|
1870
|
-
# resp.configuration_sets[0].event_destinations[0].matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED"
|
2065
|
+
# resp.configuration_sets[0].event_destinations[0].matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED", "MEDIA_ALL", "MEDIA_PENDING", "MEDIA_QUEUED", "MEDIA_SUCCESSFUL", "MEDIA_DELIVERED", "MEDIA_INVALID", "MEDIA_INVALID_MESSAGE", "MEDIA_UNREACHABLE", "MEDIA_CARRIER_UNREACHABLE", "MEDIA_BLOCKED", "MEDIA_CARRIER_BLOCKED", "MEDIA_SPAM", "MEDIA_UNKNOWN", "MEDIA_TTL_EXPIRED", "MEDIA_FILE_INACCESSIBLE", "MEDIA_FILE_TYPE_UNSUPPORTED", "MEDIA_FILE_SIZE_EXCEEDED"
|
1871
2066
|
# resp.configuration_sets[0].event_destinations[0].cloud_watch_logs_destination.iam_role_arn #=> String
|
1872
2067
|
# resp.configuration_sets[0].event_destinations[0].cloud_watch_logs_destination.log_group_arn #=> String
|
1873
2068
|
# resp.configuration_sets[0].event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
|
@@ -1876,6 +2071,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1876
2071
|
# resp.configuration_sets[0].default_message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
1877
2072
|
# resp.configuration_sets[0].default_sender_id #=> String
|
1878
2073
|
# resp.configuration_sets[0].created_timestamp #=> Time
|
2074
|
+
# resp.configuration_sets[0].protect_configuration_id #=> String
|
1879
2075
|
# resp.next_token #=> String
|
1880
2076
|
#
|
1881
2077
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeConfigurationSets AWS API Documentation
|
@@ -2149,7 +2345,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2149
2345
|
# resp.phone_numbers[0].iso_country_code #=> String
|
2150
2346
|
# resp.phone_numbers[0].message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
2151
2347
|
# resp.phone_numbers[0].number_capabilities #=> Array
|
2152
|
-
# resp.phone_numbers[0].number_capabilities[0] #=> String, one of "SMS", "VOICE"
|
2348
|
+
# resp.phone_numbers[0].number_capabilities[0] #=> String, one of "SMS", "VOICE", "MMS"
|
2153
2349
|
# resp.phone_numbers[0].number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
|
2154
2350
|
# resp.phone_numbers[0].monthly_leasing_price #=> String
|
2155
2351
|
# resp.phone_numbers[0].two_way_enabled #=> Boolean
|
@@ -2248,6 +2444,62 @@ module Aws::PinpointSMSVoiceV2
|
|
2248
2444
|
req.send_request(options)
|
2249
2445
|
end
|
2250
2446
|
|
2447
|
+
# Retrieves the protect configurations that match any of filters. If a
|
2448
|
+
# filter isn’t provided then all protect configurations are returned.
|
2449
|
+
#
|
2450
|
+
# @option params [Array<String>] :protect_configuration_ids
|
2451
|
+
# An array of protect configuration identifiers to search for.
|
2452
|
+
#
|
2453
|
+
# @option params [Array<Types::ProtectConfigurationFilter>] :filters
|
2454
|
+
# An array of ProtectConfigurationFilter objects to filter the results.
|
2455
|
+
#
|
2456
|
+
# @option params [String] :next_token
|
2457
|
+
# The token to be used for the next set of paginated results. You don't
|
2458
|
+
# need to supply a value for this field in the initial request.
|
2459
|
+
#
|
2460
|
+
# @option params [Integer] :max_results
|
2461
|
+
# The maximum number of results to return per each request.
|
2462
|
+
#
|
2463
|
+
# @return [Types::DescribeProtectConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2464
|
+
#
|
2465
|
+
# * {Types::DescribeProtectConfigurationsResult#protect_configurations #protect_configurations} => Array<Types::ProtectConfigurationInformation>
|
2466
|
+
# * {Types::DescribeProtectConfigurationsResult#next_token #next_token} => String
|
2467
|
+
#
|
2468
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2469
|
+
#
|
2470
|
+
# @example Request syntax with placeholder values
|
2471
|
+
#
|
2472
|
+
# resp = client.describe_protect_configurations({
|
2473
|
+
# protect_configuration_ids: ["ProtectConfigurationIdOrArn"],
|
2474
|
+
# filters: [
|
2475
|
+
# {
|
2476
|
+
# name: "account-default", # required, accepts account-default, deletion-protection-enabled
|
2477
|
+
# values: ["FilterValue"], # required
|
2478
|
+
# },
|
2479
|
+
# ],
|
2480
|
+
# next_token: "NextToken",
|
2481
|
+
# max_results: 1,
|
2482
|
+
# })
|
2483
|
+
#
|
2484
|
+
# @example Response structure
|
2485
|
+
#
|
2486
|
+
# resp.protect_configurations #=> Array
|
2487
|
+
# resp.protect_configurations[0].protect_configuration_arn #=> String
|
2488
|
+
# resp.protect_configurations[0].protect_configuration_id #=> String
|
2489
|
+
# resp.protect_configurations[0].created_timestamp #=> Time
|
2490
|
+
# resp.protect_configurations[0].account_default #=> Boolean
|
2491
|
+
# resp.protect_configurations[0].deletion_protection_enabled #=> Boolean
|
2492
|
+
# resp.next_token #=> String
|
2493
|
+
#
|
2494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeProtectConfigurations AWS API Documentation
|
2495
|
+
#
|
2496
|
+
# @overload describe_protect_configurations(params = {})
|
2497
|
+
# @param [Hash] params ({})
|
2498
|
+
def describe_protect_configurations(params = {}, options = {})
|
2499
|
+
req = build_request(:describe_protect_configurations, params)
|
2500
|
+
req.send_request(options)
|
2501
|
+
end
|
2502
|
+
|
2251
2503
|
# Retrieves the specified registration attachments or all registration
|
2252
2504
|
# attachments associated with your Amazon Web Services account.
|
2253
2505
|
#
|
@@ -2811,7 +3063,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2811
3063
|
# @example Response structure
|
2812
3064
|
#
|
2813
3065
|
# resp.spend_limits #=> Array
|
2814
|
-
# resp.spend_limits[0].name #=> String, one of "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT", "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT"
|
3066
|
+
# resp.spend_limits[0].name #=> String, one of "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT", "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT", "MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT"
|
2815
3067
|
# resp.spend_limits[0].enforced_limit #=> Integer
|
2816
3068
|
# resp.spend_limits[0].max_limit #=> Integer
|
2817
3069
|
# resp.spend_limits[0].overridden #=> Boolean
|
@@ -2949,6 +3201,44 @@ module Aws::PinpointSMSVoiceV2
|
|
2949
3201
|
req.send_request(options)
|
2950
3202
|
end
|
2951
3203
|
|
3204
|
+
# Disassociate a protect configuration from a configuration set.
|
3205
|
+
#
|
3206
|
+
# @option params [required, String] :protect_configuration_id
|
3207
|
+
# The unique identifier for the protect configuration.
|
3208
|
+
#
|
3209
|
+
# @option params [required, String] :configuration_set_name
|
3210
|
+
# The name of the ConfigurationSet.
|
3211
|
+
#
|
3212
|
+
# @return [Types::DisassociateProtectConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3213
|
+
#
|
3214
|
+
# * {Types::DisassociateProtectConfigurationResult#configuration_set_arn #configuration_set_arn} => String
|
3215
|
+
# * {Types::DisassociateProtectConfigurationResult#configuration_set_name #configuration_set_name} => String
|
3216
|
+
# * {Types::DisassociateProtectConfigurationResult#protect_configuration_arn #protect_configuration_arn} => String
|
3217
|
+
# * {Types::DisassociateProtectConfigurationResult#protect_configuration_id #protect_configuration_id} => String
|
3218
|
+
#
|
3219
|
+
# @example Request syntax with placeholder values
|
3220
|
+
#
|
3221
|
+
# resp = client.disassociate_protect_configuration({
|
3222
|
+
# protect_configuration_id: "ProtectConfigurationIdOrArn", # required
|
3223
|
+
# configuration_set_name: "ConfigurationSetNameOrArn", # required
|
3224
|
+
# })
|
3225
|
+
#
|
3226
|
+
# @example Response structure
|
3227
|
+
#
|
3228
|
+
# resp.configuration_set_arn #=> String
|
3229
|
+
# resp.configuration_set_name #=> String
|
3230
|
+
# resp.protect_configuration_arn #=> String
|
3231
|
+
# resp.protect_configuration_id #=> String
|
3232
|
+
#
|
3233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateProtectConfiguration AWS API Documentation
|
3234
|
+
#
|
3235
|
+
# @overload disassociate_protect_configuration(params = {})
|
3236
|
+
# @param [Hash] params ({})
|
3237
|
+
def disassociate_protect_configuration(params = {}, options = {})
|
3238
|
+
req = build_request(:disassociate_protect_configuration, params)
|
3239
|
+
req.send_request(options)
|
3240
|
+
end
|
3241
|
+
|
2952
3242
|
# Discard the current version of the registration.
|
2953
3243
|
#
|
2954
3244
|
# @option params [required, String] :registration_id
|
@@ -2992,6 +3282,47 @@ module Aws::PinpointSMSVoiceV2
|
|
2992
3282
|
req.send_request(options)
|
2993
3283
|
end
|
2994
3284
|
|
3285
|
+
# Retrieve the CountryRuleSet for the specified NumberCapability from a
|
3286
|
+
# protect configuration.
|
3287
|
+
#
|
3288
|
+
# @option params [required, String] :protect_configuration_id
|
3289
|
+
# The unique identifier for the protect configuration.
|
3290
|
+
#
|
3291
|
+
# @option params [required, String] :number_capability
|
3292
|
+
# The capability type to return the CountryRuleSet for. Valid values are
|
3293
|
+
# `SMS`, `VOICE`, or `MMS`.
|
3294
|
+
#
|
3295
|
+
# @return [Types::GetProtectConfigurationCountryRuleSetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3296
|
+
#
|
3297
|
+
# * {Types::GetProtectConfigurationCountryRuleSetResult#protect_configuration_arn #protect_configuration_arn} => String
|
3298
|
+
# * {Types::GetProtectConfigurationCountryRuleSetResult#protect_configuration_id #protect_configuration_id} => String
|
3299
|
+
# * {Types::GetProtectConfigurationCountryRuleSetResult#number_capability #number_capability} => String
|
3300
|
+
# * {Types::GetProtectConfigurationCountryRuleSetResult#country_rule_set #country_rule_set} => Hash<String,Types::ProtectConfigurationCountryRuleSetInformation>
|
3301
|
+
#
|
3302
|
+
# @example Request syntax with placeholder values
|
3303
|
+
#
|
3304
|
+
# resp = client.get_protect_configuration_country_rule_set({
|
3305
|
+
# protect_configuration_id: "ProtectConfigurationIdOrArn", # required
|
3306
|
+
# number_capability: "SMS", # required, accepts SMS, VOICE, MMS
|
3307
|
+
# })
|
3308
|
+
#
|
3309
|
+
# @example Response structure
|
3310
|
+
#
|
3311
|
+
# resp.protect_configuration_arn #=> String
|
3312
|
+
# resp.protect_configuration_id #=> String
|
3313
|
+
# resp.number_capability #=> String, one of "SMS", "VOICE", "MMS"
|
3314
|
+
# resp.country_rule_set #=> Hash
|
3315
|
+
# resp.country_rule_set["IsoCountryCode"].protect_status #=> String, one of "ALLOW", "BLOCK"
|
3316
|
+
#
|
3317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/GetProtectConfigurationCountryRuleSet AWS API Documentation
|
3318
|
+
#
|
3319
|
+
# @overload get_protect_configuration_country_rule_set(params = {})
|
3320
|
+
# @param [Hash] params ({})
|
3321
|
+
def get_protect_configuration_country_rule_set(params = {}, options = {})
|
3322
|
+
req = build_request(:get_protect_configuration_country_rule_set, params)
|
3323
|
+
req.send_request(options)
|
3324
|
+
end
|
3325
|
+
|
2995
3326
|
# Lists all associated origination identities in your pool.
|
2996
3327
|
#
|
2997
3328
|
# If you specify filters, the output includes information for only those
|
@@ -3044,7 +3375,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3044
3375
|
# resp.origination_identities[0].origination_identity #=> String
|
3045
3376
|
# resp.origination_identities[0].iso_country_code #=> String
|
3046
3377
|
# resp.origination_identities[0].number_capabilities #=> Array
|
3047
|
-
# resp.origination_identities[0].number_capabilities[0] #=> String, one of "SMS", "VOICE"
|
3378
|
+
# resp.origination_identities[0].number_capabilities[0] #=> String, one of "SMS", "VOICE", "MMS"
|
3048
3379
|
# resp.origination_identities[0].phone_number #=> String
|
3049
3380
|
# resp.next_token #=> String
|
3050
3381
|
#
|
@@ -3366,7 +3697,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3366
3697
|
# resp.iso_country_code #=> String
|
3367
3698
|
# resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
3368
3699
|
# resp.number_capabilities #=> Array
|
3369
|
-
# resp.number_capabilities[0] #=> String, one of "SMS", "VOICE"
|
3700
|
+
# resp.number_capabilities[0] #=> String, one of "SMS", "VOICE", "MMS"
|
3370
3701
|
# resp.number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
|
3371
3702
|
# resp.monthly_leasing_price #=> String
|
3372
3703
|
# resp.two_way_enabled #=> Boolean
|
@@ -3512,7 +3843,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3512
3843
|
# resp = client.request_phone_number({
|
3513
3844
|
# iso_country_code: "IsoCountryCode", # required
|
3514
3845
|
# message_type: "TRANSACTIONAL", # required, accepts TRANSACTIONAL, PROMOTIONAL
|
3515
|
-
# number_capabilities: ["SMS"], # required, accepts SMS, VOICE
|
3846
|
+
# number_capabilities: ["SMS"], # required, accepts SMS, VOICE, MMS
|
3516
3847
|
# number_type: "LONG_CODE", # required, accepts LONG_CODE, TOLL_FREE, TEN_DLC, SIMULATOR
|
3517
3848
|
# opt_out_list_name: "OptOutListNameOrArn",
|
3518
3849
|
# pool_id: "PoolIdOrArn",
|
@@ -3536,7 +3867,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3536
3867
|
# resp.iso_country_code #=> String
|
3537
3868
|
# resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
3538
3869
|
# resp.number_capabilities #=> Array
|
3539
|
-
# resp.number_capabilities[0] #=> String, one of "SMS", "VOICE"
|
3870
|
+
# resp.number_capabilities[0] #=> String, one of "SMS", "VOICE", "MMS"
|
3540
3871
|
# resp.number_type #=> String, one of "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
|
3541
3872
|
# resp.monthly_leasing_price #=> String
|
3542
3873
|
# resp.two_way_enabled #=> Boolean
|
@@ -3715,6 +4046,91 @@ module Aws::PinpointSMSVoiceV2
|
|
3715
4046
|
req.send_request(options)
|
3716
4047
|
end
|
3717
4048
|
|
4049
|
+
# Creates a new multimedia message (MMS) and sends it to a recipient's
|
4050
|
+
# phone number.
|
4051
|
+
#
|
4052
|
+
# @option params [required, String] :destination_phone_number
|
4053
|
+
# The destination phone number in E.164 format.
|
4054
|
+
#
|
4055
|
+
# @option params [required, String] :origination_identity
|
4056
|
+
# The origination identity of the message. This can be either the
|
4057
|
+
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
4058
|
+
# PoolId, or PoolArn.
|
4059
|
+
#
|
4060
|
+
# @option params [String] :message_body
|
4061
|
+
# The text body of the message.
|
4062
|
+
#
|
4063
|
+
# @option params [Array<String>] :media_urls
|
4064
|
+
# An array of URLs to each media file to send.
|
4065
|
+
#
|
4066
|
+
# The media files have to be stored in a publicly available S3 bucket.
|
4067
|
+
# Supported media file formats are listed in [MMS file types, size and
|
4068
|
+
# character limits][1]. For more information on creating an S3 bucket
|
4069
|
+
# and managing objects, see [Creating a bucket][2] and [Uploading
|
4070
|
+
# objects][3] in the S3 user guide.
|
4071
|
+
#
|
4072
|
+
#
|
4073
|
+
#
|
4074
|
+
# [1]: https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html
|
4075
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html
|
4076
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html
|
4077
|
+
#
|
4078
|
+
# @option params [String] :configuration_set_name
|
4079
|
+
# The name of the configuration set to use. This can be either the
|
4080
|
+
# ConfigurationSetName or ConfigurationSetArn.
|
4081
|
+
#
|
4082
|
+
# @option params [String] :max_price
|
4083
|
+
# The maximum amount that you want to spend, in US dollars, per each MMS
|
4084
|
+
# message.
|
4085
|
+
#
|
4086
|
+
# @option params [Integer] :time_to_live
|
4087
|
+
# How long the text message is valid for. By default this is 72 hours.
|
4088
|
+
#
|
4089
|
+
# @option params [Hash<String,String>] :context
|
4090
|
+
# You can specify custom data in this field. If you do, that data is
|
4091
|
+
# logged to the event destination.
|
4092
|
+
#
|
4093
|
+
# @option params [Boolean] :dry_run
|
4094
|
+
# When set to true, the message is checked and validated, but isn't
|
4095
|
+
# sent to the end recipient.
|
4096
|
+
#
|
4097
|
+
# @option params [String] :protect_configuration_id
|
4098
|
+
# The unique identifier of the protect configuration to use.
|
4099
|
+
#
|
4100
|
+
# @return [Types::SendMediaMessageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4101
|
+
#
|
4102
|
+
# * {Types::SendMediaMessageResult#message_id #message_id} => String
|
4103
|
+
#
|
4104
|
+
# @example Request syntax with placeholder values
|
4105
|
+
#
|
4106
|
+
# resp = client.send_media_message({
|
4107
|
+
# destination_phone_number: "PhoneNumber", # required
|
4108
|
+
# origination_identity: "MediaMessageOriginationIdentity", # required
|
4109
|
+
# message_body: "TextMessageBody",
|
4110
|
+
# media_urls: ["MediaUrlValue"],
|
4111
|
+
# configuration_set_name: "ConfigurationSetNameOrArn",
|
4112
|
+
# max_price: "MaxPrice",
|
4113
|
+
# time_to_live: 1,
|
4114
|
+
# context: {
|
4115
|
+
# "ContextKey" => "ContextValue",
|
4116
|
+
# },
|
4117
|
+
# dry_run: false,
|
4118
|
+
# protect_configuration_id: "ProtectConfigurationIdOrArn",
|
4119
|
+
# })
|
4120
|
+
#
|
4121
|
+
# @example Response structure
|
4122
|
+
#
|
4123
|
+
# resp.message_id #=> String
|
4124
|
+
#
|
4125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendMediaMessage AWS API Documentation
|
4126
|
+
#
|
4127
|
+
# @overload send_media_message(params = {})
|
4128
|
+
# @param [Hash] params ({})
|
4129
|
+
def send_media_message(params = {}, options = {})
|
4130
|
+
req = build_request(:send_media_message, params)
|
4131
|
+
req.send_request(options)
|
4132
|
+
end
|
4133
|
+
|
3718
4134
|
# Creates a new text message and sends it to a recipient's phone
|
3719
4135
|
# number.
|
3720
4136
|
#
|
@@ -3778,6 +4194,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3778
4194
|
# When set to true, the message is checked and validated, but isn't
|
3779
4195
|
# sent to the end recipient.
|
3780
4196
|
#
|
4197
|
+
# @option params [String] :protect_configuration_id
|
4198
|
+
# The unique identifier for the protect configuration.
|
4199
|
+
#
|
3781
4200
|
# @return [Types::SendTextMessageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3782
4201
|
#
|
3783
4202
|
# * {Types::SendTextMessageResult#message_id #message_id} => String
|
@@ -3800,6 +4219,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3800
4219
|
# "IN_TEMPLATE_ID" => "DestinationCountryParameterValue",
|
3801
4220
|
# },
|
3802
4221
|
# dry_run: false,
|
4222
|
+
# protect_configuration_id: "ProtectConfigurationIdOrArn",
|
3803
4223
|
# })
|
3804
4224
|
#
|
3805
4225
|
# @example Response structure
|
@@ -3873,6 +4293,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3873
4293
|
# When set to true, the message is checked and validated, but isn't
|
3874
4294
|
# sent to the end recipient.
|
3875
4295
|
#
|
4296
|
+
# @option params [String] :protect_configuration_id
|
4297
|
+
# The unique identifier for the protect configuration.
|
4298
|
+
#
|
3876
4299
|
# @return [Types::SendVoiceMessageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3877
4300
|
#
|
3878
4301
|
# * {Types::SendVoiceMessageResult#message_id #message_id} => String
|
@@ -3892,6 +4315,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3892
4315
|
# "ContextKey" => "ContextValue",
|
3893
4316
|
# },
|
3894
4317
|
# dry_run: false,
|
4318
|
+
# protect_configuration_id: "ProtectConfigurationIdOrArn",
|
3895
4319
|
# })
|
3896
4320
|
#
|
3897
4321
|
# @example Response structure
|
@@ -3907,6 +4331,39 @@ module Aws::PinpointSMSVoiceV2
|
|
3907
4331
|
req.send_request(options)
|
3908
4332
|
end
|
3909
4333
|
|
4334
|
+
# Set a protect configuration as your account default. You can only have
|
4335
|
+
# one account default protect configuration at a time. The current
|
4336
|
+
# account default protect configuration is replaced with the provided
|
4337
|
+
# protect configuration.
|
4338
|
+
#
|
4339
|
+
# @option params [required, String] :protect_configuration_id
|
4340
|
+
# The unique identifier for the protect configuration.
|
4341
|
+
#
|
4342
|
+
# @return [Types::SetAccountDefaultProtectConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4343
|
+
#
|
4344
|
+
# * {Types::SetAccountDefaultProtectConfigurationResult#default_protect_configuration_arn #default_protect_configuration_arn} => String
|
4345
|
+
# * {Types::SetAccountDefaultProtectConfigurationResult#default_protect_configuration_id #default_protect_configuration_id} => String
|
4346
|
+
#
|
4347
|
+
# @example Request syntax with placeholder values
|
4348
|
+
#
|
4349
|
+
# resp = client.set_account_default_protect_configuration({
|
4350
|
+
# protect_configuration_id: "ProtectConfigurationIdOrArn", # required
|
4351
|
+
# })
|
4352
|
+
#
|
4353
|
+
# @example Response structure
|
4354
|
+
#
|
4355
|
+
# resp.default_protect_configuration_arn #=> String
|
4356
|
+
# resp.default_protect_configuration_id #=> String
|
4357
|
+
#
|
4358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetAccountDefaultProtectConfiguration AWS API Documentation
|
4359
|
+
#
|
4360
|
+
# @overload set_account_default_protect_configuration(params = {})
|
4361
|
+
# @param [Hash] params ({})
|
4362
|
+
def set_account_default_protect_configuration(params = {}, options = {})
|
4363
|
+
req = build_request(:set_account_default_protect_configuration, params)
|
4364
|
+
req.send_request(options)
|
4365
|
+
end
|
4366
|
+
|
3910
4367
|
# Sets the default message type on a configuration set.
|
3911
4368
|
#
|
3912
4369
|
# Choose the category of SMS messages that you plan to send from this
|
@@ -4000,6 +4457,36 @@ module Aws::PinpointSMSVoiceV2
|
|
4000
4457
|
req.send_request(options)
|
4001
4458
|
end
|
4002
4459
|
|
4460
|
+
# Sets an account level monthly spend limit override for sending MMS
|
4461
|
+
# messages. The requested spend limit must be less than or equal to the
|
4462
|
+
# `MaxLimit`, which is set by Amazon Web Services.
|
4463
|
+
#
|
4464
|
+
# @option params [required, Integer] :monthly_limit
|
4465
|
+
# The new monthly limit to enforce on text messages.
|
4466
|
+
#
|
4467
|
+
# @return [Types::SetMediaMessageSpendLimitOverrideResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4468
|
+
#
|
4469
|
+
# * {Types::SetMediaMessageSpendLimitOverrideResult#monthly_limit #monthly_limit} => Integer
|
4470
|
+
#
|
4471
|
+
# @example Request syntax with placeholder values
|
4472
|
+
#
|
4473
|
+
# resp = client.set_media_message_spend_limit_override({
|
4474
|
+
# monthly_limit: 1, # required
|
4475
|
+
# })
|
4476
|
+
#
|
4477
|
+
# @example Response structure
|
4478
|
+
#
|
4479
|
+
# resp.monthly_limit #=> Integer
|
4480
|
+
#
|
4481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetMediaMessageSpendLimitOverride AWS API Documentation
|
4482
|
+
#
|
4483
|
+
# @overload set_media_message_spend_limit_override(params = {})
|
4484
|
+
# @param [Hash] params ({})
|
4485
|
+
def set_media_message_spend_limit_override(params = {}, options = {})
|
4486
|
+
req = build_request(:set_media_message_spend_limit_override, params)
|
4487
|
+
req.send_request(options)
|
4488
|
+
end
|
4489
|
+
|
4003
4490
|
# Sets an account level monthly spend limit override for sending text
|
4004
4491
|
# messages. The requested spend limit must be less than or equal to the
|
4005
4492
|
# `MaxLimit`, which is set by Amazon Web Services.
|
@@ -4229,7 +4716,7 @@ module Aws::PinpointSMSVoiceV2
|
|
4229
4716
|
# configuration_set_name: "ConfigurationSetNameOrArn", # required
|
4230
4717
|
# event_destination_name: "EventDestinationName", # required
|
4231
4718
|
# enabled: false,
|
4232
|
-
# matching_event_types: ["ALL"], # accepts ALL, TEXT_ALL, TEXT_SENT, TEXT_PENDING, TEXT_QUEUED, TEXT_SUCCESSFUL, TEXT_DELIVERED, TEXT_INVALID, TEXT_INVALID_MESSAGE, TEXT_UNREACHABLE, TEXT_CARRIER_UNREACHABLE, TEXT_BLOCKED, TEXT_CARRIER_BLOCKED, TEXT_SPAM, TEXT_UNKNOWN, TEXT_TTL_EXPIRED, VOICE_ALL, VOICE_INITIATED, VOICE_RINGING, VOICE_ANSWERED, VOICE_COMPLETED, VOICE_BUSY, VOICE_NO_ANSWER, VOICE_FAILED, VOICE_TTL_EXPIRED
|
4719
|
+
# matching_event_types: ["ALL"], # accepts ALL, TEXT_ALL, TEXT_SENT, TEXT_PENDING, TEXT_QUEUED, TEXT_SUCCESSFUL, TEXT_DELIVERED, TEXT_INVALID, TEXT_INVALID_MESSAGE, TEXT_UNREACHABLE, TEXT_CARRIER_UNREACHABLE, TEXT_BLOCKED, TEXT_CARRIER_BLOCKED, TEXT_SPAM, TEXT_UNKNOWN, TEXT_TTL_EXPIRED, VOICE_ALL, VOICE_INITIATED, VOICE_RINGING, VOICE_ANSWERED, VOICE_COMPLETED, VOICE_BUSY, VOICE_NO_ANSWER, VOICE_FAILED, VOICE_TTL_EXPIRED, MEDIA_ALL, MEDIA_PENDING, MEDIA_QUEUED, MEDIA_SUCCESSFUL, MEDIA_DELIVERED, MEDIA_INVALID, MEDIA_INVALID_MESSAGE, MEDIA_UNREACHABLE, MEDIA_CARRIER_UNREACHABLE, MEDIA_BLOCKED, MEDIA_CARRIER_BLOCKED, MEDIA_SPAM, MEDIA_UNKNOWN, MEDIA_TTL_EXPIRED, MEDIA_FILE_INACCESSIBLE, MEDIA_FILE_TYPE_UNSUPPORTED, MEDIA_FILE_SIZE_EXCEEDED
|
4233
4720
|
# cloud_watch_logs_destination: {
|
4234
4721
|
# iam_role_arn: "IamRoleArn", # required
|
4235
4722
|
# log_group_arn: "LogGroupArn", # required
|
@@ -4250,7 +4737,7 @@ module Aws::PinpointSMSVoiceV2
|
|
4250
4737
|
# resp.event_destination.event_destination_name #=> String
|
4251
4738
|
# resp.event_destination.enabled #=> Boolean
|
4252
4739
|
# resp.event_destination.matching_event_types #=> Array
|
4253
|
-
# resp.event_destination.matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED"
|
4740
|
+
# resp.event_destination.matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED", "MEDIA_ALL", "MEDIA_PENDING", "MEDIA_QUEUED", "MEDIA_SUCCESSFUL", "MEDIA_DELIVERED", "MEDIA_INVALID", "MEDIA_INVALID_MESSAGE", "MEDIA_UNREACHABLE", "MEDIA_CARRIER_UNREACHABLE", "MEDIA_BLOCKED", "MEDIA_CARRIER_BLOCKED", "MEDIA_SPAM", "MEDIA_UNKNOWN", "MEDIA_TTL_EXPIRED", "MEDIA_FILE_INACCESSIBLE", "MEDIA_FILE_TYPE_UNSUPPORTED", "MEDIA_FILE_SIZE_EXCEEDED"
|
4254
4741
|
# resp.event_destination.cloud_watch_logs_destination.iam_role_arn #=> String
|
4255
4742
|
# resp.event_destination.cloud_watch_logs_destination.log_group_arn #=> String
|
4256
4743
|
# resp.event_destination.kinesis_firehose_destination.iam_role_arn #=> String
|
@@ -4346,7 +4833,7 @@ module Aws::PinpointSMSVoiceV2
|
|
4346
4833
|
# resp.iso_country_code #=> String
|
4347
4834
|
# resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
|
4348
4835
|
# resp.number_capabilities #=> Array
|
4349
|
-
# resp.number_capabilities[0] #=> String, one of "SMS", "VOICE"
|
4836
|
+
# resp.number_capabilities[0] #=> String, one of "SMS", "VOICE", "MMS"
|
4350
4837
|
# resp.number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
|
4351
4838
|
# resp.monthly_leasing_price #=> String
|
4352
4839
|
# resp.two_way_enabled #=> Boolean
|
@@ -4457,6 +4944,105 @@ module Aws::PinpointSMSVoiceV2
|
|
4457
4944
|
req.send_request(options)
|
4458
4945
|
end
|
4459
4946
|
|
4947
|
+
# Update the setting for an existing protect configuration.
|
4948
|
+
#
|
4949
|
+
# @option params [required, String] :protect_configuration_id
|
4950
|
+
# The unique identifier for the protect configuration.
|
4951
|
+
#
|
4952
|
+
# @option params [Boolean] :deletion_protection_enabled
|
4953
|
+
# When set to true deletion protection is enabled. By default this is
|
4954
|
+
# set to false.
|
4955
|
+
#
|
4956
|
+
# @return [Types::UpdateProtectConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4957
|
+
#
|
4958
|
+
# * {Types::UpdateProtectConfigurationResult#protect_configuration_arn #protect_configuration_arn} => String
|
4959
|
+
# * {Types::UpdateProtectConfigurationResult#protect_configuration_id #protect_configuration_id} => String
|
4960
|
+
# * {Types::UpdateProtectConfigurationResult#created_timestamp #created_timestamp} => Time
|
4961
|
+
# * {Types::UpdateProtectConfigurationResult#account_default #account_default} => Boolean
|
4962
|
+
# * {Types::UpdateProtectConfigurationResult#deletion_protection_enabled #deletion_protection_enabled} => Boolean
|
4963
|
+
#
|
4964
|
+
# @example Request syntax with placeholder values
|
4965
|
+
#
|
4966
|
+
# resp = client.update_protect_configuration({
|
4967
|
+
# protect_configuration_id: "ProtectConfigurationIdOrArn", # required
|
4968
|
+
# deletion_protection_enabled: false,
|
4969
|
+
# })
|
4970
|
+
#
|
4971
|
+
# @example Response structure
|
4972
|
+
#
|
4973
|
+
# resp.protect_configuration_arn #=> String
|
4974
|
+
# resp.protect_configuration_id #=> String
|
4975
|
+
# resp.created_timestamp #=> Time
|
4976
|
+
# resp.account_default #=> Boolean
|
4977
|
+
# resp.deletion_protection_enabled #=> Boolean
|
4978
|
+
#
|
4979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateProtectConfiguration AWS API Documentation
|
4980
|
+
#
|
4981
|
+
# @overload update_protect_configuration(params = {})
|
4982
|
+
# @param [Hash] params ({})
|
4983
|
+
def update_protect_configuration(params = {}, options = {})
|
4984
|
+
req = build_request(:update_protect_configuration, params)
|
4985
|
+
req.send_request(options)
|
4986
|
+
end
|
4987
|
+
|
4988
|
+
# Update a country rule set to `ALLOW` or `BLOCK` messages to be sent to
|
4989
|
+
# the specified destination counties. You can update one or multiple
|
4990
|
+
# countries at a time. The updates are only applied to the specified
|
4991
|
+
# NumberCapability type.
|
4992
|
+
#
|
4993
|
+
# @option params [required, String] :protect_configuration_id
|
4994
|
+
# The unique identifier for the protect configuration.
|
4995
|
+
#
|
4996
|
+
# @option params [required, String] :number_capability
|
4997
|
+
# The number capability to apply the CountryRuleSetUpdates updates to.
|
4998
|
+
#
|
4999
|
+
# @option params [required, Hash<String,Types::ProtectConfigurationCountryRuleSetInformation>] :country_rule_set_updates
|
5000
|
+
# A map of ProtectConfigurationCountryRuleSetInformation objects that
|
5001
|
+
# contain the details for the requested NumberCapability. The Key is the
|
5002
|
+
# two-letter ISO country code. For a list of supported ISO country
|
5003
|
+
# codes, see [Supported countries and regions (SMS channel)][1] in the
|
5004
|
+
# Amazon Pinpoint SMS user guide.
|
5005
|
+
#
|
5006
|
+
#
|
5007
|
+
#
|
5008
|
+
# [1]: https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html
|
5009
|
+
#
|
5010
|
+
# @return [Types::UpdateProtectConfigurationCountryRuleSetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5011
|
+
#
|
5012
|
+
# * {Types::UpdateProtectConfigurationCountryRuleSetResult#protect_configuration_arn #protect_configuration_arn} => String
|
5013
|
+
# * {Types::UpdateProtectConfigurationCountryRuleSetResult#protect_configuration_id #protect_configuration_id} => String
|
5014
|
+
# * {Types::UpdateProtectConfigurationCountryRuleSetResult#number_capability #number_capability} => String
|
5015
|
+
# * {Types::UpdateProtectConfigurationCountryRuleSetResult#country_rule_set #country_rule_set} => Hash<String,Types::ProtectConfigurationCountryRuleSetInformation>
|
5016
|
+
#
|
5017
|
+
# @example Request syntax with placeholder values
|
5018
|
+
#
|
5019
|
+
# resp = client.update_protect_configuration_country_rule_set({
|
5020
|
+
# protect_configuration_id: "ProtectConfigurationIdOrArn", # required
|
5021
|
+
# number_capability: "SMS", # required, accepts SMS, VOICE, MMS
|
5022
|
+
# country_rule_set_updates: { # required
|
5023
|
+
# "IsoCountryCode" => {
|
5024
|
+
# protect_status: "ALLOW", # required, accepts ALLOW, BLOCK
|
5025
|
+
# },
|
5026
|
+
# },
|
5027
|
+
# })
|
5028
|
+
#
|
5029
|
+
# @example Response structure
|
5030
|
+
#
|
5031
|
+
# resp.protect_configuration_arn #=> String
|
5032
|
+
# resp.protect_configuration_id #=> String
|
5033
|
+
# resp.number_capability #=> String, one of "SMS", "VOICE", "MMS"
|
5034
|
+
# resp.country_rule_set #=> Hash
|
5035
|
+
# resp.country_rule_set["IsoCountryCode"].protect_status #=> String, one of "ALLOW", "BLOCK"
|
5036
|
+
#
|
5037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateProtectConfigurationCountryRuleSet AWS API Documentation
|
5038
|
+
#
|
5039
|
+
# @overload update_protect_configuration_country_rule_set(params = {})
|
5040
|
+
# @param [Hash] params ({})
|
5041
|
+
def update_protect_configuration_country_rule_set(params = {}, options = {})
|
5042
|
+
req = build_request(:update_protect_configuration_country_rule_set, params)
|
5043
|
+
req.send_request(options)
|
5044
|
+
end
|
5045
|
+
|
4460
5046
|
# Updates the configuration of an existing sender ID.
|
4461
5047
|
#
|
4462
5048
|
# @option params [required, String] :sender_id
|
@@ -4566,7 +5152,7 @@ module Aws::PinpointSMSVoiceV2
|
|
4566
5152
|
params: params,
|
4567
5153
|
config: config)
|
4568
5154
|
context[:gem_name] = 'aws-sdk-pinpointsmsvoicev2'
|
4569
|
-
context[:gem_version] = '1.
|
5155
|
+
context[:gem_version] = '1.15.0'
|
4570
5156
|
Seahorse::Client::Request.new(handlers, context)
|
4571
5157
|
end
|
4572
5158
|
|