aws-sdk-pinpointsmsvoicev2 1.14.0 → 1.15.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
@@ -150,13 +150,57 @@ module Aws::PinpointSMSVoiceV2
|
|
150
150
|
include Aws::Structure
|
151
151
|
end
|
152
152
|
|
153
|
+
# @!attribute [rw] protect_configuration_id
|
154
|
+
# The unique identifier for the protect configuration.
|
155
|
+
# @return [String]
|
156
|
+
#
|
157
|
+
# @!attribute [rw] configuration_set_name
|
158
|
+
# The name of the ConfigurationSet.
|
159
|
+
# @return [String]
|
160
|
+
#
|
161
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/AssociateProtectConfigurationRequest AWS API Documentation
|
162
|
+
#
|
163
|
+
class AssociateProtectConfigurationRequest < Struct.new(
|
164
|
+
:protect_configuration_id,
|
165
|
+
:configuration_set_name)
|
166
|
+
SENSITIVE = []
|
167
|
+
include Aws::Structure
|
168
|
+
end
|
169
|
+
|
170
|
+
# @!attribute [rw] configuration_set_arn
|
171
|
+
# The Amazon Resource Name (ARN) of the configuration set.
|
172
|
+
# @return [String]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] configuration_set_name
|
175
|
+
# The name of the ConfigurationSet.
|
176
|
+
# @return [String]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] protect_configuration_arn
|
179
|
+
# The Amazon Resource Name (ARN) of the protect configuration.
|
180
|
+
# @return [String]
|
181
|
+
#
|
182
|
+
# @!attribute [rw] protect_configuration_id
|
183
|
+
# The unique identifier for the protect configuration.
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/AssociateProtectConfigurationResult AWS API Documentation
|
187
|
+
#
|
188
|
+
class AssociateProtectConfigurationResult < Struct.new(
|
189
|
+
:configuration_set_arn,
|
190
|
+
:configuration_set_name,
|
191
|
+
:protect_configuration_arn,
|
192
|
+
:protect_configuration_id)
|
193
|
+
SENSITIVE = []
|
194
|
+
include Aws::Structure
|
195
|
+
end
|
196
|
+
|
153
197
|
# Contains the destination configuration to use when publishing message
|
154
198
|
# sending events.
|
155
199
|
#
|
156
200
|
# @!attribute [rw] iam_role_arn
|
157
|
-
# The Amazon Resource Name (ARN) of an
|
158
|
-
#
|
159
|
-
#
|
201
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
202
|
+
# role that is able to write event data to an Amazon CloudWatch
|
203
|
+
# destination.
|
160
204
|
# @return [String]
|
161
205
|
#
|
162
206
|
# @!attribute [rw] log_group_arn
|
@@ -227,6 +271,10 @@ module Aws::PinpointSMSVoiceV2
|
|
227
271
|
# [1]: https://www.epochconverter.com/
|
228
272
|
# @return [Time]
|
229
273
|
#
|
274
|
+
# @!attribute [rw] protect_configuration_id
|
275
|
+
# The unique identifier for the protect configuration.
|
276
|
+
# @return [String]
|
277
|
+
#
|
230
278
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ConfigurationSetInformation AWS API Documentation
|
231
279
|
#
|
232
280
|
class ConfigurationSetInformation < Struct.new(
|
@@ -235,7 +283,8 @@ module Aws::PinpointSMSVoiceV2
|
|
235
283
|
:event_destinations,
|
236
284
|
:default_message_type,
|
237
285
|
:default_sender_id,
|
238
|
-
:created_timestamp
|
286
|
+
:created_timestamp,
|
287
|
+
:protect_configuration_id)
|
239
288
|
SENSITIVE = []
|
240
289
|
include Aws::Structure
|
241
290
|
end
|
@@ -356,7 +405,7 @@ module Aws::PinpointSMSVoiceV2
|
|
356
405
|
#
|
357
406
|
# @!attribute [rw] cloud_watch_logs_destination
|
358
407
|
# An object that contains information about an event destination for
|
359
|
-
# logging to Amazon CloudWatch
|
408
|
+
# logging to Amazon CloudWatch Logs.
|
360
409
|
# @return [Types::CloudWatchLogsDestination]
|
361
410
|
#
|
362
411
|
# @!attribute [rw] kinesis_firehose_destination
|
@@ -618,6 +667,81 @@ module Aws::PinpointSMSVoiceV2
|
|
618
667
|
include Aws::Structure
|
619
668
|
end
|
620
669
|
|
670
|
+
# @!attribute [rw] client_token
|
671
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
672
|
+
# idempotency of the request. If you don't specify a client token, a
|
673
|
+
# randomly generated token is used for the request to ensure
|
674
|
+
# idempotency.
|
675
|
+
#
|
676
|
+
# **A suitable default value is auto-generated.** You should normally
|
677
|
+
# not need to pass this option.
|
678
|
+
# @return [String]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] deletion_protection_enabled
|
681
|
+
# When set to true deletion protection is enabled. By default this is
|
682
|
+
# set to false.
|
683
|
+
# @return [Boolean]
|
684
|
+
#
|
685
|
+
# @!attribute [rw] tags
|
686
|
+
# An array of key and value pair tags that are associated with the
|
687
|
+
# resource.
|
688
|
+
# @return [Array<Types::Tag>]
|
689
|
+
#
|
690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateProtectConfigurationRequest AWS API Documentation
|
691
|
+
#
|
692
|
+
class CreateProtectConfigurationRequest < Struct.new(
|
693
|
+
:client_token,
|
694
|
+
:deletion_protection_enabled,
|
695
|
+
:tags)
|
696
|
+
SENSITIVE = []
|
697
|
+
include Aws::Structure
|
698
|
+
end
|
699
|
+
|
700
|
+
# @!attribute [rw] protect_configuration_arn
|
701
|
+
# The Amazon Resource Name (ARN) of the protect configuration.
|
702
|
+
# @return [String]
|
703
|
+
#
|
704
|
+
# @!attribute [rw] protect_configuration_id
|
705
|
+
# The unique identifier for the protect configuration.
|
706
|
+
# @return [String]
|
707
|
+
#
|
708
|
+
# @!attribute [rw] created_timestamp
|
709
|
+
# The time when the protect configuration was created, in [UNIX epoch
|
710
|
+
# time][1] format.
|
711
|
+
#
|
712
|
+
#
|
713
|
+
#
|
714
|
+
# [1]: https://www.epochconverter.com/
|
715
|
+
# @return [Time]
|
716
|
+
#
|
717
|
+
# @!attribute [rw] account_default
|
718
|
+
# This is true if the protect configuration is set as your account
|
719
|
+
# default protect configuration.
|
720
|
+
# @return [Boolean]
|
721
|
+
#
|
722
|
+
# @!attribute [rw] deletion_protection_enabled
|
723
|
+
# When set to true deletion protection is enabled. By default this is
|
724
|
+
# set to false.
|
725
|
+
# @return [Boolean]
|
726
|
+
#
|
727
|
+
# @!attribute [rw] tags
|
728
|
+
# An array of key and value pair tags that are associated with the
|
729
|
+
# resource.
|
730
|
+
# @return [Array<Types::Tag>]
|
731
|
+
#
|
732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateProtectConfigurationResult AWS API Documentation
|
733
|
+
#
|
734
|
+
class CreateProtectConfigurationResult < Struct.new(
|
735
|
+
:protect_configuration_arn,
|
736
|
+
:protect_configuration_id,
|
737
|
+
:created_timestamp,
|
738
|
+
:account_default,
|
739
|
+
:deletion_protection_enabled,
|
740
|
+
:tags)
|
741
|
+
SENSITIVE = []
|
742
|
+
include Aws::Structure
|
743
|
+
end
|
744
|
+
|
621
745
|
# @!attribute [rw] registration_id
|
622
746
|
# The unique identifier for the registration.
|
623
747
|
# @return [String]
|
@@ -1021,6 +1145,30 @@ module Aws::PinpointSMSVoiceV2
|
|
1021
1145
|
include Aws::Structure
|
1022
1146
|
end
|
1023
1147
|
|
1148
|
+
# @api private
|
1149
|
+
#
|
1150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteAccountDefaultProtectConfigurationRequest AWS API Documentation
|
1151
|
+
#
|
1152
|
+
class DeleteAccountDefaultProtectConfigurationRequest < Aws::EmptyStructure; end
|
1153
|
+
|
1154
|
+
# @!attribute [rw] default_protect_configuration_arn
|
1155
|
+
# The Amazon Resource Name (ARN) of the account default protect
|
1156
|
+
# configuration.
|
1157
|
+
# @return [String]
|
1158
|
+
#
|
1159
|
+
# @!attribute [rw] default_protect_configuration_id
|
1160
|
+
# The unique identifier of the account default protect configuration.
|
1161
|
+
# @return [String]
|
1162
|
+
#
|
1163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteAccountDefaultProtectConfigurationResult AWS API Documentation
|
1164
|
+
#
|
1165
|
+
class DeleteAccountDefaultProtectConfigurationResult < Struct.new(
|
1166
|
+
:default_protect_configuration_arn,
|
1167
|
+
:default_protect_configuration_id)
|
1168
|
+
SENSITIVE = []
|
1169
|
+
include Aws::Structure
|
1170
|
+
end
|
1171
|
+
|
1024
1172
|
# @!attribute [rw] configuration_set_name
|
1025
1173
|
# The name of the configuration set or the configuration set ARN that
|
1026
1174
|
# you want to delete. The ConfigurationSetName and ConfigurationSetArn
|
@@ -1247,6 +1395,24 @@ module Aws::PinpointSMSVoiceV2
|
|
1247
1395
|
include Aws::Structure
|
1248
1396
|
end
|
1249
1397
|
|
1398
|
+
# @api private
|
1399
|
+
#
|
1400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteMediaMessageSpendLimitOverrideRequest AWS API Documentation
|
1401
|
+
#
|
1402
|
+
class DeleteMediaMessageSpendLimitOverrideRequest < Aws::EmptyStructure; end
|
1403
|
+
|
1404
|
+
# @!attribute [rw] monthly_limit
|
1405
|
+
# The current monthly limit, in US dollars.
|
1406
|
+
# @return [Integer]
|
1407
|
+
#
|
1408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteMediaMessageSpendLimitOverrideResult AWS API Documentation
|
1409
|
+
#
|
1410
|
+
class DeleteMediaMessageSpendLimitOverrideResult < Struct.new(
|
1411
|
+
:monthly_limit)
|
1412
|
+
SENSITIVE = []
|
1413
|
+
include Aws::Structure
|
1414
|
+
end
|
1415
|
+
|
1250
1416
|
# @!attribute [rw] opt_out_list_name
|
1251
1417
|
# The OptOutListName or OptOutListArn of the OptOutList to delete. You
|
1252
1418
|
# can use DescribeOptOutLists to find the values for OptOutListName
|
@@ -1437,6 +1603,58 @@ module Aws::PinpointSMSVoiceV2
|
|
1437
1603
|
include Aws::Structure
|
1438
1604
|
end
|
1439
1605
|
|
1606
|
+
# @!attribute [rw] protect_configuration_id
|
1607
|
+
# The unique identifier for the protect configuration.
|
1608
|
+
# @return [String]
|
1609
|
+
#
|
1610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteProtectConfigurationRequest AWS API Documentation
|
1611
|
+
#
|
1612
|
+
class DeleteProtectConfigurationRequest < Struct.new(
|
1613
|
+
:protect_configuration_id)
|
1614
|
+
SENSITIVE = []
|
1615
|
+
include Aws::Structure
|
1616
|
+
end
|
1617
|
+
|
1618
|
+
# @!attribute [rw] protect_configuration_arn
|
1619
|
+
# The Amazon Resource Name (ARN) of the protect configuration.
|
1620
|
+
# @return [String]
|
1621
|
+
#
|
1622
|
+
# @!attribute [rw] protect_configuration_id
|
1623
|
+
# The unique identifier for the protect configuration.
|
1624
|
+
# @return [String]
|
1625
|
+
#
|
1626
|
+
# @!attribute [rw] created_timestamp
|
1627
|
+
# The time when the protect configuration was created, in [UNIX epoch
|
1628
|
+
# time][1] format.
|
1629
|
+
#
|
1630
|
+
#
|
1631
|
+
#
|
1632
|
+
# [1]: https://www.epochconverter.com/
|
1633
|
+
# @return [Time]
|
1634
|
+
#
|
1635
|
+
# @!attribute [rw] account_default
|
1636
|
+
# This is true if the protect configuration is set as your account
|
1637
|
+
# default protect configuration.
|
1638
|
+
# @return [Boolean]
|
1639
|
+
#
|
1640
|
+
# @!attribute [rw] deletion_protection_enabled
|
1641
|
+
# The status of deletion protection for the protect configuration.
|
1642
|
+
# When set to true deletion protection is enabled. By default this is
|
1643
|
+
# set to false.
|
1644
|
+
# @return [Boolean]
|
1645
|
+
#
|
1646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteProtectConfigurationResult AWS API Documentation
|
1647
|
+
#
|
1648
|
+
class DeleteProtectConfigurationResult < Struct.new(
|
1649
|
+
:protect_configuration_arn,
|
1650
|
+
:protect_configuration_id,
|
1651
|
+
:created_timestamp,
|
1652
|
+
:account_default,
|
1653
|
+
:deletion_protection_enabled)
|
1654
|
+
SENSITIVE = []
|
1655
|
+
include Aws::Structure
|
1656
|
+
end
|
1657
|
+
|
1440
1658
|
# @!attribute [rw] registration_attachment_id
|
1441
1659
|
# The unique identifier for the registration attachment.
|
1442
1660
|
# @return [String]
|
@@ -2118,6 +2336,54 @@ module Aws::PinpointSMSVoiceV2
|
|
2118
2336
|
include Aws::Structure
|
2119
2337
|
end
|
2120
2338
|
|
2339
|
+
# @!attribute [rw] protect_configuration_ids
|
2340
|
+
# An array of protect configuration identifiers to search for.
|
2341
|
+
# @return [Array<String>]
|
2342
|
+
#
|
2343
|
+
# @!attribute [rw] filters
|
2344
|
+
# An array of ProtectConfigurationFilter objects to filter the
|
2345
|
+
# results.
|
2346
|
+
# @return [Array<Types::ProtectConfigurationFilter>]
|
2347
|
+
#
|
2348
|
+
# @!attribute [rw] next_token
|
2349
|
+
# The token to be used for the next set of paginated results. You
|
2350
|
+
# don't need to supply a value for this field in the initial request.
|
2351
|
+
# @return [String]
|
2352
|
+
#
|
2353
|
+
# @!attribute [rw] max_results
|
2354
|
+
# The maximum number of results to return per each request.
|
2355
|
+
# @return [Integer]
|
2356
|
+
#
|
2357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeProtectConfigurationsRequest AWS API Documentation
|
2358
|
+
#
|
2359
|
+
class DescribeProtectConfigurationsRequest < Struct.new(
|
2360
|
+
:protect_configuration_ids,
|
2361
|
+
:filters,
|
2362
|
+
:next_token,
|
2363
|
+
:max_results)
|
2364
|
+
SENSITIVE = []
|
2365
|
+
include Aws::Structure
|
2366
|
+
end
|
2367
|
+
|
2368
|
+
# @!attribute [rw] protect_configurations
|
2369
|
+
# An array of ProtectConfigurationInformation objects that contain the
|
2370
|
+
# details for the request.
|
2371
|
+
# @return [Array<Types::ProtectConfigurationInformation>]
|
2372
|
+
#
|
2373
|
+
# @!attribute [rw] next_token
|
2374
|
+
# The token to be used for the next set of paginated results. You
|
2375
|
+
# don't need to supply a value for this field in the initial request.
|
2376
|
+
# @return [String]
|
2377
|
+
#
|
2378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeProtectConfigurationsResult AWS API Documentation
|
2379
|
+
#
|
2380
|
+
class DescribeProtectConfigurationsResult < Struct.new(
|
2381
|
+
:protect_configurations,
|
2382
|
+
:next_token)
|
2383
|
+
SENSITIVE = []
|
2384
|
+
include Aws::Structure
|
2385
|
+
end
|
2386
|
+
|
2121
2387
|
# @!attribute [rw] registration_attachment_ids
|
2122
2388
|
# The unique identifier of registration attachments to find. This is
|
2123
2389
|
# an array of **RegistrationAttachmentId**.
|
@@ -2716,6 +2982,50 @@ module Aws::PinpointSMSVoiceV2
|
|
2716
2982
|
include Aws::Structure
|
2717
2983
|
end
|
2718
2984
|
|
2985
|
+
# @!attribute [rw] protect_configuration_id
|
2986
|
+
# The unique identifier for the protect configuration.
|
2987
|
+
# @return [String]
|
2988
|
+
#
|
2989
|
+
# @!attribute [rw] configuration_set_name
|
2990
|
+
# The name of the ConfigurationSet.
|
2991
|
+
# @return [String]
|
2992
|
+
#
|
2993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateProtectConfigurationRequest AWS API Documentation
|
2994
|
+
#
|
2995
|
+
class DisassociateProtectConfigurationRequest < Struct.new(
|
2996
|
+
:protect_configuration_id,
|
2997
|
+
:configuration_set_name)
|
2998
|
+
SENSITIVE = []
|
2999
|
+
include Aws::Structure
|
3000
|
+
end
|
3001
|
+
|
3002
|
+
# @!attribute [rw] configuration_set_arn
|
3003
|
+
# The Amazon Resource Name (ARN) of the configuration set.
|
3004
|
+
# @return [String]
|
3005
|
+
#
|
3006
|
+
# @!attribute [rw] configuration_set_name
|
3007
|
+
# The name of the ConfigurationSet.
|
3008
|
+
# @return [String]
|
3009
|
+
#
|
3010
|
+
# @!attribute [rw] protect_configuration_arn
|
3011
|
+
# The Amazon Resource Name (ARN) of the protect configuration.
|
3012
|
+
# @return [String]
|
3013
|
+
#
|
3014
|
+
# @!attribute [rw] protect_configuration_id
|
3015
|
+
# The unique identifier for the protect configuration.
|
3016
|
+
# @return [String]
|
3017
|
+
#
|
3018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateProtectConfigurationResult AWS API Documentation
|
3019
|
+
#
|
3020
|
+
class DisassociateProtectConfigurationResult < Struct.new(
|
3021
|
+
:configuration_set_arn,
|
3022
|
+
:configuration_set_name,
|
3023
|
+
:protect_configuration_arn,
|
3024
|
+
:protect_configuration_id)
|
3025
|
+
SENSITIVE = []
|
3026
|
+
include Aws::Structure
|
3027
|
+
end
|
3028
|
+
|
2719
3029
|
# @!attribute [rw] registration_id
|
2720
3030
|
# The unique identifier for the registration.
|
2721
3031
|
# @return [String]
|
@@ -2786,7 +3096,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2786
3096
|
#
|
2787
3097
|
# Event destinations are associated with configuration sets, which
|
2788
3098
|
# enable you to publish message sending events to CloudWatch, Kinesis
|
2789
|
-
# Data Firehose,or Amazon SNS.
|
3099
|
+
# Data Firehose, or Amazon SNS.
|
2790
3100
|
#
|
2791
3101
|
# @!attribute [rw] event_destination_name
|
2792
3102
|
# The name of the EventDestination.
|
@@ -2832,6 +3142,60 @@ module Aws::PinpointSMSVoiceV2
|
|
2832
3142
|
include Aws::Structure
|
2833
3143
|
end
|
2834
3144
|
|
3145
|
+
# @!attribute [rw] protect_configuration_id
|
3146
|
+
# The unique identifier for the protect configuration.
|
3147
|
+
# @return [String]
|
3148
|
+
#
|
3149
|
+
# @!attribute [rw] number_capability
|
3150
|
+
# The capability type to return the CountryRuleSet for. Valid values
|
3151
|
+
# are `SMS`, `VOICE`, or `MMS`.
|
3152
|
+
# @return [String]
|
3153
|
+
#
|
3154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/GetProtectConfigurationCountryRuleSetRequest AWS API Documentation
|
3155
|
+
#
|
3156
|
+
class GetProtectConfigurationCountryRuleSetRequest < Struct.new(
|
3157
|
+
:protect_configuration_id,
|
3158
|
+
:number_capability)
|
3159
|
+
SENSITIVE = []
|
3160
|
+
include Aws::Structure
|
3161
|
+
end
|
3162
|
+
|
3163
|
+
# @!attribute [rw] protect_configuration_arn
|
3164
|
+
# The Amazon Resource Name (ARN) of the protect configuration.
|
3165
|
+
# @return [String]
|
3166
|
+
#
|
3167
|
+
# @!attribute [rw] protect_configuration_id
|
3168
|
+
# The unique identifier for the protect configuration.
|
3169
|
+
# @return [String]
|
3170
|
+
#
|
3171
|
+
# @!attribute [rw] number_capability
|
3172
|
+
# The capability type associated with the returned
|
3173
|
+
# ProtectConfigurationCountryRuleSetInformation objects.
|
3174
|
+
# @return [String]
|
3175
|
+
#
|
3176
|
+
# @!attribute [rw] country_rule_set
|
3177
|
+
# A map of ProtectConfigurationCountryRuleSetInformation objects that
|
3178
|
+
# contain the details for the requested NumberCapability. The Key is
|
3179
|
+
# the two-letter ISO country code. For a list of supported ISO country
|
3180
|
+
# codes, see [Supported countries and regions (SMS channel)][1] in the
|
3181
|
+
# Amazon Pinpoint SMS user guide.
|
3182
|
+
#
|
3183
|
+
#
|
3184
|
+
#
|
3185
|
+
# [1]: https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html
|
3186
|
+
# @return [Hash<String,Types::ProtectConfigurationCountryRuleSetInformation>]
|
3187
|
+
#
|
3188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/GetProtectConfigurationCountryRuleSetResult AWS API Documentation
|
3189
|
+
#
|
3190
|
+
class GetProtectConfigurationCountryRuleSetResult < Struct.new(
|
3191
|
+
:protect_configuration_arn,
|
3192
|
+
:protect_configuration_id,
|
3193
|
+
:number_capability,
|
3194
|
+
:country_rule_set)
|
3195
|
+
SENSITIVE = []
|
3196
|
+
include Aws::Structure
|
3197
|
+
end
|
3198
|
+
|
2835
3199
|
# The API encountered an unexpected error and couldn't complete the
|
2836
3200
|
# request. You might be able to successfully issue the request again in
|
2837
3201
|
# the future.
|
@@ -2896,7 +3260,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2896
3260
|
end
|
2897
3261
|
|
2898
3262
|
# Contains the delivery stream Amazon Resource Name (ARN), and the ARN
|
2899
|
-
# of the Identity and Access Management (IAM) role associated with
|
3263
|
+
# of the Identity and Access Management (IAM) role associated with a
|
2900
3264
|
# Kinesis Data Firehose event destination.
|
2901
3265
|
#
|
2902
3266
|
# Event destinations, such as Kinesis Data Firehose, are associated with
|
@@ -2904,8 +3268,8 @@ module Aws::PinpointSMSVoiceV2
|
|
2904
3268
|
# events.
|
2905
3269
|
#
|
2906
3270
|
# @!attribute [rw] iam_role_arn
|
2907
|
-
# The ARN of an
|
2908
|
-
#
|
3271
|
+
# The ARN of an Identity and Access Management role that is able to
|
3272
|
+
# write event data to an Amazon Kinesis Data Firehose destination.
|
2909
3273
|
# @return [String]
|
2910
3274
|
#
|
2911
3275
|
# @!attribute [rw] delivery_stream_arn
|
@@ -3460,6 +3824,82 @@ module Aws::PinpointSMSVoiceV2
|
|
3460
3824
|
include Aws::Structure
|
3461
3825
|
end
|
3462
3826
|
|
3827
|
+
# The types of statuses that can be used.
|
3828
|
+
#
|
3829
|
+
# @!attribute [rw] protect_status
|
3830
|
+
# The types of protection that can be used.
|
3831
|
+
# @return [String]
|
3832
|
+
#
|
3833
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ProtectConfigurationCountryRuleSetInformation AWS API Documentation
|
3834
|
+
#
|
3835
|
+
class ProtectConfigurationCountryRuleSetInformation < Struct.new(
|
3836
|
+
:protect_status)
|
3837
|
+
SENSITIVE = []
|
3838
|
+
include Aws::Structure
|
3839
|
+
end
|
3840
|
+
|
3841
|
+
# The filter definition for filtering protect configurations that meet a
|
3842
|
+
# specified criteria.
|
3843
|
+
#
|
3844
|
+
# @!attribute [rw] name
|
3845
|
+
# The name of the attribute to filter on.
|
3846
|
+
# @return [String]
|
3847
|
+
#
|
3848
|
+
# @!attribute [rw] values
|
3849
|
+
# An array of values to filter for.
|
3850
|
+
# @return [Array<String>]
|
3851
|
+
#
|
3852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ProtectConfigurationFilter AWS API Documentation
|
3853
|
+
#
|
3854
|
+
class ProtectConfigurationFilter < Struct.new(
|
3855
|
+
:name,
|
3856
|
+
:values)
|
3857
|
+
SENSITIVE = []
|
3858
|
+
include Aws::Structure
|
3859
|
+
end
|
3860
|
+
|
3861
|
+
# Provides information on the specified protect configuration.
|
3862
|
+
#
|
3863
|
+
# @!attribute [rw] protect_configuration_arn
|
3864
|
+
# The Amazon Resource Name (ARN) of the protect configuration.
|
3865
|
+
# @return [String]
|
3866
|
+
#
|
3867
|
+
# @!attribute [rw] protect_configuration_id
|
3868
|
+
# The unique identifier for the protect configuration.
|
3869
|
+
# @return [String]
|
3870
|
+
#
|
3871
|
+
# @!attribute [rw] created_timestamp
|
3872
|
+
# The time when the protect configuration was created, in [UNIX epoch
|
3873
|
+
# time][1] format.
|
3874
|
+
#
|
3875
|
+
#
|
3876
|
+
#
|
3877
|
+
# [1]: https://www.epochconverter.com/
|
3878
|
+
# @return [Time]
|
3879
|
+
#
|
3880
|
+
# @!attribute [rw] account_default
|
3881
|
+
# This is true if the protect configuration is set as your account
|
3882
|
+
# default protect configuration.
|
3883
|
+
# @return [Boolean]
|
3884
|
+
#
|
3885
|
+
# @!attribute [rw] deletion_protection_enabled
|
3886
|
+
# The status of deletion protection for the protect configuration.
|
3887
|
+
# When set to true deletion protection is enabled. By default this is
|
3888
|
+
# set to false.
|
3889
|
+
# @return [Boolean]
|
3890
|
+
#
|
3891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ProtectConfigurationInformation AWS API Documentation
|
3892
|
+
#
|
3893
|
+
class ProtectConfigurationInformation < Struct.new(
|
3894
|
+
:protect_configuration_arn,
|
3895
|
+
:protect_configuration_id,
|
3896
|
+
:created_timestamp,
|
3897
|
+
:account_default,
|
3898
|
+
:deletion_protection_enabled)
|
3899
|
+
SENSITIVE = []
|
3900
|
+
include Aws::Structure
|
3901
|
+
end
|
3902
|
+
|
3463
3903
|
# @!attribute [rw] origination_identity
|
3464
3904
|
# The origination identity to use such as a PhoneNumberId,
|
3465
3905
|
# PhoneNumberArn, SenderId or SenderIdArn. You can use
|
@@ -4954,6 +5394,93 @@ module Aws::PinpointSMSVoiceV2
|
|
4954
5394
|
include Aws::Structure
|
4955
5395
|
end
|
4956
5396
|
|
5397
|
+
# @!attribute [rw] destination_phone_number
|
5398
|
+
# The destination phone number in E.164 format.
|
5399
|
+
# @return [String]
|
5400
|
+
#
|
5401
|
+
# @!attribute [rw] origination_identity
|
5402
|
+
# The origination identity of the message. This can be either the
|
5403
|
+
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
5404
|
+
# PoolId, or PoolArn.
|
5405
|
+
# @return [String]
|
5406
|
+
#
|
5407
|
+
# @!attribute [rw] message_body
|
5408
|
+
# The text body of the message.
|
5409
|
+
# @return [String]
|
5410
|
+
#
|
5411
|
+
# @!attribute [rw] media_urls
|
5412
|
+
# An array of URLs to each media file to send.
|
5413
|
+
#
|
5414
|
+
# The media files have to be stored in a publicly available S3 bucket.
|
5415
|
+
# Supported media file formats are listed in [MMS file types, size and
|
5416
|
+
# character limits][1]. For more information on creating an S3 bucket
|
5417
|
+
# and managing objects, see [Creating a bucket][2] and [Uploading
|
5418
|
+
# objects][3] in the S3 user guide.
|
5419
|
+
#
|
5420
|
+
#
|
5421
|
+
#
|
5422
|
+
# [1]: https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html
|
5423
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html
|
5424
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html
|
5425
|
+
# @return [Array<String>]
|
5426
|
+
#
|
5427
|
+
# @!attribute [rw] configuration_set_name
|
5428
|
+
# The name of the configuration set to use. This can be either the
|
5429
|
+
# ConfigurationSetName or ConfigurationSetArn.
|
5430
|
+
# @return [String]
|
5431
|
+
#
|
5432
|
+
# @!attribute [rw] max_price
|
5433
|
+
# The maximum amount that you want to spend, in US dollars, per each
|
5434
|
+
# MMS message.
|
5435
|
+
# @return [String]
|
5436
|
+
#
|
5437
|
+
# @!attribute [rw] time_to_live
|
5438
|
+
# How long the text message is valid for. By default this is 72 hours.
|
5439
|
+
# @return [Integer]
|
5440
|
+
#
|
5441
|
+
# @!attribute [rw] context
|
5442
|
+
# You can specify custom data in this field. If you do, that data is
|
5443
|
+
# logged to the event destination.
|
5444
|
+
# @return [Hash<String,String>]
|
5445
|
+
#
|
5446
|
+
# @!attribute [rw] dry_run
|
5447
|
+
# When set to true, the message is checked and validated, but isn't
|
5448
|
+
# sent to the end recipient.
|
5449
|
+
# @return [Boolean]
|
5450
|
+
#
|
5451
|
+
# @!attribute [rw] protect_configuration_id
|
5452
|
+
# The unique identifier of the protect configuration to use.
|
5453
|
+
# @return [String]
|
5454
|
+
#
|
5455
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendMediaMessageRequest AWS API Documentation
|
5456
|
+
#
|
5457
|
+
class SendMediaMessageRequest < Struct.new(
|
5458
|
+
:destination_phone_number,
|
5459
|
+
:origination_identity,
|
5460
|
+
:message_body,
|
5461
|
+
:media_urls,
|
5462
|
+
:configuration_set_name,
|
5463
|
+
:max_price,
|
5464
|
+
:time_to_live,
|
5465
|
+
:context,
|
5466
|
+
:dry_run,
|
5467
|
+
:protect_configuration_id)
|
5468
|
+
SENSITIVE = []
|
5469
|
+
include Aws::Structure
|
5470
|
+
end
|
5471
|
+
|
5472
|
+
# @!attribute [rw] message_id
|
5473
|
+
# The unique identifier for the message.
|
5474
|
+
# @return [String]
|
5475
|
+
#
|
5476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendMediaMessageResult AWS API Documentation
|
5477
|
+
#
|
5478
|
+
class SendMediaMessageResult < Struct.new(
|
5479
|
+
:message_id)
|
5480
|
+
SENSITIVE = []
|
5481
|
+
include Aws::Structure
|
5482
|
+
end
|
5483
|
+
|
4957
5484
|
# @!attribute [rw] destination_phone_number
|
4958
5485
|
# The destination phone number in E.164 format.
|
4959
5486
|
# @return [String]
|
@@ -5015,6 +5542,10 @@ module Aws::PinpointSMSVoiceV2
|
|
5015
5542
|
# sent to the end recipient.
|
5016
5543
|
# @return [Boolean]
|
5017
5544
|
#
|
5545
|
+
# @!attribute [rw] protect_configuration_id
|
5546
|
+
# The unique identifier for the protect configuration.
|
5547
|
+
# @return [String]
|
5548
|
+
#
|
5018
5549
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendTextMessageRequest AWS API Documentation
|
5019
5550
|
#
|
5020
5551
|
class SendTextMessageRequest < Struct.new(
|
@@ -5028,7 +5559,8 @@ module Aws::PinpointSMSVoiceV2
|
|
5028
5559
|
:time_to_live,
|
5029
5560
|
:context,
|
5030
5561
|
:destination_country_parameters,
|
5031
|
-
:dry_run
|
5562
|
+
:dry_run,
|
5563
|
+
:protect_configuration_id)
|
5032
5564
|
SENSITIVE = []
|
5033
5565
|
include Aws::Structure
|
5034
5566
|
end
|
@@ -5106,6 +5638,10 @@ module Aws::PinpointSMSVoiceV2
|
|
5106
5638
|
# sent to the end recipient.
|
5107
5639
|
# @return [Boolean]
|
5108
5640
|
#
|
5641
|
+
# @!attribute [rw] protect_configuration_id
|
5642
|
+
# The unique identifier for the protect configuration.
|
5643
|
+
# @return [String]
|
5644
|
+
#
|
5109
5645
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendVoiceMessageRequest AWS API Documentation
|
5110
5646
|
#
|
5111
5647
|
class SendVoiceMessageRequest < Struct.new(
|
@@ -5118,7 +5654,8 @@ module Aws::PinpointSMSVoiceV2
|
|
5118
5654
|
:max_price_per_minute,
|
5119
5655
|
:time_to_live,
|
5120
5656
|
:context,
|
5121
|
-
:dry_run
|
5657
|
+
:dry_run,
|
5658
|
+
:protect_configuration_id)
|
5122
5659
|
SENSITIVE = []
|
5123
5660
|
include Aws::Structure
|
5124
5661
|
end
|
@@ -5253,6 +5790,36 @@ module Aws::PinpointSMSVoiceV2
|
|
5253
5790
|
include Aws::Structure
|
5254
5791
|
end
|
5255
5792
|
|
5793
|
+
# @!attribute [rw] protect_configuration_id
|
5794
|
+
# The unique identifier for the protect configuration.
|
5795
|
+
# @return [String]
|
5796
|
+
#
|
5797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetAccountDefaultProtectConfigurationRequest AWS API Documentation
|
5798
|
+
#
|
5799
|
+
class SetAccountDefaultProtectConfigurationRequest < Struct.new(
|
5800
|
+
:protect_configuration_id)
|
5801
|
+
SENSITIVE = []
|
5802
|
+
include Aws::Structure
|
5803
|
+
end
|
5804
|
+
|
5805
|
+
# @!attribute [rw] default_protect_configuration_arn
|
5806
|
+
# The Amazon Resource Name (ARN) of the account default protect
|
5807
|
+
# configuration.
|
5808
|
+
# @return [String]
|
5809
|
+
#
|
5810
|
+
# @!attribute [rw] default_protect_configuration_id
|
5811
|
+
# The unique identifier of the account default protect configuration.
|
5812
|
+
# @return [String]
|
5813
|
+
#
|
5814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetAccountDefaultProtectConfigurationResult AWS API Documentation
|
5815
|
+
#
|
5816
|
+
class SetAccountDefaultProtectConfigurationResult < Struct.new(
|
5817
|
+
:default_protect_configuration_arn,
|
5818
|
+
:default_protect_configuration_id)
|
5819
|
+
SENSITIVE = []
|
5820
|
+
include Aws::Structure
|
5821
|
+
end
|
5822
|
+
|
5256
5823
|
# @!attribute [rw] configuration_set_name
|
5257
5824
|
# The configuration set to update with a new default message type.
|
5258
5825
|
# This field can be the ConsigurationSetName or ConfigurationSetArn.
|
@@ -5340,6 +5907,30 @@ module Aws::PinpointSMSVoiceV2
|
|
5340
5907
|
include Aws::Structure
|
5341
5908
|
end
|
5342
5909
|
|
5910
|
+
# @!attribute [rw] monthly_limit
|
5911
|
+
# The new monthly limit to enforce on text messages.
|
5912
|
+
# @return [Integer]
|
5913
|
+
#
|
5914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetMediaMessageSpendLimitOverrideRequest AWS API Documentation
|
5915
|
+
#
|
5916
|
+
class SetMediaMessageSpendLimitOverrideRequest < Struct.new(
|
5917
|
+
:monthly_limit)
|
5918
|
+
SENSITIVE = []
|
5919
|
+
include Aws::Structure
|
5920
|
+
end
|
5921
|
+
|
5922
|
+
# @!attribute [rw] monthly_limit
|
5923
|
+
# The current monthly limit to enforce on sending text messages.
|
5924
|
+
# @return [Integer]
|
5925
|
+
#
|
5926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetMediaMessageSpendLimitOverrideResult AWS API Documentation
|
5927
|
+
#
|
5928
|
+
class SetMediaMessageSpendLimitOverrideResult < Struct.new(
|
5929
|
+
:monthly_limit)
|
5930
|
+
SENSITIVE = []
|
5931
|
+
include Aws::Structure
|
5932
|
+
end
|
5933
|
+
|
5343
5934
|
# @!attribute [rw] monthly_limit
|
5344
5935
|
# The new monthly limit to enforce on text messages.
|
5345
5936
|
# @return [Integer]
|
@@ -6033,6 +6624,122 @@ module Aws::PinpointSMSVoiceV2
|
|
6033
6624
|
include Aws::Structure
|
6034
6625
|
end
|
6035
6626
|
|
6627
|
+
# @!attribute [rw] protect_configuration_id
|
6628
|
+
# The unique identifier for the protect configuration.
|
6629
|
+
# @return [String]
|
6630
|
+
#
|
6631
|
+
# @!attribute [rw] number_capability
|
6632
|
+
# The number capability to apply the CountryRuleSetUpdates updates to.
|
6633
|
+
# @return [String]
|
6634
|
+
#
|
6635
|
+
# @!attribute [rw] country_rule_set_updates
|
6636
|
+
# A map of ProtectConfigurationCountryRuleSetInformation objects that
|
6637
|
+
# contain the details for the requested NumberCapability. The Key is
|
6638
|
+
# the two-letter ISO country code. For a list of supported ISO country
|
6639
|
+
# codes, see [Supported countries and regions (SMS channel)][1] in the
|
6640
|
+
# Amazon Pinpoint SMS user guide.
|
6641
|
+
#
|
6642
|
+
#
|
6643
|
+
#
|
6644
|
+
# [1]: https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html
|
6645
|
+
# @return [Hash<String,Types::ProtectConfigurationCountryRuleSetInformation>]
|
6646
|
+
#
|
6647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateProtectConfigurationCountryRuleSetRequest AWS API Documentation
|
6648
|
+
#
|
6649
|
+
class UpdateProtectConfigurationCountryRuleSetRequest < Struct.new(
|
6650
|
+
:protect_configuration_id,
|
6651
|
+
:number_capability,
|
6652
|
+
:country_rule_set_updates)
|
6653
|
+
SENSITIVE = []
|
6654
|
+
include Aws::Structure
|
6655
|
+
end
|
6656
|
+
|
6657
|
+
# @!attribute [rw] protect_configuration_arn
|
6658
|
+
# The Amazon Resource Name (ARN) of the protect configuration.
|
6659
|
+
# @return [String]
|
6660
|
+
#
|
6661
|
+
# @!attribute [rw] protect_configuration_id
|
6662
|
+
# The unique identifier for the protect configuration.
|
6663
|
+
# @return [String]
|
6664
|
+
#
|
6665
|
+
# @!attribute [rw] number_capability
|
6666
|
+
# The number capability that was updated
|
6667
|
+
# @return [String]
|
6668
|
+
#
|
6669
|
+
# @!attribute [rw] country_rule_set
|
6670
|
+
# An array of ProtectConfigurationCountryRuleSetInformation containing
|
6671
|
+
# the rules for the NumberCapability.
|
6672
|
+
# @return [Hash<String,Types::ProtectConfigurationCountryRuleSetInformation>]
|
6673
|
+
#
|
6674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateProtectConfigurationCountryRuleSetResult AWS API Documentation
|
6675
|
+
#
|
6676
|
+
class UpdateProtectConfigurationCountryRuleSetResult < Struct.new(
|
6677
|
+
:protect_configuration_arn,
|
6678
|
+
:protect_configuration_id,
|
6679
|
+
:number_capability,
|
6680
|
+
:country_rule_set)
|
6681
|
+
SENSITIVE = []
|
6682
|
+
include Aws::Structure
|
6683
|
+
end
|
6684
|
+
|
6685
|
+
# @!attribute [rw] protect_configuration_id
|
6686
|
+
# The unique identifier for the protect configuration.
|
6687
|
+
# @return [String]
|
6688
|
+
#
|
6689
|
+
# @!attribute [rw] deletion_protection_enabled
|
6690
|
+
# When set to true deletion protection is enabled. By default this is
|
6691
|
+
# set to false.
|
6692
|
+
# @return [Boolean]
|
6693
|
+
#
|
6694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateProtectConfigurationRequest AWS API Documentation
|
6695
|
+
#
|
6696
|
+
class UpdateProtectConfigurationRequest < Struct.new(
|
6697
|
+
:protect_configuration_id,
|
6698
|
+
:deletion_protection_enabled)
|
6699
|
+
SENSITIVE = []
|
6700
|
+
include Aws::Structure
|
6701
|
+
end
|
6702
|
+
|
6703
|
+
# @!attribute [rw] protect_configuration_arn
|
6704
|
+
# The Amazon Resource Name (ARN) of the protect configuration.
|
6705
|
+
# @return [String]
|
6706
|
+
#
|
6707
|
+
# @!attribute [rw] protect_configuration_id
|
6708
|
+
# The unique identifier for the protect configuration.
|
6709
|
+
# @return [String]
|
6710
|
+
#
|
6711
|
+
# @!attribute [rw] created_timestamp
|
6712
|
+
# The time when the protect configuration was created, in [UNIX epoch
|
6713
|
+
# time][1] format.
|
6714
|
+
#
|
6715
|
+
#
|
6716
|
+
#
|
6717
|
+
# [1]: https://www.epochconverter.com/
|
6718
|
+
# @return [Time]
|
6719
|
+
#
|
6720
|
+
# @!attribute [rw] account_default
|
6721
|
+
# This is true if the protect configuration is set as your account
|
6722
|
+
# default protect configuration.
|
6723
|
+
# @return [Boolean]
|
6724
|
+
#
|
6725
|
+
# @!attribute [rw] deletion_protection_enabled
|
6726
|
+
# The status of deletion protection for the protect configuration.
|
6727
|
+
# When set to true deletion protection is enabled. By default this is
|
6728
|
+
# set to false.
|
6729
|
+
# @return [Boolean]
|
6730
|
+
#
|
6731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateProtectConfigurationResult AWS API Documentation
|
6732
|
+
#
|
6733
|
+
class UpdateProtectConfigurationResult < Struct.new(
|
6734
|
+
:protect_configuration_arn,
|
6735
|
+
:protect_configuration_id,
|
6736
|
+
:created_timestamp,
|
6737
|
+
:account_default,
|
6738
|
+
:deletion_protection_enabled)
|
6739
|
+
SENSITIVE = []
|
6740
|
+
include Aws::Structure
|
6741
|
+
end
|
6742
|
+
|
6036
6743
|
# @!attribute [rw] sender_id
|
6037
6744
|
# The sender ID to update.
|
6038
6745
|
# @return [String]
|