aws-sdk-sesv2 1.79.0 → 1.81.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sesv2/client.rb +599 -10
- data/lib/aws-sdk-sesv2/client_api.rb +349 -0
- data/lib/aws-sdk-sesv2/types.rb +747 -1
- data/lib/aws-sdk-sesv2.rb +1 -1
- data/sig/client.rbs +149 -1
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +188 -1
- metadata +3 -3
data/lib/aws-sdk-sesv2/client.rb
CHANGED
@@ -95,7 +95,7 @@ module Aws::SESV2
|
|
95
95
|
# class name or an instance of a plugin class.
|
96
96
|
#
|
97
97
|
# @option options [required, Aws::CredentialProvider] :credentials
|
98
|
-
# Your AWS credentials. This can be an instance of any one of the
|
98
|
+
# Your AWS credentials used for authentication. This can be an instance of any one of the
|
99
99
|
# following classes:
|
100
100
|
#
|
101
101
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
@@ -128,18 +128,23 @@ module Aws::SESV2
|
|
128
128
|
# locations will be searched for credentials:
|
129
129
|
#
|
130
130
|
# * `Aws.config[:credentials]`
|
131
|
+
#
|
131
132
|
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
132
133
|
# `:account_id` options.
|
133
|
-
#
|
134
|
-
#
|
134
|
+
#
|
135
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
136
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
137
|
+
#
|
135
138
|
# * `~/.aws/credentials`
|
139
|
+
#
|
136
140
|
# * `~/.aws/config`
|
141
|
+
#
|
137
142
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
138
143
|
# are very aggressive. Construct and pass an instance of
|
139
144
|
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
140
145
|
# enable retries and extended timeouts. Instance profile credential
|
141
|
-
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
142
|
-
# to true
|
146
|
+
# fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
|
147
|
+
# to `true`.
|
143
148
|
#
|
144
149
|
# @option options [required, String] :region
|
145
150
|
# The AWS region to connect to. The configured `:region` is
|
@@ -167,6 +172,11 @@ module Aws::SESV2
|
|
167
172
|
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
168
173
|
# not retry instead of sleeping.
|
169
174
|
#
|
175
|
+
# @option options [Array<String>] :auth_scheme_preference
|
176
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
177
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
178
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
179
|
+
#
|
170
180
|
# @option options [Boolean] :client_side_monitoring (false)
|
171
181
|
# When `true`, client-side metrics will be collected for all API requests from
|
172
182
|
# this client.
|
@@ -253,8 +263,8 @@ module Aws::SESV2
|
|
253
263
|
# 4 times. Used in `standard` and `adaptive` retry modes.
|
254
264
|
#
|
255
265
|
# @option options [String] :profile ("default")
|
256
|
-
# Used when loading credentials from the shared credentials file
|
257
|
-
#
|
266
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
267
|
+
# When not specified, 'default' is used.
|
258
268
|
#
|
259
269
|
# @option options [String] :request_checksum_calculation ("when_supported")
|
260
270
|
# Determines when a checksum will be calculated for request payloads. Values are:
|
@@ -367,7 +377,7 @@ module Aws::SESV2
|
|
367
377
|
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
368
378
|
#
|
369
379
|
# @option options [Aws::TokenProvider] :token_provider
|
370
|
-
#
|
380
|
+
# Your Bearer token used for authentication. This can be an instance of any one of the
|
371
381
|
# following classes:
|
372
382
|
#
|
373
383
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
@@ -1485,6 +1495,100 @@ module Aws::SESV2
|
|
1485
1495
|
req.send_request(options)
|
1486
1496
|
end
|
1487
1497
|
|
1498
|
+
# Create a tenant.
|
1499
|
+
#
|
1500
|
+
# *Tenants* are logical containers that group related SES resources
|
1501
|
+
# together. Each tenant can have its own set of resources like email
|
1502
|
+
# identities, configuration sets, and templates, along with reputation
|
1503
|
+
# metrics and sending status. This helps isolate and manage email
|
1504
|
+
# sending for different customers or business units within your Amazon
|
1505
|
+
# SES API v2 account.
|
1506
|
+
#
|
1507
|
+
# @option params [required, String] :tenant_name
|
1508
|
+
# The name of the tenant to create. The name can contain up to 64
|
1509
|
+
# alphanumeric characters, including letters, numbers, hyphens (-) and
|
1510
|
+
# underscores (\_) only.
|
1511
|
+
#
|
1512
|
+
# @option params [Array<Types::Tag>] :tags
|
1513
|
+
# An array of objects that define the tags (keys and values) to
|
1514
|
+
# associate with the tenant
|
1515
|
+
#
|
1516
|
+
# @return [Types::CreateTenantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1517
|
+
#
|
1518
|
+
# * {Types::CreateTenantResponse#tenant_name #tenant_name} => String
|
1519
|
+
# * {Types::CreateTenantResponse#tenant_id #tenant_id} => String
|
1520
|
+
# * {Types::CreateTenantResponse#tenant_arn #tenant_arn} => String
|
1521
|
+
# * {Types::CreateTenantResponse#created_timestamp #created_timestamp} => Time
|
1522
|
+
# * {Types::CreateTenantResponse#tags #tags} => Array<Types::Tag>
|
1523
|
+
# * {Types::CreateTenantResponse#sending_status #sending_status} => String
|
1524
|
+
#
|
1525
|
+
# @example Request syntax with placeholder values
|
1526
|
+
#
|
1527
|
+
# resp = client.create_tenant({
|
1528
|
+
# tenant_name: "TenantName", # required
|
1529
|
+
# tags: [
|
1530
|
+
# {
|
1531
|
+
# key: "TagKey", # required
|
1532
|
+
# value: "TagValue", # required
|
1533
|
+
# },
|
1534
|
+
# ],
|
1535
|
+
# })
|
1536
|
+
#
|
1537
|
+
# @example Response structure
|
1538
|
+
#
|
1539
|
+
# resp.tenant_name #=> String
|
1540
|
+
# resp.tenant_id #=> String
|
1541
|
+
# resp.tenant_arn #=> String
|
1542
|
+
# resp.created_timestamp #=> Time
|
1543
|
+
# resp.tags #=> Array
|
1544
|
+
# resp.tags[0].key #=> String
|
1545
|
+
# resp.tags[0].value #=> String
|
1546
|
+
# resp.sending_status #=> String, one of "ENABLED", "REINSTATED", "DISABLED"
|
1547
|
+
#
|
1548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateTenant AWS API Documentation
|
1549
|
+
#
|
1550
|
+
# @overload create_tenant(params = {})
|
1551
|
+
# @param [Hash] params ({})
|
1552
|
+
def create_tenant(params = {}, options = {})
|
1553
|
+
req = build_request(:create_tenant, params)
|
1554
|
+
req.send_request(options)
|
1555
|
+
end
|
1556
|
+
|
1557
|
+
# Associate a resource with a tenant.
|
1558
|
+
#
|
1559
|
+
# *Resources* can be email identities, configuration sets, or email
|
1560
|
+
# templates. When you associate a resource with a tenant, you can use
|
1561
|
+
# that resource when sending emails on behalf of that tenant.
|
1562
|
+
#
|
1563
|
+
# A single resource can be associated with multiple tenants, allowing
|
1564
|
+
# for resource sharing across different tenants while maintaining
|
1565
|
+
# isolation in email sending operations.
|
1566
|
+
#
|
1567
|
+
# @option params [required, String] :tenant_name
|
1568
|
+
# The name of the tenant to associate the resource with.
|
1569
|
+
#
|
1570
|
+
# @option params [required, String] :resource_arn
|
1571
|
+
# The Amazon Resource Name (ARN) of the resource to associate with the
|
1572
|
+
# tenant.
|
1573
|
+
#
|
1574
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1575
|
+
#
|
1576
|
+
# @example Request syntax with placeholder values
|
1577
|
+
#
|
1578
|
+
# resp = client.create_tenant_resource_association({
|
1579
|
+
# tenant_name: "TenantName", # required
|
1580
|
+
# resource_arn: "AmazonResourceName", # required
|
1581
|
+
# })
|
1582
|
+
#
|
1583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateTenantResourceAssociation AWS API Documentation
|
1584
|
+
#
|
1585
|
+
# @overload create_tenant_resource_association(params = {})
|
1586
|
+
# @param [Hash] params ({})
|
1587
|
+
def create_tenant_resource_association(params = {}, options = {})
|
1588
|
+
req = build_request(:create_tenant_resource_association, params)
|
1589
|
+
req.send_request(options)
|
1590
|
+
end
|
1591
|
+
|
1488
1592
|
# Delete an existing configuration set.
|
1489
1593
|
#
|
1490
1594
|
# *Configuration sets* are groups of rules that you can apply to the
|
@@ -1796,6 +1900,63 @@ module Aws::SESV2
|
|
1796
1900
|
req.send_request(options)
|
1797
1901
|
end
|
1798
1902
|
|
1903
|
+
# Delete an existing tenant.
|
1904
|
+
#
|
1905
|
+
# When you delete a tenant, its associations with resources are removed,
|
1906
|
+
# but the resources themselves are not deleted.
|
1907
|
+
#
|
1908
|
+
# @option params [required, String] :tenant_name
|
1909
|
+
# The name of the tenant to delete.
|
1910
|
+
#
|
1911
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1912
|
+
#
|
1913
|
+
# @example Request syntax with placeholder values
|
1914
|
+
#
|
1915
|
+
# resp = client.delete_tenant({
|
1916
|
+
# tenant_name: "TenantName", # required
|
1917
|
+
# })
|
1918
|
+
#
|
1919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteTenant AWS API Documentation
|
1920
|
+
#
|
1921
|
+
# @overload delete_tenant(params = {})
|
1922
|
+
# @param [Hash] params ({})
|
1923
|
+
def delete_tenant(params = {}, options = {})
|
1924
|
+
req = build_request(:delete_tenant, params)
|
1925
|
+
req.send_request(options)
|
1926
|
+
end
|
1927
|
+
|
1928
|
+
# Delete an association between a tenant and a resource.
|
1929
|
+
#
|
1930
|
+
# When you delete a tenant-resource association, the resource itself is
|
1931
|
+
# not deleted, only its association with the specific tenant is removed.
|
1932
|
+
# After removal, the resource will no longer be available for use with
|
1933
|
+
# that tenant's email sending operations.
|
1934
|
+
#
|
1935
|
+
# @option params [required, String] :tenant_name
|
1936
|
+
# The name of the tenant to remove the resource association from.
|
1937
|
+
#
|
1938
|
+
# @option params [required, String] :resource_arn
|
1939
|
+
# The Amazon Resource Name (ARN) of the resource to remove from the
|
1940
|
+
# tenant association.
|
1941
|
+
#
|
1942
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1943
|
+
#
|
1944
|
+
# @example Request syntax with placeholder values
|
1945
|
+
#
|
1946
|
+
# resp = client.delete_tenant_resource_association({
|
1947
|
+
# tenant_name: "TenantName", # required
|
1948
|
+
# resource_arn: "AmazonResourceName", # required
|
1949
|
+
# })
|
1950
|
+
#
|
1951
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteTenantResourceAssociation AWS API Documentation
|
1952
|
+
#
|
1953
|
+
# @overload delete_tenant_resource_association(params = {})
|
1954
|
+
# @param [Hash] params ({})
|
1955
|
+
def delete_tenant_resource_association(params = {}, options = {})
|
1956
|
+
req = build_request(:delete_tenant_resource_association, params)
|
1957
|
+
req.send_request(options)
|
1958
|
+
end
|
1959
|
+
|
1799
1960
|
# Obtain information about the email-sending status and capabilities of
|
1800
1961
|
# your Amazon SES account in the current Amazon Web Services Region.
|
1801
1962
|
#
|
@@ -2937,6 +3098,58 @@ module Aws::SESV2
|
|
2937
3098
|
req.send_request(options)
|
2938
3099
|
end
|
2939
3100
|
|
3101
|
+
# Retrieve information about a specific reputation entity, including its
|
3102
|
+
# reputation management policy, customer-managed status, Amazon Web
|
3103
|
+
# Services Amazon SES-managed status, and aggregate sending status.
|
3104
|
+
#
|
3105
|
+
# *Reputation entities* represent resources in your Amazon SES account
|
3106
|
+
# that have reputation tracking and management capabilities. The
|
3107
|
+
# reputation impact reflects the highest impact reputation finding for
|
3108
|
+
# the entity. Reputation findings can be retrieved using the
|
3109
|
+
# `ListRecommendations` operation.
|
3110
|
+
#
|
3111
|
+
# @option params [required, String] :reputation_entity_reference
|
3112
|
+
# The unique identifier for the reputation entity. For resource-type
|
3113
|
+
# entities, this is the Amazon Resource Name (ARN) of the resource.
|
3114
|
+
#
|
3115
|
+
# @option params [required, String] :reputation_entity_type
|
3116
|
+
# The type of reputation entity. Currently, only `RESOURCE` type
|
3117
|
+
# entities are supported.
|
3118
|
+
#
|
3119
|
+
# @return [Types::GetReputationEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3120
|
+
#
|
3121
|
+
# * {Types::GetReputationEntityResponse#reputation_entity #reputation_entity} => Types::ReputationEntity
|
3122
|
+
#
|
3123
|
+
# @example Request syntax with placeholder values
|
3124
|
+
#
|
3125
|
+
# resp = client.get_reputation_entity({
|
3126
|
+
# reputation_entity_reference: "ReputationEntityReference", # required
|
3127
|
+
# reputation_entity_type: "RESOURCE", # required, accepts RESOURCE
|
3128
|
+
# })
|
3129
|
+
#
|
3130
|
+
# @example Response structure
|
3131
|
+
#
|
3132
|
+
# resp.reputation_entity.reputation_entity_reference #=> String
|
3133
|
+
# resp.reputation_entity.reputation_entity_type #=> String, one of "RESOURCE"
|
3134
|
+
# resp.reputation_entity.reputation_management_policy #=> String
|
3135
|
+
# resp.reputation_entity.customer_managed_status.status #=> String, one of "ENABLED", "REINSTATED", "DISABLED"
|
3136
|
+
# resp.reputation_entity.customer_managed_status.cause #=> String
|
3137
|
+
# resp.reputation_entity.customer_managed_status.last_updated_timestamp #=> Time
|
3138
|
+
# resp.reputation_entity.aws_ses_managed_status.status #=> String, one of "ENABLED", "REINSTATED", "DISABLED"
|
3139
|
+
# resp.reputation_entity.aws_ses_managed_status.cause #=> String
|
3140
|
+
# resp.reputation_entity.aws_ses_managed_status.last_updated_timestamp #=> Time
|
3141
|
+
# resp.reputation_entity.sending_status_aggregate #=> String, one of "ENABLED", "REINSTATED", "DISABLED"
|
3142
|
+
# resp.reputation_entity.reputation_impact #=> String, one of "LOW", "HIGH"
|
3143
|
+
#
|
3144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetReputationEntity AWS API Documentation
|
3145
|
+
#
|
3146
|
+
# @overload get_reputation_entity(params = {})
|
3147
|
+
# @param [Hash] params ({})
|
3148
|
+
def get_reputation_entity(params = {}, options = {})
|
3149
|
+
req = build_request(:get_reputation_entity, params)
|
3150
|
+
req.send_request(options)
|
3151
|
+
end
|
3152
|
+
|
2940
3153
|
# Retrieves information about a specific email address that's on the
|
2941
3154
|
# suppression list for your account.
|
2942
3155
|
#
|
@@ -2970,6 +3183,42 @@ module Aws::SESV2
|
|
2970
3183
|
req.send_request(options)
|
2971
3184
|
end
|
2972
3185
|
|
3186
|
+
# Get information about a specific tenant, including the tenant's name,
|
3187
|
+
# ID, ARN, creation timestamp, tags, and sending status.
|
3188
|
+
#
|
3189
|
+
# @option params [required, String] :tenant_name
|
3190
|
+
# The name of the tenant to retrieve information about.
|
3191
|
+
#
|
3192
|
+
# @return [Types::GetTenantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3193
|
+
#
|
3194
|
+
# * {Types::GetTenantResponse#tenant #tenant} => Types::Tenant
|
3195
|
+
#
|
3196
|
+
# @example Request syntax with placeholder values
|
3197
|
+
#
|
3198
|
+
# resp = client.get_tenant({
|
3199
|
+
# tenant_name: "TenantName", # required
|
3200
|
+
# })
|
3201
|
+
#
|
3202
|
+
# @example Response structure
|
3203
|
+
#
|
3204
|
+
# resp.tenant.tenant_name #=> String
|
3205
|
+
# resp.tenant.tenant_id #=> String
|
3206
|
+
# resp.tenant.tenant_arn #=> String
|
3207
|
+
# resp.tenant.created_timestamp #=> Time
|
3208
|
+
# resp.tenant.tags #=> Array
|
3209
|
+
# resp.tenant.tags[0].key #=> String
|
3210
|
+
# resp.tenant.tags[0].value #=> String
|
3211
|
+
# resp.tenant.sending_status #=> String, one of "ENABLED", "REINSTATED", "DISABLED"
|
3212
|
+
#
|
3213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetTenant AWS API Documentation
|
3214
|
+
#
|
3215
|
+
# @overload get_tenant(params = {})
|
3216
|
+
# @param [Hash] params ({})
|
3217
|
+
def get_tenant(params = {}, options = {})
|
3218
|
+
req = build_request(:get_tenant, params)
|
3219
|
+
req.send_request(options)
|
3220
|
+
end
|
3221
|
+
|
2973
3222
|
# List all of the configuration sets associated with your account in the
|
2974
3223
|
# current region.
|
2975
3224
|
#
|
@@ -3695,7 +3944,7 @@ module Aws::SESV2
|
|
3695
3944
|
#
|
3696
3945
|
# resp.recommendations #=> Array
|
3697
3946
|
# resp.recommendations[0].resource_arn #=> String
|
3698
|
-
# resp.recommendations[0].type #=> String, one of "DKIM", "DMARC", "SPF", "BIMI", "COMPLAINT"
|
3947
|
+
# resp.recommendations[0].type #=> String, one of "DKIM", "DMARC", "SPF", "BIMI", "COMPLAINT", "BOUNCE", "FEEDBACK_3P", "IP_LISTING"
|
3699
3948
|
# resp.recommendations[0].description #=> String
|
3700
3949
|
# resp.recommendations[0].status #=> String, one of "OPEN", "FIXED"
|
3701
3950
|
# resp.recommendations[0].created_timestamp #=> Time
|
@@ -3712,6 +3961,125 @@ module Aws::SESV2
|
|
3712
3961
|
req.send_request(options)
|
3713
3962
|
end
|
3714
3963
|
|
3964
|
+
# List reputation entities in your Amazon SES account in the current
|
3965
|
+
# Amazon Web Services Region. You can filter the results by entity type,
|
3966
|
+
# reputation impact, sending status, or entity reference prefix.
|
3967
|
+
#
|
3968
|
+
# *Reputation entities* represent resources in your account that have
|
3969
|
+
# reputation tracking and management capabilities. Use this operation to
|
3970
|
+
# get an overview of all entities and their current reputation status.
|
3971
|
+
#
|
3972
|
+
# @option params [Hash<String,String>] :filter
|
3973
|
+
# An object that contains filters to apply when listing reputation
|
3974
|
+
# entities. You can filter by entity type, reputation impact, sending
|
3975
|
+
# status, or entity reference prefix.
|
3976
|
+
#
|
3977
|
+
# @option params [String] :next_token
|
3978
|
+
# A token returned from a previous call to `ListReputationEntities` to
|
3979
|
+
# indicate the position in the list of reputation entities.
|
3980
|
+
#
|
3981
|
+
# @option params [Integer] :page_size
|
3982
|
+
# The number of results to show in a single call to
|
3983
|
+
# `ListReputationEntities`. If the number of results is larger than the
|
3984
|
+
# number you specified in this parameter, then the response includes a
|
3985
|
+
# `NextToken` element, which you can use to obtain additional results.
|
3986
|
+
#
|
3987
|
+
# @return [Types::ListReputationEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3988
|
+
#
|
3989
|
+
# * {Types::ListReputationEntitiesResponse#reputation_entities #reputation_entities} => Array<Types::ReputationEntity>
|
3990
|
+
# * {Types::ListReputationEntitiesResponse#next_token #next_token} => String
|
3991
|
+
#
|
3992
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3993
|
+
#
|
3994
|
+
# @example Request syntax with placeholder values
|
3995
|
+
#
|
3996
|
+
# resp = client.list_reputation_entities({
|
3997
|
+
# filter: {
|
3998
|
+
# "ENTITY_TYPE" => "ReputationEntityFilterValue",
|
3999
|
+
# },
|
4000
|
+
# next_token: "NextToken",
|
4001
|
+
# page_size: 1,
|
4002
|
+
# })
|
4003
|
+
#
|
4004
|
+
# @example Response structure
|
4005
|
+
#
|
4006
|
+
# resp.reputation_entities #=> Array
|
4007
|
+
# resp.reputation_entities[0].reputation_entity_reference #=> String
|
4008
|
+
# resp.reputation_entities[0].reputation_entity_type #=> String, one of "RESOURCE"
|
4009
|
+
# resp.reputation_entities[0].reputation_management_policy #=> String
|
4010
|
+
# resp.reputation_entities[0].customer_managed_status.status #=> String, one of "ENABLED", "REINSTATED", "DISABLED"
|
4011
|
+
# resp.reputation_entities[0].customer_managed_status.cause #=> String
|
4012
|
+
# resp.reputation_entities[0].customer_managed_status.last_updated_timestamp #=> Time
|
4013
|
+
# resp.reputation_entities[0].aws_ses_managed_status.status #=> String, one of "ENABLED", "REINSTATED", "DISABLED"
|
4014
|
+
# resp.reputation_entities[0].aws_ses_managed_status.cause #=> String
|
4015
|
+
# resp.reputation_entities[0].aws_ses_managed_status.last_updated_timestamp #=> Time
|
4016
|
+
# resp.reputation_entities[0].sending_status_aggregate #=> String, one of "ENABLED", "REINSTATED", "DISABLED"
|
4017
|
+
# resp.reputation_entities[0].reputation_impact #=> String, one of "LOW", "HIGH"
|
4018
|
+
# resp.next_token #=> String
|
4019
|
+
#
|
4020
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListReputationEntities AWS API Documentation
|
4021
|
+
#
|
4022
|
+
# @overload list_reputation_entities(params = {})
|
4023
|
+
# @param [Hash] params ({})
|
4024
|
+
def list_reputation_entities(params = {}, options = {})
|
4025
|
+
req = build_request(:list_reputation_entities, params)
|
4026
|
+
req.send_request(options)
|
4027
|
+
end
|
4028
|
+
|
4029
|
+
# List all tenants associated with a specific resource.
|
4030
|
+
#
|
4031
|
+
# This operation returns a list of tenants that are associated with the
|
4032
|
+
# specified resource. This is useful for understanding which tenants are
|
4033
|
+
# currently using a particular resource such as an email identity,
|
4034
|
+
# configuration set, or email template.
|
4035
|
+
#
|
4036
|
+
# @option params [required, String] :resource_arn
|
4037
|
+
# The Amazon Resource Name (ARN) of the resource to list associated
|
4038
|
+
# tenants for.
|
4039
|
+
#
|
4040
|
+
# @option params [Integer] :page_size
|
4041
|
+
# The number of results to show in a single call to
|
4042
|
+
# `ListResourceTenants`. If the number of results is larger than the
|
4043
|
+
# number you specified in this parameter, then the response includes a
|
4044
|
+
# `NextToken` element, which you can use to obtain additional results.
|
4045
|
+
#
|
4046
|
+
# @option params [String] :next_token
|
4047
|
+
# A token returned from a previous call to `ListResourceTenants` to
|
4048
|
+
# indicate the position in the list of resource tenants.
|
4049
|
+
#
|
4050
|
+
# @return [Types::ListResourceTenantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4051
|
+
#
|
4052
|
+
# * {Types::ListResourceTenantsResponse#resource_tenants #resource_tenants} => Array<Types::ResourceTenantMetadata>
|
4053
|
+
# * {Types::ListResourceTenantsResponse#next_token #next_token} => String
|
4054
|
+
#
|
4055
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4056
|
+
#
|
4057
|
+
# @example Request syntax with placeholder values
|
4058
|
+
#
|
4059
|
+
# resp = client.list_resource_tenants({
|
4060
|
+
# resource_arn: "AmazonResourceName", # required
|
4061
|
+
# page_size: 1,
|
4062
|
+
# next_token: "NextToken",
|
4063
|
+
# })
|
4064
|
+
#
|
4065
|
+
# @example Response structure
|
4066
|
+
#
|
4067
|
+
# resp.resource_tenants #=> Array
|
4068
|
+
# resp.resource_tenants[0].tenant_name #=> String
|
4069
|
+
# resp.resource_tenants[0].tenant_id #=> String
|
4070
|
+
# resp.resource_tenants[0].resource_arn #=> String
|
4071
|
+
# resp.resource_tenants[0].associated_timestamp #=> Time
|
4072
|
+
# resp.next_token #=> String
|
4073
|
+
#
|
4074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListResourceTenants AWS API Documentation
|
4075
|
+
#
|
4076
|
+
# @overload list_resource_tenants(params = {})
|
4077
|
+
# @param [Hash] params ({})
|
4078
|
+
def list_resource_tenants(params = {}, options = {})
|
4079
|
+
req = build_request(:list_resource_tenants, params)
|
4080
|
+
req.send_request(options)
|
4081
|
+
end
|
4082
|
+
|
3715
4083
|
# Retrieves a list of email addresses that are on the suppression list
|
3716
4084
|
# for your account.
|
3717
4085
|
#
|
@@ -3808,6 +4176,113 @@ module Aws::SESV2
|
|
3808
4176
|
req.send_request(options)
|
3809
4177
|
end
|
3810
4178
|
|
4179
|
+
# List all resources associated with a specific tenant.
|
4180
|
+
#
|
4181
|
+
# This operation returns a list of resources (email identities,
|
4182
|
+
# configuration sets, or email templates) that are associated with the
|
4183
|
+
# specified tenant. You can optionally filter the results by resource
|
4184
|
+
# type.
|
4185
|
+
#
|
4186
|
+
# @option params [required, String] :tenant_name
|
4187
|
+
# The name of the tenant to list resources for.
|
4188
|
+
#
|
4189
|
+
# @option params [Hash<String,String>] :filter
|
4190
|
+
# A map of filter keys and values for filtering the list of tenant
|
4191
|
+
# resources. Currently, the only supported filter key is
|
4192
|
+
# `RESOURCE_TYPE`.
|
4193
|
+
#
|
4194
|
+
# @option params [Integer] :page_size
|
4195
|
+
# The number of results to show in a single call to
|
4196
|
+
# `ListTenantResources`. If the number of results is larger than the
|
4197
|
+
# number you specified in this parameter, then the response includes a
|
4198
|
+
# `NextToken` element, which you can use to obtain additional results.
|
4199
|
+
#
|
4200
|
+
# @option params [String] :next_token
|
4201
|
+
# A token returned from a previous call to `ListTenantResources` to
|
4202
|
+
# indicate the position in the list of tenant resources.
|
4203
|
+
#
|
4204
|
+
# @return [Types::ListTenantResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4205
|
+
#
|
4206
|
+
# * {Types::ListTenantResourcesResponse#tenant_resources #tenant_resources} => Array<Types::TenantResource>
|
4207
|
+
# * {Types::ListTenantResourcesResponse#next_token #next_token} => String
|
4208
|
+
#
|
4209
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4210
|
+
#
|
4211
|
+
# @example Request syntax with placeholder values
|
4212
|
+
#
|
4213
|
+
# resp = client.list_tenant_resources({
|
4214
|
+
# tenant_name: "TenantName", # required
|
4215
|
+
# filter: {
|
4216
|
+
# "RESOURCE_TYPE" => "ListTenantResourcesFilterValue",
|
4217
|
+
# },
|
4218
|
+
# page_size: 1,
|
4219
|
+
# next_token: "NextToken",
|
4220
|
+
# })
|
4221
|
+
#
|
4222
|
+
# @example Response structure
|
4223
|
+
#
|
4224
|
+
# resp.tenant_resources #=> Array
|
4225
|
+
# resp.tenant_resources[0].resource_type #=> String, one of "EMAIL_IDENTITY", "CONFIGURATION_SET", "EMAIL_TEMPLATE"
|
4226
|
+
# resp.tenant_resources[0].resource_arn #=> String
|
4227
|
+
# resp.next_token #=> String
|
4228
|
+
#
|
4229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListTenantResources AWS API Documentation
|
4230
|
+
#
|
4231
|
+
# @overload list_tenant_resources(params = {})
|
4232
|
+
# @param [Hash] params ({})
|
4233
|
+
def list_tenant_resources(params = {}, options = {})
|
4234
|
+
req = build_request(:list_tenant_resources, params)
|
4235
|
+
req.send_request(options)
|
4236
|
+
end
|
4237
|
+
|
4238
|
+
# List all tenants associated with your account in the current Amazon
|
4239
|
+
# Web Services Region.
|
4240
|
+
#
|
4241
|
+
# This operation returns basic information about each tenant, such as
|
4242
|
+
# tenant name, ID, ARN, and creation timestamp.
|
4243
|
+
#
|
4244
|
+
# @option params [String] :next_token
|
4245
|
+
# A token returned from a previous call to `ListTenants` to indicate the
|
4246
|
+
# position in the list of tenants.
|
4247
|
+
#
|
4248
|
+
# @option params [Integer] :page_size
|
4249
|
+
# The number of results to show in a single call to `ListTenants`. If
|
4250
|
+
# the number of results is larger than the number you specified in this
|
4251
|
+
# parameter, then the response includes a `NextToken` element, which you
|
4252
|
+
# can use to obtain additional results.
|
4253
|
+
#
|
4254
|
+
# @return [Types::ListTenantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4255
|
+
#
|
4256
|
+
# * {Types::ListTenantsResponse#tenants #tenants} => Array<Types::TenantInfo>
|
4257
|
+
# * {Types::ListTenantsResponse#next_token #next_token} => String
|
4258
|
+
#
|
4259
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4260
|
+
#
|
4261
|
+
# @example Request syntax with placeholder values
|
4262
|
+
#
|
4263
|
+
# resp = client.list_tenants({
|
4264
|
+
# next_token: "NextToken",
|
4265
|
+
# page_size: 1,
|
4266
|
+
# })
|
4267
|
+
#
|
4268
|
+
# @example Response structure
|
4269
|
+
#
|
4270
|
+
# resp.tenants #=> Array
|
4271
|
+
# resp.tenants[0].tenant_name #=> String
|
4272
|
+
# resp.tenants[0].tenant_id #=> String
|
4273
|
+
# resp.tenants[0].tenant_arn #=> String
|
4274
|
+
# resp.tenants[0].created_timestamp #=> Time
|
4275
|
+
# resp.next_token #=> String
|
4276
|
+
#
|
4277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListTenants AWS API Documentation
|
4278
|
+
#
|
4279
|
+
# @overload list_tenants(params = {})
|
4280
|
+
# @param [Hash] params ({})
|
4281
|
+
def list_tenants(params = {}, options = {})
|
4282
|
+
req = build_request(:list_tenants, params)
|
4283
|
+
req.send_request(options)
|
4284
|
+
end
|
4285
|
+
|
3811
4286
|
# Enable or disable the automatic warm-up feature for dedicated IP
|
3812
4287
|
# addresses.
|
3813
4288
|
#
|
@@ -4733,6 +5208,15 @@ module Aws::SESV2
|
|
4733
5208
|
# @option params [String] :endpoint_id
|
4734
5209
|
# The ID of the multi-region endpoint (global-endpoint).
|
4735
5210
|
#
|
5211
|
+
# @option params [String] :tenant_name
|
5212
|
+
# The name of the tenant through which this bulk email will be sent.
|
5213
|
+
#
|
5214
|
+
# <note markdown="1"> The email sending operation will only succeed if all referenced
|
5215
|
+
# resources (identities, configuration sets, and templates) are
|
5216
|
+
# associated with this tenant.
|
5217
|
+
#
|
5218
|
+
# </note>
|
5219
|
+
#
|
4736
5220
|
# @return [Types::SendBulkEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4737
5221
|
#
|
4738
5222
|
# * {Types::SendBulkEmailResponse#bulk_email_entry_results #bulk_email_entry_results} => Array<Types::BulkEmailEntryResult>
|
@@ -4808,6 +5292,7 @@ module Aws::SESV2
|
|
4808
5292
|
# ],
|
4809
5293
|
# configuration_set_name: "ConfigurationSetName",
|
4810
5294
|
# endpoint_id: "EndpointId",
|
5295
|
+
# tenant_name: "TenantName",
|
4811
5296
|
# })
|
4812
5297
|
#
|
4813
5298
|
# @example Response structure
|
@@ -4970,6 +5455,15 @@ module Aws::SESV2
|
|
4970
5455
|
# @option params [String] :endpoint_id
|
4971
5456
|
# The ID of the multi-region endpoint (global-endpoint).
|
4972
5457
|
#
|
5458
|
+
# @option params [String] :tenant_name
|
5459
|
+
# The name of the tenant through which this email will be sent.
|
5460
|
+
#
|
5461
|
+
# <note markdown="1"> The email sending operation will only succeed if all referenced
|
5462
|
+
# resources (identities, configuration sets, and templates) are
|
5463
|
+
# associated with this tenant.
|
5464
|
+
#
|
5465
|
+
# </note>
|
5466
|
+
#
|
4973
5467
|
# @option params [Types::ListManagementOptions] :list_management_options
|
4974
5468
|
# An object used to specify a list or topic to which an email belongs,
|
4975
5469
|
# which will be used when a contact chooses to unsubscribe.
|
@@ -5064,6 +5558,7 @@ module Aws::SESV2
|
|
5064
5558
|
# ],
|
5065
5559
|
# configuration_set_name: "ConfigurationSetName",
|
5066
5560
|
# endpoint_id: "EndpointId",
|
5561
|
+
# tenant_name: "TenantName",
|
5067
5562
|
# list_management_options: {
|
5068
5563
|
# contact_list_name: "ContactListName", # required
|
5069
5564
|
# topic_name: "TopicName",
|
@@ -5510,6 +6005,100 @@ module Aws::SESV2
|
|
5510
6005
|
req.send_request(options)
|
5511
6006
|
end
|
5512
6007
|
|
6008
|
+
# Update the customer-managed sending status for a reputation entity.
|
6009
|
+
# This allows you to enable, disable, or reinstate sending for the
|
6010
|
+
# entity.
|
6011
|
+
#
|
6012
|
+
# The customer-managed status works in conjunction with the Amazon Web
|
6013
|
+
# Services Amazon SES-managed status to determine the overall sending
|
6014
|
+
# capability. When you update the customer-managed status, the Amazon
|
6015
|
+
# Web Services Amazon SES-managed status remains unchanged. If Amazon
|
6016
|
+
# Web Services Amazon SES has disabled the entity, it will not be
|
6017
|
+
# allowed to send regardless of the customer-managed status setting.
|
6018
|
+
# When you reinstate an entity through the customer-managed status, it
|
6019
|
+
# can continue sending only if the Amazon Web Services Amazon
|
6020
|
+
# SES-managed status also permits sending, even if there are active
|
6021
|
+
# reputation findings, until the findings are resolved or new violations
|
6022
|
+
# occur.
|
6023
|
+
#
|
6024
|
+
# @option params [required, String] :reputation_entity_type
|
6025
|
+
# The type of reputation entity. Currently, only `RESOURCE` type
|
6026
|
+
# entities are supported.
|
6027
|
+
#
|
6028
|
+
# @option params [required, String] :reputation_entity_reference
|
6029
|
+
# The unique identifier for the reputation entity. For resource-type
|
6030
|
+
# entities, this is the Amazon Resource Name (ARN) of the resource.
|
6031
|
+
#
|
6032
|
+
# @option params [required, String] :sending_status
|
6033
|
+
# The new customer-managed sending status for the reputation entity.
|
6034
|
+
# This can be one of the following:
|
6035
|
+
#
|
6036
|
+
# * `ENABLED` – Allow sending for this entity.
|
6037
|
+
#
|
6038
|
+
# * `DISABLED` – Prevent sending for this entity.
|
6039
|
+
#
|
6040
|
+
# * `REINSTATED` – Allow sending even if there are active reputation
|
6041
|
+
# findings.
|
6042
|
+
#
|
6043
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6044
|
+
#
|
6045
|
+
# @example Request syntax with placeholder values
|
6046
|
+
#
|
6047
|
+
# resp = client.update_reputation_entity_customer_managed_status({
|
6048
|
+
# reputation_entity_type: "RESOURCE", # required, accepts RESOURCE
|
6049
|
+
# reputation_entity_reference: "ReputationEntityReference", # required
|
6050
|
+
# sending_status: "ENABLED", # required, accepts ENABLED, REINSTATED, DISABLED
|
6051
|
+
# })
|
6052
|
+
#
|
6053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateReputationEntityCustomerManagedStatus AWS API Documentation
|
6054
|
+
#
|
6055
|
+
# @overload update_reputation_entity_customer_managed_status(params = {})
|
6056
|
+
# @param [Hash] params ({})
|
6057
|
+
def update_reputation_entity_customer_managed_status(params = {}, options = {})
|
6058
|
+
req = build_request(:update_reputation_entity_customer_managed_status, params)
|
6059
|
+
req.send_request(options)
|
6060
|
+
end
|
6061
|
+
|
6062
|
+
# Update the reputation management policy for a reputation entity. The
|
6063
|
+
# policy determines how the entity responds to reputation findings, such
|
6064
|
+
# as automatically pausing sending when certain thresholds are exceeded.
|
6065
|
+
#
|
6066
|
+
# Reputation management policies are Amazon Web Services Amazon
|
6067
|
+
# SES-managed (predefined policies). You can select from none, standard,
|
6068
|
+
# and strict policies.
|
6069
|
+
#
|
6070
|
+
# @option params [required, String] :reputation_entity_type
|
6071
|
+
# The type of reputation entity. Currently, only `RESOURCE` type
|
6072
|
+
# entities are supported.
|
6073
|
+
#
|
6074
|
+
# @option params [required, String] :reputation_entity_reference
|
6075
|
+
# The unique identifier for the reputation entity. For resource-type
|
6076
|
+
# entities, this is the Amazon Resource Name (ARN) of the resource.
|
6077
|
+
#
|
6078
|
+
# @option params [required, String] :reputation_entity_policy
|
6079
|
+
# The Amazon Resource Name (ARN) of the reputation management policy to
|
6080
|
+
# apply to this entity. This is an Amazon Web Services Amazon
|
6081
|
+
# SES-managed policy.
|
6082
|
+
#
|
6083
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6084
|
+
#
|
6085
|
+
# @example Request syntax with placeholder values
|
6086
|
+
#
|
6087
|
+
# resp = client.update_reputation_entity_policy({
|
6088
|
+
# reputation_entity_type: "RESOURCE", # required, accepts RESOURCE
|
6089
|
+
# reputation_entity_reference: "ReputationEntityReference", # required
|
6090
|
+
# reputation_entity_policy: "AmazonResourceName", # required
|
6091
|
+
# })
|
6092
|
+
#
|
6093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateReputationEntityPolicy AWS API Documentation
|
6094
|
+
#
|
6095
|
+
# @overload update_reputation_entity_policy(params = {})
|
6096
|
+
# @param [Hash] params ({})
|
6097
|
+
def update_reputation_entity_policy(params = {}, options = {})
|
6098
|
+
req = build_request(:update_reputation_entity_policy, params)
|
6099
|
+
req.send_request(options)
|
6100
|
+
end
|
6101
|
+
|
5513
6102
|
# @!endgroup
|
5514
6103
|
|
5515
6104
|
# @param params ({})
|
@@ -5528,7 +6117,7 @@ module Aws::SESV2
|
|
5528
6117
|
tracer: tracer
|
5529
6118
|
)
|
5530
6119
|
context[:gem_name] = 'aws-sdk-sesv2'
|
5531
|
-
context[:gem_version] = '1.
|
6120
|
+
context[:gem_version] = '1.81.0'
|
5532
6121
|
Seahorse::Client::Request.new(handlers, context)
|
5533
6122
|
end
|
5534
6123
|
|