aws-sdk-pinpointemail 1.5.0 → 1.6.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/lib/aws-sdk-pinpointemail.rb +1 -1
- data/lib/aws-sdk-pinpointemail/client.rb +199 -1
- data/lib/aws-sdk-pinpointemail/client_api.rb +84 -0
- data/lib/aws-sdk-pinpointemail/types.rb +225 -7
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dfad6c32c927188fc83a4daf37373f9f60f71bdc
|
4
|
+
data.tar.gz: ee8a44222141cd3cb34142d51c1123523929b634
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3fc2996a82b03e384a26e14bf5e195393032532646d5fa6c5e83aae73e66031ea9859bfe5b26637b71047de8f5e39696da186b0364dd3ee464e03dc45011a4c4
|
7
|
+
data.tar.gz: 6079d09778e122e2f2435926805476fdb6d90976a570a7ddaffff9458707a94e305534d1e4c9ce00f30640ef9e959dbfadda14af0964122c14b5c040a10071bc
|
@@ -199,6 +199,49 @@ module Aws::PinpointEmail
|
|
199
199
|
# When `true`, request parameters are validated before
|
200
200
|
# sending the request.
|
201
201
|
#
|
202
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
203
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
204
|
+
#
|
205
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
206
|
+
# seconds to wait when opening a HTTP session before rasing a
|
207
|
+
# `Timeout::Error`.
|
208
|
+
#
|
209
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
210
|
+
# number of seconds to wait for response data. This value can
|
211
|
+
# safely be set
|
212
|
+
# per-request on the session yeidled by {#session_for}.
|
213
|
+
#
|
214
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
215
|
+
# seconds a connection is allowed to sit idble before it is
|
216
|
+
# considered stale. Stale connections are closed and removed
|
217
|
+
# from the pool before making a request.
|
218
|
+
#
|
219
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
220
|
+
# seconds to wait for a 100-continue response before sending the
|
221
|
+
# request body. This option has no effect unless the request has
|
222
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
223
|
+
# disables this behaviour. This value can safely be set per
|
224
|
+
# request on the session yeidled by {#session_for}.
|
225
|
+
#
|
226
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
227
|
+
# HTTP debug output will be sent to the `:logger`.
|
228
|
+
#
|
229
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
230
|
+
# SSL peer certificates are verified when establishing a
|
231
|
+
# connection.
|
232
|
+
#
|
233
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
234
|
+
# certificate authority bundle file that should be used when
|
235
|
+
# verifying peer certificates. If you do not pass
|
236
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
237
|
+
# will be used if available.
|
238
|
+
#
|
239
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
240
|
+
# directory that contains the unbundled SSL certificate
|
241
|
+
# authority files for verifying peer certificates. If you do
|
242
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
243
|
+
# system default will be used if available.
|
244
|
+
#
|
202
245
|
def initialize(*args)
|
203
246
|
super
|
204
247
|
end
|
@@ -232,6 +275,10 @@ module Aws::PinpointEmail
|
|
232
275
|
# An object that defines whether or not Amazon Pinpoint can send email
|
233
276
|
# that you send using the configuration set.
|
234
277
|
#
|
278
|
+
# @option params [Array<Types::Tag>] :tags
|
279
|
+
# An object that defines the tags (keys and values) that you want to
|
280
|
+
# associate with the configuration set.
|
281
|
+
#
|
235
282
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
236
283
|
#
|
237
284
|
# @example Request syntax with placeholder values
|
@@ -251,6 +298,12 @@ module Aws::PinpointEmail
|
|
251
298
|
# sending_options: {
|
252
299
|
# sending_enabled: false,
|
253
300
|
# },
|
301
|
+
# tags: [
|
302
|
+
# {
|
303
|
+
# key: "TagKey", # required
|
304
|
+
# value: "TagValue", # required
|
305
|
+
# },
|
306
|
+
# ],
|
254
307
|
# })
|
255
308
|
#
|
256
309
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateConfigurationSet AWS API Documentation
|
@@ -334,12 +387,22 @@ module Aws::PinpointEmail
|
|
334
387
|
# @option params [required, String] :pool_name
|
335
388
|
# The name of the dedicated IP pool.
|
336
389
|
#
|
390
|
+
# @option params [Array<Types::Tag>] :tags
|
391
|
+
# An object that defines the tags (keys and values) that you want to
|
392
|
+
# associate with the pool.
|
393
|
+
#
|
337
394
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
338
395
|
#
|
339
396
|
# @example Request syntax with placeholder values
|
340
397
|
#
|
341
398
|
# resp = client.create_dedicated_ip_pool({
|
342
399
|
# pool_name: "PoolName", # required
|
400
|
+
# tags: [
|
401
|
+
# {
|
402
|
+
# key: "TagKey", # required
|
403
|
+
# value: "TagValue", # required
|
404
|
+
# },
|
405
|
+
# ],
|
343
406
|
# })
|
344
407
|
#
|
345
408
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateDedicatedIpPool AWS API Documentation
|
@@ -373,6 +436,10 @@ module Aws::PinpointEmail
|
|
373
436
|
# The HTML body of the message that you sent when you performed the
|
374
437
|
# predictive inbox placement test.
|
375
438
|
#
|
439
|
+
# @option params [Array<Types::Tag>] :tags
|
440
|
+
# An object that defines the tags (keys and values) that you want to
|
441
|
+
# associate with the predictive inbox placement test.
|
442
|
+
#
|
376
443
|
# @return [Types::CreateDeliverabilityTestReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
377
444
|
#
|
378
445
|
# * {Types::CreateDeliverabilityTestReportResponse#report_id #report_id} => String
|
@@ -404,6 +471,12 @@ module Aws::PinpointEmail
|
|
404
471
|
# data: "data", # required
|
405
472
|
# },
|
406
473
|
# },
|
474
|
+
# tags: [
|
475
|
+
# {
|
476
|
+
# key: "TagKey", # required
|
477
|
+
# value: "TagValue", # required
|
478
|
+
# },
|
479
|
+
# ],
|
407
480
|
# })
|
408
481
|
#
|
409
482
|
# @example Response structure
|
@@ -442,6 +515,10 @@ module Aws::PinpointEmail
|
|
442
515
|
# @option params [required, String] :email_identity
|
443
516
|
# The email address or domain that you want to verify.
|
444
517
|
#
|
518
|
+
# @option params [Array<Types::Tag>] :tags
|
519
|
+
# An object that defines the tags (keys and values) that you want to
|
520
|
+
# associate with the email identity.
|
521
|
+
#
|
445
522
|
# @return [Types::CreateEmailIdentityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
446
523
|
#
|
447
524
|
# * {Types::CreateEmailIdentityResponse#identity_type #identity_type} => String
|
@@ -452,6 +529,12 @@ module Aws::PinpointEmail
|
|
452
529
|
#
|
453
530
|
# resp = client.create_email_identity({
|
454
531
|
# email_identity: "Identity", # required
|
532
|
+
# tags: [
|
533
|
+
# {
|
534
|
+
# key: "TagKey", # required
|
535
|
+
# value: "TagValue", # required
|
536
|
+
# },
|
537
|
+
# ],
|
455
538
|
# })
|
456
539
|
#
|
457
540
|
# @example Response structure
|
@@ -1193,6 +1276,42 @@ module Aws::PinpointEmail
|
|
1193
1276
|
req.send_request(options)
|
1194
1277
|
end
|
1195
1278
|
|
1279
|
+
# Retrieve a list of the tags (keys and values) that are associated with
|
1280
|
+
# a specific resource. A *tag* is a label that you optionally define and
|
1281
|
+
# associate with a resource in Amazon Pinpoint. Each tag consists of a
|
1282
|
+
# required *tag key* and an optional associated *tag value*. A tag key
|
1283
|
+
# is a general label that acts as a category for more specific tag
|
1284
|
+
# values. A tag value acts as a descriptor within a tag key.
|
1285
|
+
#
|
1286
|
+
# @option params [required, String] :resource_arn
|
1287
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
1288
|
+
# retrieve tag information for.
|
1289
|
+
#
|
1290
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1291
|
+
#
|
1292
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
1293
|
+
#
|
1294
|
+
# @example Request syntax with placeholder values
|
1295
|
+
#
|
1296
|
+
# resp = client.list_tags_for_resource({
|
1297
|
+
# resource_arn: "AmazonResourceName", # required
|
1298
|
+
# })
|
1299
|
+
#
|
1300
|
+
# @example Response structure
|
1301
|
+
#
|
1302
|
+
# resp.tags #=> Array
|
1303
|
+
# resp.tags[0].key #=> String
|
1304
|
+
# resp.tags[0].value #=> String
|
1305
|
+
#
|
1306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListTagsForResource AWS API Documentation
|
1307
|
+
#
|
1308
|
+
# @overload list_tags_for_resource(params = {})
|
1309
|
+
# @param [Hash] params ({})
|
1310
|
+
def list_tags_for_resource(params = {}, options = {})
|
1311
|
+
req = build_request(:list_tags_for_resource, params)
|
1312
|
+
req.send_request(options)
|
1313
|
+
end
|
1314
|
+
|
1196
1315
|
# Enable or disable the automatic warm-up feature for dedicated IP
|
1197
1316
|
# addresses.
|
1198
1317
|
#
|
@@ -1695,6 +1814,85 @@ module Aws::PinpointEmail
|
|
1695
1814
|
req.send_request(options)
|
1696
1815
|
end
|
1697
1816
|
|
1817
|
+
# Add one or more tags (keys and values) to one or more specified
|
1818
|
+
# resources. A *tag* is a label that you optionally define and associate
|
1819
|
+
# with a resource in Amazon Pinpoint. Tags can help you categorize and
|
1820
|
+
# manage resources in different ways, such as by purpose, owner,
|
1821
|
+
# environment, or other criteria. A resource can have as many as 50
|
1822
|
+
# tags.
|
1823
|
+
#
|
1824
|
+
# Each tag consists of a required *tag key* and an associated *tag
|
1825
|
+
# value*, both of which you define. A tag key is a general label that
|
1826
|
+
# acts as a category for more specific tag values. A tag value acts as a
|
1827
|
+
# descriptor within a tag key.
|
1828
|
+
#
|
1829
|
+
# @option params [required, String] :resource_arn
|
1830
|
+
# The Amazon Resource Name (ARN) of the resource that you want to add
|
1831
|
+
# one or more tags to.
|
1832
|
+
#
|
1833
|
+
# @option params [required, Array<Types::Tag>] :tags
|
1834
|
+
# A list of the tags that you want to add to the resource. A tag
|
1835
|
+
# consists of a required tag key (`Key`) and an associated tag value
|
1836
|
+
# (`Value`). The maximum length of a tag key is 128 characters. The
|
1837
|
+
# maximum length of a tag value is 256 characters.
|
1838
|
+
#
|
1839
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1840
|
+
#
|
1841
|
+
# @example Request syntax with placeholder values
|
1842
|
+
#
|
1843
|
+
# resp = client.tag_resource({
|
1844
|
+
# resource_arn: "AmazonResourceName", # required
|
1845
|
+
# tags: [ # required
|
1846
|
+
# {
|
1847
|
+
# key: "TagKey", # required
|
1848
|
+
# value: "TagValue", # required
|
1849
|
+
# },
|
1850
|
+
# ],
|
1851
|
+
# })
|
1852
|
+
#
|
1853
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/TagResource AWS API Documentation
|
1854
|
+
#
|
1855
|
+
# @overload tag_resource(params = {})
|
1856
|
+
# @param [Hash] params ({})
|
1857
|
+
def tag_resource(params = {}, options = {})
|
1858
|
+
req = build_request(:tag_resource, params)
|
1859
|
+
req.send_request(options)
|
1860
|
+
end
|
1861
|
+
|
1862
|
+
# Remove one or more tags (keys and values) from a specified resource.
|
1863
|
+
#
|
1864
|
+
# @option params [required, String] :resource_arn
|
1865
|
+
# The Amazon Resource Name (ARN) of the resource that you want to remove
|
1866
|
+
# one or more tags from.
|
1867
|
+
#
|
1868
|
+
# @option params [required, Array<String>] :tag_keys
|
1869
|
+
# The tags (tag keys) that you want to remove from the resource. When
|
1870
|
+
# you specify a tag key, the action removes both that key and its
|
1871
|
+
# associated tag value.
|
1872
|
+
#
|
1873
|
+
# To remove more than one tag from the resource, append the `TagKeys`
|
1874
|
+
# parameter and argument for each additional tag to remove, separated by
|
1875
|
+
# an ampersand. For example:
|
1876
|
+
# `/v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2`
|
1877
|
+
#
|
1878
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1879
|
+
#
|
1880
|
+
# @example Request syntax with placeholder values
|
1881
|
+
#
|
1882
|
+
# resp = client.untag_resource({
|
1883
|
+
# resource_arn: "AmazonResourceName", # required
|
1884
|
+
# tag_keys: ["TagKey"], # required
|
1885
|
+
# })
|
1886
|
+
#
|
1887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/UntagResource AWS API Documentation
|
1888
|
+
#
|
1889
|
+
# @overload untag_resource(params = {})
|
1890
|
+
# @param [Hash] params ({})
|
1891
|
+
def untag_resource(params = {}, options = {})
|
1892
|
+
req = build_request(:untag_resource, params)
|
1893
|
+
req.send_request(options)
|
1894
|
+
end
|
1895
|
+
|
1698
1896
|
# Update the configuration of an event destination for a configuration
|
1699
1897
|
# set.
|
1700
1898
|
#
|
@@ -1769,7 +1967,7 @@ module Aws::PinpointEmail
|
|
1769
1967
|
params: params,
|
1770
1968
|
config: config)
|
1771
1969
|
context[:gem_name] = 'aws-sdk-pinpointemail'
|
1772
|
-
context[:gem_version] = '1.
|
1970
|
+
context[:gem_version] = '1.6.0'
|
1773
1971
|
Seahorse::Client::Request.new(handlers, context)
|
1774
1972
|
end
|
1775
1973
|
|
@@ -27,6 +27,7 @@ module Aws::PinpointEmail
|
|
27
27
|
CloudWatchDestination = Shapes::StructureShape.new(name: 'CloudWatchDestination')
|
28
28
|
CloudWatchDimensionConfiguration = Shapes::StructureShape.new(name: 'CloudWatchDimensionConfiguration')
|
29
29
|
CloudWatchDimensionConfigurations = Shapes::ListShape.new(name: 'CloudWatchDimensionConfigurations')
|
30
|
+
ConcurrentModificationException = Shapes::StructureShape.new(name: 'ConcurrentModificationException')
|
30
31
|
ConfigurationSetName = Shapes::StringShape.new(name: 'ConfigurationSetName')
|
31
32
|
ConfigurationSetNameList = Shapes::ListShape.new(name: 'ConfigurationSetNameList')
|
32
33
|
Content = Shapes::StructureShape.new(name: 'Content')
|
@@ -119,6 +120,8 @@ module Aws::PinpointEmail
|
|
119
120
|
ListEmailIdentitiesRequest = Shapes::StructureShape.new(name: 'ListEmailIdentitiesRequest')
|
120
121
|
ListEmailIdentitiesResponse = Shapes::StructureShape.new(name: 'ListEmailIdentitiesResponse')
|
121
122
|
ListOfDedicatedIpPools = Shapes::ListShape.new(name: 'ListOfDedicatedIpPools')
|
123
|
+
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
124
|
+
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
122
125
|
MailFromAttributes = Shapes::StructureShape.new(name: 'MailFromAttributes')
|
123
126
|
MailFromDomainName = Shapes::StringShape.new(name: 'MailFromDomainName')
|
124
127
|
MailFromDomainNotVerifiedException = Shapes::StructureShape.new(name: 'MailFromDomainNotVerifiedException')
|
@@ -181,9 +184,18 @@ module Aws::PinpointEmail
|
|
181
184
|
SendingPoolName = Shapes::StringShape.new(name: 'SendingPoolName')
|
182
185
|
SentLast24Hours = Shapes::FloatShape.new(name: 'SentLast24Hours')
|
183
186
|
SnsDestination = Shapes::StructureShape.new(name: 'SnsDestination')
|
187
|
+
Tag = Shapes::StructureShape.new(name: 'Tag')
|
188
|
+
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
189
|
+
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
190
|
+
TagList = Shapes::ListShape.new(name: 'TagList')
|
191
|
+
TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
|
192
|
+
TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
|
193
|
+
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
184
194
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
185
195
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
186
196
|
TrackingOptions = Shapes::StructureShape.new(name: 'TrackingOptions')
|
197
|
+
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
198
|
+
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
187
199
|
UpdateConfigurationSetEventDestinationRequest = Shapes::StructureShape.new(name: 'UpdateConfigurationSetEventDestinationRequest')
|
188
200
|
UpdateConfigurationSetEventDestinationResponse = Shapes::StructureShape.new(name: 'UpdateConfigurationSetEventDestinationResponse')
|
189
201
|
Volume = Shapes::IntegerShape.new(name: 'Volume')
|
@@ -234,11 +246,13 @@ module Aws::PinpointEmail
|
|
234
246
|
CreateConfigurationSetRequest.add_member(:delivery_options, Shapes::ShapeRef.new(shape: DeliveryOptions, location_name: "DeliveryOptions"))
|
235
247
|
CreateConfigurationSetRequest.add_member(:reputation_options, Shapes::ShapeRef.new(shape: ReputationOptions, location_name: "ReputationOptions"))
|
236
248
|
CreateConfigurationSetRequest.add_member(:sending_options, Shapes::ShapeRef.new(shape: SendingOptions, location_name: "SendingOptions"))
|
249
|
+
CreateConfigurationSetRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
237
250
|
CreateConfigurationSetRequest.struct_class = Types::CreateConfigurationSetRequest
|
238
251
|
|
239
252
|
CreateConfigurationSetResponse.struct_class = Types::CreateConfigurationSetResponse
|
240
253
|
|
241
254
|
CreateDedicatedIpPoolRequest.add_member(:pool_name, Shapes::ShapeRef.new(shape: PoolName, required: true, location_name: "PoolName"))
|
255
|
+
CreateDedicatedIpPoolRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
242
256
|
CreateDedicatedIpPoolRequest.struct_class = Types::CreateDedicatedIpPoolRequest
|
243
257
|
|
244
258
|
CreateDedicatedIpPoolResponse.struct_class = Types::CreateDedicatedIpPoolResponse
|
@@ -246,6 +260,7 @@ module Aws::PinpointEmail
|
|
246
260
|
CreateDeliverabilityTestReportRequest.add_member(:report_name, Shapes::ShapeRef.new(shape: ReportName, location_name: "ReportName"))
|
247
261
|
CreateDeliverabilityTestReportRequest.add_member(:from_email_address, Shapes::ShapeRef.new(shape: EmailAddress, required: true, location_name: "FromEmailAddress"))
|
248
262
|
CreateDeliverabilityTestReportRequest.add_member(:content, Shapes::ShapeRef.new(shape: EmailContent, required: true, location_name: "Content"))
|
263
|
+
CreateDeliverabilityTestReportRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
249
264
|
CreateDeliverabilityTestReportRequest.struct_class = Types::CreateDeliverabilityTestReportRequest
|
250
265
|
|
251
266
|
CreateDeliverabilityTestReportResponse.add_member(:report_id, Shapes::ShapeRef.new(shape: ReportId, required: true, location_name: "ReportId"))
|
@@ -253,6 +268,7 @@ module Aws::PinpointEmail
|
|
253
268
|
CreateDeliverabilityTestReportResponse.struct_class = Types::CreateDeliverabilityTestReportResponse
|
254
269
|
|
255
270
|
CreateEmailIdentityRequest.add_member(:email_identity, Shapes::ShapeRef.new(shape: Identity, required: true, location_name: "EmailIdentity"))
|
271
|
+
CreateEmailIdentityRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
256
272
|
CreateEmailIdentityRequest.struct_class = Types::CreateEmailIdentityRequest
|
257
273
|
|
258
274
|
CreateEmailIdentityResponse.add_member(:identity_type, Shapes::ShapeRef.new(shape: IdentityType, location_name: "IdentityType"))
|
@@ -487,6 +503,12 @@ module Aws::PinpointEmail
|
|
487
503
|
|
488
504
|
ListOfDedicatedIpPools.member = Shapes::ShapeRef.new(shape: PoolName)
|
489
505
|
|
506
|
+
ListTagsForResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "ResourceArn"))
|
507
|
+
ListTagsForResourceRequest.struct_class = Types::ListTagsForResourceRequest
|
508
|
+
|
509
|
+
ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, required: true, location_name: "Tags"))
|
510
|
+
ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
|
511
|
+
|
490
512
|
MailFromAttributes.add_member(:mail_from_domain, Shapes::ShapeRef.new(shape: MailFromDomainName, required: true, location_name: "MailFromDomain"))
|
491
513
|
MailFromAttributes.add_member(:mail_from_domain_status, Shapes::ShapeRef.new(shape: MailFromDomainStatus, required: true, location_name: "MailFromDomainStatus"))
|
492
514
|
MailFromAttributes.add_member(:behavior_on_mx_failure, Shapes::ShapeRef.new(shape: BehaviorOnMxFailure, required: true, location_name: "BehaviorOnMxFailure"))
|
@@ -617,9 +639,29 @@ module Aws::PinpointEmail
|
|
617
639
|
SnsDestination.add_member(:topic_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "TopicArn"))
|
618
640
|
SnsDestination.struct_class = Types::SnsDestination
|
619
641
|
|
642
|
+
Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "Key"))
|
643
|
+
Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValue, required: true, location_name: "Value"))
|
644
|
+
Tag.struct_class = Types::Tag
|
645
|
+
|
646
|
+
TagKeyList.member = Shapes::ShapeRef.new(shape: TagKey)
|
647
|
+
|
648
|
+
TagList.member = Shapes::ShapeRef.new(shape: Tag)
|
649
|
+
|
650
|
+
TagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "ResourceArn"))
|
651
|
+
TagResourceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, required: true, location_name: "Tags"))
|
652
|
+
TagResourceRequest.struct_class = Types::TagResourceRequest
|
653
|
+
|
654
|
+
TagResourceResponse.struct_class = Types::TagResourceResponse
|
655
|
+
|
620
656
|
TrackingOptions.add_member(:custom_redirect_domain, Shapes::ShapeRef.new(shape: CustomRedirectDomain, required: true, location_name: "CustomRedirectDomain"))
|
621
657
|
TrackingOptions.struct_class = Types::TrackingOptions
|
622
658
|
|
659
|
+
UntagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location: "querystring", location_name: "ResourceArn"))
|
660
|
+
UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location: "querystring", location_name: "TagKeys"))
|
661
|
+
UntagResourceRequest.struct_class = Types::UntagResourceRequest
|
662
|
+
|
663
|
+
UntagResourceResponse.struct_class = Types::UntagResourceResponse
|
664
|
+
|
623
665
|
UpdateConfigurationSetEventDestinationRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: ConfigurationSetName, required: true, location: "uri", location_name: "ConfigurationSetName"))
|
624
666
|
UpdateConfigurationSetEventDestinationRequest.add_member(:event_destination_name, Shapes::ShapeRef.new(shape: EventDestinationName, required: true, location: "uri", location_name: "EventDestinationName"))
|
625
667
|
UpdateConfigurationSetEventDestinationRequest.add_member(:event_destination, Shapes::ShapeRef.new(shape: EventDestinationDefinition, required: true, location_name: "EventDestination"))
|
@@ -664,6 +706,7 @@ module Aws::PinpointEmail
|
|
664
706
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
665
707
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
666
708
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
709
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
667
710
|
end)
|
668
711
|
|
669
712
|
api.add_operation(:create_configuration_set_event_destination, Seahorse::Model::Operation.new.tap do |o|
|
@@ -689,6 +732,7 @@ module Aws::PinpointEmail
|
|
689
732
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
690
733
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
691
734
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
735
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
692
736
|
end)
|
693
737
|
|
694
738
|
api.add_operation(:create_deliverability_test_report, Seahorse::Model::Operation.new.tap do |o|
|
@@ -705,6 +749,7 @@ module Aws::PinpointEmail
|
|
705
749
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
706
750
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
707
751
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
752
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
708
753
|
end)
|
709
754
|
|
710
755
|
api.add_operation(:create_email_identity, Seahorse::Model::Operation.new.tap do |o|
|
@@ -716,6 +761,7 @@ module Aws::PinpointEmail
|
|
716
761
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
717
762
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
718
763
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
764
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
719
765
|
end)
|
720
766
|
|
721
767
|
api.add_operation(:delete_configuration_set, Seahorse::Model::Operation.new.tap do |o|
|
@@ -727,6 +773,7 @@ module Aws::PinpointEmail
|
|
727
773
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
728
774
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
729
775
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
776
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
730
777
|
end)
|
731
778
|
|
732
779
|
api.add_operation(:delete_configuration_set_event_destination, Seahorse::Model::Operation.new.tap do |o|
|
@@ -749,6 +796,7 @@ module Aws::PinpointEmail
|
|
749
796
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
750
797
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
751
798
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
799
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
752
800
|
end)
|
753
801
|
|
754
802
|
api.add_operation(:delete_email_identity, Seahorse::Model::Operation.new.tap do |o|
|
@@ -760,6 +808,7 @@ module Aws::PinpointEmail
|
|
760
808
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
761
809
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
762
810
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
811
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
763
812
|
end)
|
764
813
|
|
765
814
|
api.add_operation(:get_account, Seahorse::Model::Operation.new.tap do |o|
|
@@ -942,6 +991,17 @@ module Aws::PinpointEmail
|
|
942
991
|
)
|
943
992
|
end)
|
944
993
|
|
994
|
+
api.add_operation(:list_tags_for_resource, Seahorse::Model::Operation.new.tap do |o|
|
995
|
+
o.name = "ListTagsForResource"
|
996
|
+
o.http_method = "GET"
|
997
|
+
o.http_request_uri = "/v1/email/tags"
|
998
|
+
o.input = Shapes::ShapeRef.new(shape: ListTagsForResourceRequest)
|
999
|
+
o.output = Shapes::ShapeRef.new(shape: ListTagsForResourceResponse)
|
1000
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1001
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1002
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1003
|
+
end)
|
1004
|
+
|
945
1005
|
api.add_operation(:put_account_dedicated_ip_warmup_attributes, Seahorse::Model::Operation.new.tap do |o|
|
946
1006
|
o.name = "PutAccountDedicatedIpWarmupAttributes"
|
947
1007
|
o.http_method = "PUT"
|
@@ -1090,6 +1150,30 @@ module Aws::PinpointEmail
|
|
1090
1150
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1091
1151
|
end)
|
1092
1152
|
|
1153
|
+
api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
|
1154
|
+
o.name = "TagResource"
|
1155
|
+
o.http_method = "POST"
|
1156
|
+
o.http_request_uri = "/v1/email/tags"
|
1157
|
+
o.input = Shapes::ShapeRef.new(shape: TagResourceRequest)
|
1158
|
+
o.output = Shapes::ShapeRef.new(shape: TagResourceResponse)
|
1159
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1160
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
1161
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1162
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1163
|
+
end)
|
1164
|
+
|
1165
|
+
api.add_operation(:untag_resource, Seahorse::Model::Operation.new.tap do |o|
|
1166
|
+
o.name = "UntagResource"
|
1167
|
+
o.http_method = "DELETE"
|
1168
|
+
o.http_request_uri = "/v1/email/tags"
|
1169
|
+
o.input = Shapes::ShapeRef.new(shape: UntagResourceRequest)
|
1170
|
+
o.output = Shapes::ShapeRef.new(shape: UntagResourceResponse)
|
1171
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1172
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
1173
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1174
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1175
|
+
end)
|
1176
|
+
|
1093
1177
|
api.add_operation(:update_configuration_set_event_destination, Seahorse::Model::Operation.new.tap do |o|
|
1094
1178
|
o.name = "UpdateConfigurationSetEventDestination"
|
1095
1179
|
o.http_method = "PUT"
|
@@ -266,6 +266,12 @@ module Aws::PinpointEmail
|
|
266
266
|
# sending_options: {
|
267
267
|
# sending_enabled: false,
|
268
268
|
# },
|
269
|
+
# tags: [
|
270
|
+
# {
|
271
|
+
# key: "TagKey", # required
|
272
|
+
# value: "TagValue", # required
|
273
|
+
# },
|
274
|
+
# ],
|
269
275
|
# }
|
270
276
|
#
|
271
277
|
# @!attribute [rw] configuration_set_name
|
@@ -293,6 +299,11 @@ module Aws::PinpointEmail
|
|
293
299
|
# that you send using the configuration set.
|
294
300
|
# @return [Types::SendingOptions]
|
295
301
|
#
|
302
|
+
# @!attribute [rw] tags
|
303
|
+
# An object that defines the tags (keys and values) that you want to
|
304
|
+
# associate with the configuration set.
|
305
|
+
# @return [Array<Types::Tag>]
|
306
|
+
#
|
296
307
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateConfigurationSetRequest AWS API Documentation
|
297
308
|
#
|
298
309
|
class CreateConfigurationSetRequest < Struct.new(
|
@@ -300,7 +311,8 @@ module Aws::PinpointEmail
|
|
300
311
|
:tracking_options,
|
301
312
|
:delivery_options,
|
302
313
|
:reputation_options,
|
303
|
-
:sending_options
|
314
|
+
:sending_options,
|
315
|
+
:tags)
|
304
316
|
include Aws::Structure
|
305
317
|
end
|
306
318
|
|
@@ -318,16 +330,28 @@ module Aws::PinpointEmail
|
|
318
330
|
#
|
319
331
|
# {
|
320
332
|
# pool_name: "PoolName", # required
|
333
|
+
# tags: [
|
334
|
+
# {
|
335
|
+
# key: "TagKey", # required
|
336
|
+
# value: "TagValue", # required
|
337
|
+
# },
|
338
|
+
# ],
|
321
339
|
# }
|
322
340
|
#
|
323
341
|
# @!attribute [rw] pool_name
|
324
342
|
# The name of the dedicated IP pool.
|
325
343
|
# @return [String]
|
326
344
|
#
|
345
|
+
# @!attribute [rw] tags
|
346
|
+
# An object that defines the tags (keys and values) that you want to
|
347
|
+
# associate with the pool.
|
348
|
+
# @return [Array<Types::Tag>]
|
349
|
+
#
|
327
350
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateDedicatedIpPoolRequest AWS API Documentation
|
328
351
|
#
|
329
352
|
class CreateDedicatedIpPoolRequest < Struct.new(
|
330
|
-
:pool_name
|
353
|
+
:pool_name,
|
354
|
+
:tags)
|
331
355
|
include Aws::Structure
|
332
356
|
end
|
333
357
|
|
@@ -375,6 +399,12 @@ module Aws::PinpointEmail
|
|
375
399
|
# data: "data", # required
|
376
400
|
# },
|
377
401
|
# },
|
402
|
+
# tags: [
|
403
|
+
# {
|
404
|
+
# key: "TagKey", # required
|
405
|
+
# value: "TagValue", # required
|
406
|
+
# },
|
407
|
+
# ],
|
378
408
|
# }
|
379
409
|
#
|
380
410
|
# @!attribute [rw] report_name
|
@@ -392,12 +422,18 @@ module Aws::PinpointEmail
|
|
392
422
|
# predictive inbox placement test.
|
393
423
|
# @return [Types::EmailContent]
|
394
424
|
#
|
425
|
+
# @!attribute [rw] tags
|
426
|
+
# An object that defines the tags (keys and values) that you want to
|
427
|
+
# associate with the predictive inbox placement test.
|
428
|
+
# @return [Array<Types::Tag>]
|
429
|
+
#
|
395
430
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateDeliverabilityTestReportRequest AWS API Documentation
|
396
431
|
#
|
397
432
|
class CreateDeliverabilityTestReportRequest < Struct.new(
|
398
433
|
:report_name,
|
399
434
|
:from_email_address,
|
400
|
-
:content
|
435
|
+
:content,
|
436
|
+
:tags)
|
401
437
|
include Aws::Structure
|
402
438
|
end
|
403
439
|
|
@@ -433,16 +469,28 @@ module Aws::PinpointEmail
|
|
433
469
|
#
|
434
470
|
# {
|
435
471
|
# email_identity: "Identity", # required
|
472
|
+
# tags: [
|
473
|
+
# {
|
474
|
+
# key: "TagKey", # required
|
475
|
+
# value: "TagValue", # required
|
476
|
+
# },
|
477
|
+
# ],
|
436
478
|
# }
|
437
479
|
#
|
438
480
|
# @!attribute [rw] email_identity
|
439
481
|
# The email address or domain that you want to verify.
|
440
482
|
# @return [String]
|
441
483
|
#
|
484
|
+
# @!attribute [rw] tags
|
485
|
+
# An object that defines the tags (keys and values) that you want to
|
486
|
+
# associate with the email identity.
|
487
|
+
# @return [Array<Types::Tag>]
|
488
|
+
#
|
442
489
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateEmailIdentityRequest AWS API Documentation
|
443
490
|
#
|
444
491
|
class CreateEmailIdentityRequest < Struct.new(
|
445
|
-
:email_identity
|
492
|
+
:email_identity,
|
493
|
+
:tags)
|
446
494
|
include Aws::Structure
|
447
495
|
end
|
448
496
|
|
@@ -465,7 +513,7 @@ module Aws::PinpointEmail
|
|
465
513
|
#
|
466
514
|
#
|
467
515
|
#
|
468
|
-
# [1]:
|
516
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html
|
469
517
|
# @return [Boolean]
|
470
518
|
#
|
471
519
|
# @!attribute [rw] dkim_attributes
|
@@ -1590,7 +1638,7 @@ module Aws::PinpointEmail
|
|
1590
1638
|
#
|
1591
1639
|
#
|
1592
1640
|
#
|
1593
|
-
# [1]:
|
1641
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html
|
1594
1642
|
# @return [Boolean]
|
1595
1643
|
#
|
1596
1644
|
# @!attribute [rw] dkim_attributes
|
@@ -1931,6 +1979,38 @@ module Aws::PinpointEmail
|
|
1931
1979
|
include Aws::Structure
|
1932
1980
|
end
|
1933
1981
|
|
1982
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1983
|
+
# data as a hash:
|
1984
|
+
#
|
1985
|
+
# {
|
1986
|
+
# resource_arn: "AmazonResourceName", # required
|
1987
|
+
# }
|
1988
|
+
#
|
1989
|
+
# @!attribute [rw] resource_arn
|
1990
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
1991
|
+
# retrieve tag information for.
|
1992
|
+
# @return [String]
|
1993
|
+
#
|
1994
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListTagsForResourceRequest AWS API Documentation
|
1995
|
+
#
|
1996
|
+
class ListTagsForResourceRequest < Struct.new(
|
1997
|
+
:resource_arn)
|
1998
|
+
include Aws::Structure
|
1999
|
+
end
|
2000
|
+
|
2001
|
+
# @!attribute [rw] tags
|
2002
|
+
# An array that lists all the tags that are associated with the
|
2003
|
+
# resource. Each tag consists of a required tag key (`Key`) and an
|
2004
|
+
# associated tag value (`Value`)
|
2005
|
+
# @return [Array<Types::Tag>]
|
2006
|
+
#
|
2007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListTagsForResourceResponse AWS API Documentation
|
2008
|
+
#
|
2009
|
+
class ListTagsForResourceResponse < Struct.new(
|
2010
|
+
:tags)
|
2011
|
+
include Aws::Structure
|
2012
|
+
end
|
2013
|
+
|
1934
2014
|
# A list of attributes that are associated with a MAIL FROM domain.
|
1935
2015
|
#
|
1936
2016
|
# @!attribute [rw] mail_from_domain
|
@@ -2880,7 +2960,7 @@ module Aws::PinpointEmail
|
|
2880
2960
|
#
|
2881
2961
|
#
|
2882
2962
|
#
|
2883
|
-
# [1]:
|
2963
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
|
2884
2964
|
# @return [String]
|
2885
2965
|
#
|
2886
2966
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/SnsDestination AWS API Documentation
|
@@ -2890,6 +2970,108 @@ module Aws::PinpointEmail
|
|
2890
2970
|
include Aws::Structure
|
2891
2971
|
end
|
2892
2972
|
|
2973
|
+
# An object that defines the tags that are associated with a resource.
|
2974
|
+
# A *tag* is a label that you optionally define and associate with a
|
2975
|
+
# resource in Amazon Pinpoint. Tags can help you categorize and manage
|
2976
|
+
# resources in different ways, such as by purpose, owner, environment,
|
2977
|
+
# or other criteria. A resource can have as many as 50 tags.
|
2978
|
+
#
|
2979
|
+
# Each tag consists of a required *tag key* and an associated *tag
|
2980
|
+
# value*, both of which you define. A tag key is a general label that
|
2981
|
+
# acts as a category for a more specific tag value. A tag value acts as
|
2982
|
+
# a descriptor within a tag key. For example, if you have two versions
|
2983
|
+
# of an Amazon Pinpoint project, one for internal testing and another
|
2984
|
+
# for external use, you might assign a `Stack` tag key to both projects.
|
2985
|
+
# The value of the `Stack` tag key might be `Test` for one project
|
2986
|
+
# and `Production` for the other project.
|
2987
|
+
#
|
2988
|
+
# A tag key can contain as many as 128 characters. A tag value can
|
2989
|
+
# contain as many as 256 characters. The characters can be Unicode
|
2990
|
+
# letters, digits, white space, or one of the following symbols: \_ . :
|
2991
|
+
# / = + -. The following additional restrictions apply to tags:
|
2992
|
+
#
|
2993
|
+
# * Tag keys and values are case sensitive.
|
2994
|
+
#
|
2995
|
+
# * For each associated resource, each tag key must be unique and it can
|
2996
|
+
# have only one value.
|
2997
|
+
#
|
2998
|
+
# * The `aws:` prefix is reserved for use by AWS; you can’t use it in
|
2999
|
+
# any tag keys or values that you define. In addition, you can't edit
|
3000
|
+
# or remove tag keys or values that use this prefix. Tags that use
|
3001
|
+
# this prefix don’t count against the limit of 50 tags per resource.
|
3002
|
+
#
|
3003
|
+
# * You can associate tags with public or shared resources, but the tags
|
3004
|
+
# are available only for your AWS account, not any other accounts that
|
3005
|
+
# share the resource. In addition, the tags are available only for
|
3006
|
+
# resources that are located in the specified AWS Region for your AWS
|
3007
|
+
# account.
|
3008
|
+
#
|
3009
|
+
# @note When making an API call, you may pass Tag
|
3010
|
+
# data as a hash:
|
3011
|
+
#
|
3012
|
+
# {
|
3013
|
+
# key: "TagKey", # required
|
3014
|
+
# value: "TagValue", # required
|
3015
|
+
# }
|
3016
|
+
#
|
3017
|
+
# @!attribute [rw] key
|
3018
|
+
# One part of a key-value pair that defines a tag. The maximum length
|
3019
|
+
# of a tag key is 128 characters. The minimum length is 1 character.
|
3020
|
+
# @return [String]
|
3021
|
+
#
|
3022
|
+
# @!attribute [rw] value
|
3023
|
+
# The optional part of a key-value pair that defines a tag. The
|
3024
|
+
# maximum length of a tag value is 256 characters. The minimum length
|
3025
|
+
# is 0 characters. If you don’t want a resource to have a specific tag
|
3026
|
+
# value, don’t specify a value for this parameter. Amazon Pinpoint
|
3027
|
+
# will set the value to an empty string.
|
3028
|
+
# @return [String]
|
3029
|
+
#
|
3030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/Tag AWS API Documentation
|
3031
|
+
#
|
3032
|
+
class Tag < Struct.new(
|
3033
|
+
:key,
|
3034
|
+
:value)
|
3035
|
+
include Aws::Structure
|
3036
|
+
end
|
3037
|
+
|
3038
|
+
# @note When making an API call, you may pass TagResourceRequest
|
3039
|
+
# data as a hash:
|
3040
|
+
#
|
3041
|
+
# {
|
3042
|
+
# resource_arn: "AmazonResourceName", # required
|
3043
|
+
# tags: [ # required
|
3044
|
+
# {
|
3045
|
+
# key: "TagKey", # required
|
3046
|
+
# value: "TagValue", # required
|
3047
|
+
# },
|
3048
|
+
# ],
|
3049
|
+
# }
|
3050
|
+
#
|
3051
|
+
# @!attribute [rw] resource_arn
|
3052
|
+
# The Amazon Resource Name (ARN) of the resource that you want to add
|
3053
|
+
# one or more tags to.
|
3054
|
+
# @return [String]
|
3055
|
+
#
|
3056
|
+
# @!attribute [rw] tags
|
3057
|
+
# A list of the tags that you want to add to the resource. A tag
|
3058
|
+
# consists of a required tag key (`Key`) and an associated tag value
|
3059
|
+
# (`Value`). The maximum length of a tag key is 128 characters. The
|
3060
|
+
# maximum length of a tag value is 256 characters.
|
3061
|
+
# @return [Array<Types::Tag>]
|
3062
|
+
#
|
3063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/TagResourceRequest AWS API Documentation
|
3064
|
+
#
|
3065
|
+
class TagResourceRequest < Struct.new(
|
3066
|
+
:resource_arn,
|
3067
|
+
:tags)
|
3068
|
+
include Aws::Structure
|
3069
|
+
end
|
3070
|
+
|
3071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/TagResourceResponse AWS API Documentation
|
3072
|
+
#
|
3073
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
3074
|
+
|
2893
3075
|
# An object that defines the tracking options for a configuration set.
|
2894
3076
|
# When you use Amazon Pinpoint to send an email, it contains an
|
2895
3077
|
# invisible image that's used to track when recipients open your email.
|
@@ -2918,6 +3100,42 @@ module Aws::PinpointEmail
|
|
2918
3100
|
include Aws::Structure
|
2919
3101
|
end
|
2920
3102
|
|
3103
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
3104
|
+
# data as a hash:
|
3105
|
+
#
|
3106
|
+
# {
|
3107
|
+
# resource_arn: "AmazonResourceName", # required
|
3108
|
+
# tag_keys: ["TagKey"], # required
|
3109
|
+
# }
|
3110
|
+
#
|
3111
|
+
# @!attribute [rw] resource_arn
|
3112
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
3113
|
+
# remove one or more tags from.
|
3114
|
+
# @return [String]
|
3115
|
+
#
|
3116
|
+
# @!attribute [rw] tag_keys
|
3117
|
+
# The tags (tag keys) that you want to remove from the resource. When
|
3118
|
+
# you specify a tag key, the action removes both that key and its
|
3119
|
+
# associated tag value.
|
3120
|
+
#
|
3121
|
+
# To remove more than one tag from the resource, append the `TagKeys`
|
3122
|
+
# parameter and argument for each additional tag to remove, separated
|
3123
|
+
# by an ampersand. For example:
|
3124
|
+
# `/v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2`
|
3125
|
+
# @return [Array<String>]
|
3126
|
+
#
|
3127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/UntagResourceRequest AWS API Documentation
|
3128
|
+
#
|
3129
|
+
class UntagResourceRequest < Struct.new(
|
3130
|
+
:resource_arn,
|
3131
|
+
:tag_keys)
|
3132
|
+
include Aws::Structure
|
3133
|
+
end
|
3134
|
+
|
3135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/UntagResourceResponse AWS API Documentation
|
3136
|
+
#
|
3137
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
3138
|
+
|
2921
3139
|
# A request to change the settings for an event destination for a
|
2922
3140
|
# configuration set.
|
2923
3141
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-pinpointemail
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.6.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-03-
|
11
|
+
date: 2019-03-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|