aws-sdk-notificationscontacts 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-notificationscontacts/client.rb +797 -0
- data/lib/aws-sdk-notificationscontacts/client_api.rb +326 -0
- data/lib/aws-sdk-notificationscontacts/customizations.rb +0 -0
- data/lib/aws-sdk-notificationscontacts/endpoint_parameters.rb +59 -0
- data/lib/aws-sdk-notificationscontacts/endpoint_provider.rb +35 -0
- data/lib/aws-sdk-notificationscontacts/endpoints.rb +20 -0
- data/lib/aws-sdk-notificationscontacts/errors.rb +227 -0
- data/lib/aws-sdk-notificationscontacts/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-notificationscontacts/resource.rb +26 -0
- data/lib/aws-sdk-notificationscontacts/types.rb +481 -0
- data/lib/aws-sdk-notificationscontacts/waiters.rb +15 -0
- data/lib/aws-sdk-notificationscontacts.rb +62 -0
- data/sig/client.rbs +172 -0
- data/sig/errors.rbs +50 -0
- data/sig/resource.rbs +82 -0
- data/sig/types.rbs +162 -0
- data/sig/waiters.rbs +13 -0
- metadata +100 -0
@@ -0,0 +1,797 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id.rb'
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
32
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
35
|
+
require 'aws-sdk-core/plugins/telemetry.rb'
|
36
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
37
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
38
|
+
|
39
|
+
module Aws::NotificationsContacts
|
40
|
+
# An API client for NotificationsContacts. To construct a client, you need to configure a `:region` and `:credentials`.
|
41
|
+
#
|
42
|
+
# client = Aws::NotificationsContacts::Client.new(
|
43
|
+
# region: region_name,
|
44
|
+
# credentials: credentials,
|
45
|
+
# # ...
|
46
|
+
# )
|
47
|
+
#
|
48
|
+
# For details on configuring region and credentials see
|
49
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
50
|
+
#
|
51
|
+
# See {#initialize} for a full list of supported configuration options.
|
52
|
+
class Client < Seahorse::Client::Base
|
53
|
+
|
54
|
+
include Aws::ClientStubs
|
55
|
+
|
56
|
+
@identifier = :notificationscontacts
|
57
|
+
|
58
|
+
set_api(ClientApi::API)
|
59
|
+
|
60
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
61
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
62
|
+
add_plugin(Aws::Plugins::Logging)
|
63
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
64
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
65
|
+
add_plugin(Aws::Plugins::UserAgent)
|
66
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
67
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
68
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
69
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
70
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
71
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
72
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
73
|
+
add_plugin(Aws::Plugins::StubResponses)
|
74
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
75
|
+
add_plugin(Aws::Plugins::InvocationId)
|
76
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
77
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
78
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
79
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
80
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
81
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
82
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
83
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
84
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
85
|
+
add_plugin(Aws::Plugins::Telemetry)
|
86
|
+
add_plugin(Aws::Plugins::Sign)
|
87
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
88
|
+
add_plugin(Aws::NotificationsContacts::Plugins::Endpoints)
|
89
|
+
|
90
|
+
# @overload initialize(options)
|
91
|
+
# @param [Hash] options
|
92
|
+
#
|
93
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
94
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
95
|
+
# class name or an instance of a plugin class.
|
96
|
+
#
|
97
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
98
|
+
# Your AWS credentials. This can be an instance of any one of the
|
99
|
+
# following classes:
|
100
|
+
#
|
101
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
102
|
+
# credentials.
|
103
|
+
#
|
104
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
105
|
+
# shared file, such as `~/.aws/config`.
|
106
|
+
#
|
107
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
108
|
+
#
|
109
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
110
|
+
# assume a role after providing credentials via the web.
|
111
|
+
#
|
112
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
113
|
+
# access token generated from `aws login`.
|
114
|
+
#
|
115
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
116
|
+
# process that outputs to stdout.
|
117
|
+
#
|
118
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
119
|
+
# from an EC2 IMDS on an EC2 instance.
|
120
|
+
#
|
121
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
122
|
+
# instances running in ECS.
|
123
|
+
#
|
124
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
125
|
+
# from the Cognito Identity service.
|
126
|
+
#
|
127
|
+
# When `:credentials` are not configured directly, the following
|
128
|
+
# locations will be searched for credentials:
|
129
|
+
#
|
130
|
+
# * `Aws.config[:credentials]`
|
131
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
132
|
+
# `:account_id` options.
|
133
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
|
134
|
+
# ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
|
135
|
+
# * `~/.aws/credentials`
|
136
|
+
# * `~/.aws/config`
|
137
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
138
|
+
# are very aggressive. Construct and pass an instance of
|
139
|
+
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
140
|
+
# enable retries and extended timeouts. Instance profile credential
|
141
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
142
|
+
# to true.
|
143
|
+
#
|
144
|
+
# @option options [required, String] :region
|
145
|
+
# The AWS region to connect to. The configured `:region` is
|
146
|
+
# used to determine the service `:endpoint`. When not passed,
|
147
|
+
# a default `:region` is searched for in the following locations:
|
148
|
+
#
|
149
|
+
# * `Aws.config[:region]`
|
150
|
+
# * `ENV['AWS_REGION']`
|
151
|
+
# * `ENV['AMAZON_REGION']`
|
152
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
153
|
+
# * `~/.aws/credentials`
|
154
|
+
# * `~/.aws/config`
|
155
|
+
#
|
156
|
+
# @option options [String] :access_key_id
|
157
|
+
#
|
158
|
+
# @option options [String] :account_id
|
159
|
+
#
|
160
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
161
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
162
|
+
# the background every 60 secs (default). Defaults to `false`.
|
163
|
+
#
|
164
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
165
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
166
|
+
# until there is sufficent client side capacity to retry the request.
|
167
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
168
|
+
# not retry instead of sleeping.
|
169
|
+
#
|
170
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
171
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
172
|
+
# this client.
|
173
|
+
#
|
174
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
175
|
+
# Allows you to provide an identifier for this client which will be attached to
|
176
|
+
# all generated client side metrics. Defaults to an empty string.
|
177
|
+
#
|
178
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
179
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
180
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
181
|
+
#
|
182
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
183
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
184
|
+
# agent is running on, where client metrics will be published via UDP.
|
185
|
+
#
|
186
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
187
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
188
|
+
# will use the Client Side Monitoring Agent Publisher.
|
189
|
+
#
|
190
|
+
# @option options [Boolean] :convert_params (true)
|
191
|
+
# When `true`, an attempt is made to coerce request parameters into
|
192
|
+
# the required types.
|
193
|
+
#
|
194
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
195
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
196
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
197
|
+
#
|
198
|
+
# @option options [String] :defaults_mode ("legacy")
|
199
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
200
|
+
# accepted modes and the configuration defaults that are included.
|
201
|
+
#
|
202
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
203
|
+
# Set to true to disable SDK automatically adding host prefix
|
204
|
+
# to default service endpoint when available.
|
205
|
+
#
|
206
|
+
# @option options [Boolean] :disable_request_compression (false)
|
207
|
+
# When set to 'true' the request body will not be compressed
|
208
|
+
# for supported operations.
|
209
|
+
#
|
210
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
211
|
+
# Normally you should not configure the `:endpoint` option
|
212
|
+
# directly. This is normally constructed from the `:region`
|
213
|
+
# option. Configuring `:endpoint` is normally reserved for
|
214
|
+
# connecting to test or custom endpoints. The endpoint should
|
215
|
+
# be a URI formatted like:
|
216
|
+
#
|
217
|
+
# 'http://example.com'
|
218
|
+
# 'https://example.com'
|
219
|
+
# 'http://example.com:123'
|
220
|
+
#
|
221
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
222
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
223
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
224
|
+
#
|
225
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
226
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
227
|
+
#
|
228
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
229
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
230
|
+
# Use this option to config the time interval in seconds for making
|
231
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
232
|
+
#
|
233
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
234
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
235
|
+
#
|
236
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
237
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
238
|
+
# variables and the shared configuration file.
|
239
|
+
#
|
240
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
241
|
+
# The log formatter.
|
242
|
+
#
|
243
|
+
# @option options [Symbol] :log_level (:info)
|
244
|
+
# The log level to send messages to the `:logger` at.
|
245
|
+
#
|
246
|
+
# @option options [Logger] :logger
|
247
|
+
# The Logger instance to send log messages to. If this option
|
248
|
+
# is not set, logging will be disabled.
|
249
|
+
#
|
250
|
+
# @option options [Integer] :max_attempts (3)
|
251
|
+
# An integer representing the maximum number attempts that will be made for
|
252
|
+
# a single request, including the initial attempt. For example,
|
253
|
+
# setting this value to 5 will result in a request being retried up to
|
254
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
255
|
+
#
|
256
|
+
# @option options [String] :profile ("default")
|
257
|
+
# Used when loading credentials from the shared credentials file
|
258
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
|
+
#
|
260
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
|
+
# The minimum size in bytes that triggers compression for request
|
262
|
+
# bodies. The value must be non-negative integer value between 0
|
263
|
+
# and 10485780 bytes inclusive.
|
264
|
+
#
|
265
|
+
# @option options [Proc] :retry_backoff
|
266
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
|
+
# This option is only used in the `legacy` retry mode.
|
268
|
+
#
|
269
|
+
# @option options [Float] :retry_base_delay (0.3)
|
270
|
+
# The base delay in seconds used by the default backoff function. This option
|
271
|
+
# is only used in the `legacy` retry mode.
|
272
|
+
#
|
273
|
+
# @option options [Symbol] :retry_jitter (:none)
|
274
|
+
# A delay randomiser function used by the default backoff function.
|
275
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
276
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
277
|
+
# in the `legacy` retry mode.
|
278
|
+
#
|
279
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
280
|
+
#
|
281
|
+
# @option options [Integer] :retry_limit (3)
|
282
|
+
# The maximum number of times to retry failed requests. Only
|
283
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
284
|
+
# are retried. Generally, these are throttling errors, data
|
285
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
286
|
+
# endpoint discovery, and errors from expired credentials.
|
287
|
+
# This option is only used in the `legacy` retry mode.
|
288
|
+
#
|
289
|
+
# @option options [Integer] :retry_max_delay (0)
|
290
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
291
|
+
# used by the default backoff function. This option is only used in the
|
292
|
+
# `legacy` retry mode.
|
293
|
+
#
|
294
|
+
# @option options [String] :retry_mode ("legacy")
|
295
|
+
# Specifies which retry algorithm to use. Values are:
|
296
|
+
#
|
297
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
298
|
+
# no retry mode is provided.
|
299
|
+
#
|
300
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
301
|
+
# This includes support for retry quotas, which limit the number of
|
302
|
+
# unsuccessful retries a client can make.
|
303
|
+
#
|
304
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
305
|
+
# functionality of `standard` mode along with automatic client side
|
306
|
+
# throttling. This is a provisional mode that may change behavior
|
307
|
+
# in the future.
|
308
|
+
#
|
309
|
+
# @option options [String] :sdk_ua_app_id
|
310
|
+
# A unique and opaque application ID that is appended to the
|
311
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
312
|
+
# maximum length of 50. This variable is sourced from environment
|
313
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
314
|
+
#
|
315
|
+
# @option options [String] :secret_access_key
|
316
|
+
#
|
317
|
+
# @option options [String] :session_token
|
318
|
+
#
|
319
|
+
# @option options [Array] :sigv4a_signing_region_set
|
320
|
+
# A list of regions that should be signed with SigV4a signing. When
|
321
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
322
|
+
# in the following locations:
|
323
|
+
#
|
324
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
325
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
326
|
+
# * `~/.aws/config`
|
327
|
+
#
|
328
|
+
# @option options [Boolean] :stub_responses (false)
|
329
|
+
# Causes the client to return stubbed responses. By default
|
330
|
+
# fake responses are generated and returned. You can specify
|
331
|
+
# the response data to return or errors to raise by calling
|
332
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
333
|
+
#
|
334
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
335
|
+
# requests are made, and retries are disabled.
|
336
|
+
#
|
337
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
338
|
+
# Allows you to provide a telemetry provider, which is used to
|
339
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
340
|
+
# will not record or emit any telemetry data. The SDK supports the
|
341
|
+
# following telemetry providers:
|
342
|
+
#
|
343
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
344
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
345
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
346
|
+
#
|
347
|
+
# @option options [Aws::TokenProvider] :token_provider
|
348
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
349
|
+
# following classes:
|
350
|
+
#
|
351
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
352
|
+
# tokens.
|
353
|
+
#
|
354
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
355
|
+
# access token generated from `aws login`.
|
356
|
+
#
|
357
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
358
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
359
|
+
#
|
360
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
361
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
362
|
+
# will be used if available.
|
363
|
+
#
|
364
|
+
# @option options [Boolean] :use_fips_endpoint
|
365
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
366
|
+
# When a `fips` region is used, the region is normalized and this config
|
367
|
+
# is set to `true`.
|
368
|
+
#
|
369
|
+
# @option options [Boolean] :validate_params (true)
|
370
|
+
# When `true`, request parameters are validated before
|
371
|
+
# sending the request.
|
372
|
+
#
|
373
|
+
# @option options [Aws::NotificationsContacts::EndpointProvider] :endpoint_provider
|
374
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
375
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
376
|
+
# `Aws::NotificationsContacts::EndpointParameters`.
|
377
|
+
#
|
378
|
+
# @option options [Float] :http_continue_timeout (1)
|
379
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
380
|
+
# request body. This option has no effect unless the request has "Expect"
|
381
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
382
|
+
# behaviour. This value can safely be set per request on the session.
|
383
|
+
#
|
384
|
+
# @option options [Float] :http_idle_timeout (5)
|
385
|
+
# The number of seconds a connection is allowed to sit idle before it
|
386
|
+
# is considered stale. Stale connections are closed and removed from the
|
387
|
+
# pool before making a request.
|
388
|
+
#
|
389
|
+
# @option options [Float] :http_open_timeout (15)
|
390
|
+
# The default number of seconds to wait for response data.
|
391
|
+
# This value can safely be set per-request on the session.
|
392
|
+
#
|
393
|
+
# @option options [URI::HTTP,String] :http_proxy
|
394
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
395
|
+
#
|
396
|
+
# @option options [Float] :http_read_timeout (60)
|
397
|
+
# The default number of seconds to wait for response data.
|
398
|
+
# This value can safely be set per-request on the session.
|
399
|
+
#
|
400
|
+
# @option options [Boolean] :http_wire_trace (false)
|
401
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
402
|
+
#
|
403
|
+
# @option options [Proc] :on_chunk_received
|
404
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
405
|
+
# of the response body is received. It provides three arguments: the chunk,
|
406
|
+
# the number of bytes received, and the total number of
|
407
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
408
|
+
#
|
409
|
+
# @option options [Proc] :on_chunk_sent
|
410
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
411
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
412
|
+
# the number of bytes read from the body, and the total number of
|
413
|
+
# bytes in the body.
|
414
|
+
#
|
415
|
+
# @option options [Boolean] :raise_response_errors (true)
|
416
|
+
# When `true`, response errors are raised.
|
417
|
+
#
|
418
|
+
# @option options [String] :ssl_ca_bundle
|
419
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
420
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
421
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
422
|
+
#
|
423
|
+
# @option options [String] :ssl_ca_directory
|
424
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
425
|
+
# authority files for verifying peer certificates. If you do
|
426
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
427
|
+
# default will be used if available.
|
428
|
+
#
|
429
|
+
# @option options [String] :ssl_ca_store
|
430
|
+
# Sets the X509::Store to verify peer certificate.
|
431
|
+
#
|
432
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
433
|
+
# Sets a client certificate when creating http connections.
|
434
|
+
#
|
435
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
436
|
+
# Sets a client key when creating http connections.
|
437
|
+
#
|
438
|
+
# @option options [Float] :ssl_timeout
|
439
|
+
# Sets the SSL timeout in seconds
|
440
|
+
#
|
441
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
442
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
443
|
+
#
|
444
|
+
def initialize(*args)
|
445
|
+
super
|
446
|
+
end
|
447
|
+
|
448
|
+
# @!group API Operations
|
449
|
+
|
450
|
+
# Activates an email contact using an activation code. This code is in
|
451
|
+
# the activation email sent to the email address associated with this
|
452
|
+
# email contact.
|
453
|
+
#
|
454
|
+
# @option params [required, String] :arn
|
455
|
+
# The Amazon Resource Name (ARN) of the resource.
|
456
|
+
#
|
457
|
+
# @option params [required, String] :code
|
458
|
+
# The activation code for this email contact.
|
459
|
+
#
|
460
|
+
# An email contact has a maximum of five activation attempts. Activation
|
461
|
+
# codes expire after 12 hours and are generated by the
|
462
|
+
# [SendActivationCode][1] API action.
|
463
|
+
#
|
464
|
+
#
|
465
|
+
#
|
466
|
+
# [1]: https://docs.aws.amazon.com/notificationscontacts/latest/APIReference/API_SendActivationCode.html
|
467
|
+
#
|
468
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
469
|
+
#
|
470
|
+
# @example Request syntax with placeholder values
|
471
|
+
#
|
472
|
+
# resp = client.activate_email_contact({
|
473
|
+
# arn: "EmailContactArn", # required
|
474
|
+
# code: "Token", # required
|
475
|
+
# })
|
476
|
+
#
|
477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notificationscontacts-2018-05-10/ActivateEmailContact AWS API Documentation
|
478
|
+
#
|
479
|
+
# @overload activate_email_contact(params = {})
|
480
|
+
# @param [Hash] params ({})
|
481
|
+
def activate_email_contact(params = {}, options = {})
|
482
|
+
req = build_request(:activate_email_contact, params)
|
483
|
+
req.send_request(options)
|
484
|
+
end
|
485
|
+
|
486
|
+
# Creates an email contact for the provided email address.
|
487
|
+
#
|
488
|
+
# @option params [required, String] :name
|
489
|
+
# The name of the email contact.
|
490
|
+
#
|
491
|
+
# @option params [required, String] :email_address
|
492
|
+
# The email address this email contact points to. The activation email
|
493
|
+
# and any subscribed emails are sent here.
|
494
|
+
#
|
495
|
+
# <note markdown="1"> This email address can't receive emails until it's activated.
|
496
|
+
#
|
497
|
+
# </note>
|
498
|
+
#
|
499
|
+
# @option params [Hash<String,String>] :tags
|
500
|
+
# A map of tags assigned to a resource. A tag is a string-to-string map
|
501
|
+
# of key-value pairs.
|
502
|
+
#
|
503
|
+
# @return [Types::CreateEmailContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
504
|
+
#
|
505
|
+
# * {Types::CreateEmailContactResponse#arn #arn} => String
|
506
|
+
#
|
507
|
+
# @example Request syntax with placeholder values
|
508
|
+
#
|
509
|
+
# resp = client.create_email_contact({
|
510
|
+
# name: "EmailContactName", # required
|
511
|
+
# email_address: "EmailContactAddress", # required
|
512
|
+
# tags: {
|
513
|
+
# "TagKey" => "TagValue",
|
514
|
+
# },
|
515
|
+
# })
|
516
|
+
#
|
517
|
+
# @example Response structure
|
518
|
+
#
|
519
|
+
# resp.arn #=> String
|
520
|
+
#
|
521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notificationscontacts-2018-05-10/CreateEmailContact AWS API Documentation
|
522
|
+
#
|
523
|
+
# @overload create_email_contact(params = {})
|
524
|
+
# @param [Hash] params ({})
|
525
|
+
def create_email_contact(params = {}, options = {})
|
526
|
+
req = build_request(:create_email_contact, params)
|
527
|
+
req.send_request(options)
|
528
|
+
end
|
529
|
+
|
530
|
+
# Deletes an email contact.
|
531
|
+
#
|
532
|
+
# <note markdown="1"> Deleting an email contact removes it from all associated notification
|
533
|
+
# configurations.
|
534
|
+
#
|
535
|
+
# </note>
|
536
|
+
#
|
537
|
+
# @option params [required, String] :arn
|
538
|
+
# The Amazon Resource Name (ARN) of the resource.
|
539
|
+
#
|
540
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
541
|
+
#
|
542
|
+
# @example Request syntax with placeholder values
|
543
|
+
#
|
544
|
+
# resp = client.delete_email_contact({
|
545
|
+
# arn: "EmailContactArn", # required
|
546
|
+
# })
|
547
|
+
#
|
548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notificationscontacts-2018-05-10/DeleteEmailContact AWS API Documentation
|
549
|
+
#
|
550
|
+
# @overload delete_email_contact(params = {})
|
551
|
+
# @param [Hash] params ({})
|
552
|
+
def delete_email_contact(params = {}, options = {})
|
553
|
+
req = build_request(:delete_email_contact, params)
|
554
|
+
req.send_request(options)
|
555
|
+
end
|
556
|
+
|
557
|
+
# Returns an email contact.
|
558
|
+
#
|
559
|
+
# @option params [required, String] :arn
|
560
|
+
# The Amazon Resource Name (ARN) of the email contact to get.
|
561
|
+
#
|
562
|
+
# @return [Types::GetEmailContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
563
|
+
#
|
564
|
+
# * {Types::GetEmailContactResponse#email_contact #email_contact} => Types::EmailContact
|
565
|
+
#
|
566
|
+
# @example Request syntax with placeholder values
|
567
|
+
#
|
568
|
+
# resp = client.get_email_contact({
|
569
|
+
# arn: "EmailContactArn", # required
|
570
|
+
# })
|
571
|
+
#
|
572
|
+
# @example Response structure
|
573
|
+
#
|
574
|
+
# resp.email_contact.arn #=> String
|
575
|
+
# resp.email_contact.name #=> String
|
576
|
+
# resp.email_contact.address #=> String
|
577
|
+
# resp.email_contact.status #=> String, one of "inactive", "active"
|
578
|
+
# resp.email_contact.creation_time #=> Time
|
579
|
+
# resp.email_contact.update_time #=> Time
|
580
|
+
#
|
581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notificationscontacts-2018-05-10/GetEmailContact AWS API Documentation
|
582
|
+
#
|
583
|
+
# @overload get_email_contact(params = {})
|
584
|
+
# @param [Hash] params ({})
|
585
|
+
def get_email_contact(params = {}, options = {})
|
586
|
+
req = build_request(:get_email_contact, params)
|
587
|
+
req.send_request(options)
|
588
|
+
end
|
589
|
+
|
590
|
+
# Lists all email contacts created under the Account.
|
591
|
+
#
|
592
|
+
# @option params [Integer] :max_results
|
593
|
+
# The maximum number of results to include in the response. If more
|
594
|
+
# results exist than the specified MaxResults value, a token is included
|
595
|
+
# in the response so that the remaining results can be retrieved.
|
596
|
+
#
|
597
|
+
# @option params [String] :next_token
|
598
|
+
# An optional token returned from a prior request. Use this token for
|
599
|
+
# pagination of results from this action. If this parameter is
|
600
|
+
# specified, the response includes only results beyond the token, up to
|
601
|
+
# the value specified by MaxResults.
|
602
|
+
#
|
603
|
+
# @return [Types::ListEmailContactsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
604
|
+
#
|
605
|
+
# * {Types::ListEmailContactsResponse#next_token #next_token} => String
|
606
|
+
# * {Types::ListEmailContactsResponse#email_contacts #email_contacts} => Array<Types::EmailContact>
|
607
|
+
#
|
608
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
609
|
+
#
|
610
|
+
# @example Request syntax with placeholder values
|
611
|
+
#
|
612
|
+
# resp = client.list_email_contacts({
|
613
|
+
# max_results: 1,
|
614
|
+
# next_token: "String",
|
615
|
+
# })
|
616
|
+
#
|
617
|
+
# @example Response structure
|
618
|
+
#
|
619
|
+
# resp.next_token #=> String
|
620
|
+
# resp.email_contacts #=> Array
|
621
|
+
# resp.email_contacts[0].arn #=> String
|
622
|
+
# resp.email_contacts[0].name #=> String
|
623
|
+
# resp.email_contacts[0].address #=> String
|
624
|
+
# resp.email_contacts[0].status #=> String, one of "inactive", "active"
|
625
|
+
# resp.email_contacts[0].creation_time #=> Time
|
626
|
+
# resp.email_contacts[0].update_time #=> Time
|
627
|
+
#
|
628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notificationscontacts-2018-05-10/ListEmailContacts AWS API Documentation
|
629
|
+
#
|
630
|
+
# @overload list_email_contacts(params = {})
|
631
|
+
# @param [Hash] params ({})
|
632
|
+
def list_email_contacts(params = {}, options = {})
|
633
|
+
req = build_request(:list_email_contacts, params)
|
634
|
+
req.send_request(options)
|
635
|
+
end
|
636
|
+
|
637
|
+
# Lists all of the tags associated with the Amazon Resource Name (ARN)
|
638
|
+
# that you specify. The resource can be a user, server, or role.
|
639
|
+
#
|
640
|
+
# @option params [required, String] :arn
|
641
|
+
# The ARN you specified to list the tags of.
|
642
|
+
#
|
643
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
644
|
+
#
|
645
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
646
|
+
#
|
647
|
+
# @example Request syntax with placeholder values
|
648
|
+
#
|
649
|
+
# resp = client.list_tags_for_resource({
|
650
|
+
# arn: "EmailContactArn", # required
|
651
|
+
# })
|
652
|
+
#
|
653
|
+
# @example Response structure
|
654
|
+
#
|
655
|
+
# resp.tags #=> Hash
|
656
|
+
# resp.tags["TagKey"] #=> String
|
657
|
+
#
|
658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notificationscontacts-2018-05-10/ListTagsForResource AWS API Documentation
|
659
|
+
#
|
660
|
+
# @overload list_tags_for_resource(params = {})
|
661
|
+
# @param [Hash] params ({})
|
662
|
+
def list_tags_for_resource(params = {}, options = {})
|
663
|
+
req = build_request(:list_tags_for_resource, params)
|
664
|
+
req.send_request(options)
|
665
|
+
end
|
666
|
+
|
667
|
+
# Sends an activation email to the email address associated with the
|
668
|
+
# specified email contact.
|
669
|
+
#
|
670
|
+
# <note markdown="1"> It might take a few minutes for the activation email to arrive. If it
|
671
|
+
# doesn't arrive, check in your spam folder or try sending another
|
672
|
+
# activation email.
|
673
|
+
#
|
674
|
+
# </note>
|
675
|
+
#
|
676
|
+
# @option params [required, String] :arn
|
677
|
+
# The Amazon Resource Name (ARN) of the resource.
|
678
|
+
#
|
679
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
680
|
+
#
|
681
|
+
# @example Request syntax with placeholder values
|
682
|
+
#
|
683
|
+
# resp = client.send_activation_code({
|
684
|
+
# arn: "EmailContactArn", # required
|
685
|
+
# })
|
686
|
+
#
|
687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notificationscontacts-2018-05-10/SendActivationCode AWS API Documentation
|
688
|
+
#
|
689
|
+
# @overload send_activation_code(params = {})
|
690
|
+
# @param [Hash] params ({})
|
691
|
+
def send_activation_code(params = {}, options = {})
|
692
|
+
req = build_request(:send_activation_code, params)
|
693
|
+
req.send_request(options)
|
694
|
+
end
|
695
|
+
|
696
|
+
# Attaches a key-value pair to a resource, as identified by its Amazon
|
697
|
+
# Resource Name (ARN). Taggable resources in AWS User Notifications
|
698
|
+
# Contacts include email contacts.
|
699
|
+
#
|
700
|
+
# @option params [required, String] :arn
|
701
|
+
# The ARN of the configuration.
|
702
|
+
#
|
703
|
+
# @option params [required, Hash<String,String>] :tags
|
704
|
+
# A list of tags to apply to the configuration.
|
705
|
+
#
|
706
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
707
|
+
#
|
708
|
+
# @example Request syntax with placeholder values
|
709
|
+
#
|
710
|
+
# resp = client.tag_resource({
|
711
|
+
# arn: "EmailContactArn", # required
|
712
|
+
# tags: { # required
|
713
|
+
# "TagKey" => "TagValue",
|
714
|
+
# },
|
715
|
+
# })
|
716
|
+
#
|
717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notificationscontacts-2018-05-10/TagResource AWS API Documentation
|
718
|
+
#
|
719
|
+
# @overload tag_resource(params = {})
|
720
|
+
# @param [Hash] params ({})
|
721
|
+
def tag_resource(params = {}, options = {})
|
722
|
+
req = build_request(:tag_resource, params)
|
723
|
+
req.send_request(options)
|
724
|
+
end
|
725
|
+
|
726
|
+
# Detaches a key-value pair from a resource, as identified by its Amazon
|
727
|
+
# Resource Name (ARN). Taggable resources in AWS User Notifications
|
728
|
+
# Contacts include email contacts..
|
729
|
+
#
|
730
|
+
# @option params [required, String] :arn
|
731
|
+
# The value of the resource that will have the tag removed. An Amazon
|
732
|
+
# Resource Name (ARN) is an identifier for a specific AWS resource, such
|
733
|
+
# as a server, user, or role.
|
734
|
+
#
|
735
|
+
# @option params [required, Array<String>] :tag_keys
|
736
|
+
# Specifies a list of tag keys that you want to remove from the
|
737
|
+
# specified resources.
|
738
|
+
#
|
739
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
740
|
+
#
|
741
|
+
# @example Request syntax with placeholder values
|
742
|
+
#
|
743
|
+
# resp = client.untag_resource({
|
744
|
+
# arn: "EmailContactArn", # required
|
745
|
+
# tag_keys: ["TagKey"], # required
|
746
|
+
# })
|
747
|
+
#
|
748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notificationscontacts-2018-05-10/UntagResource AWS API Documentation
|
749
|
+
#
|
750
|
+
# @overload untag_resource(params = {})
|
751
|
+
# @param [Hash] params ({})
|
752
|
+
def untag_resource(params = {}, options = {})
|
753
|
+
req = build_request(:untag_resource, params)
|
754
|
+
req.send_request(options)
|
755
|
+
end
|
756
|
+
|
757
|
+
# @!endgroup
|
758
|
+
|
759
|
+
# @param params ({})
|
760
|
+
# @api private
|
761
|
+
def build_request(operation_name, params = {})
|
762
|
+
handlers = @handlers.for(operation_name)
|
763
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
764
|
+
Aws::Telemetry.module_to_tracer_name('Aws::NotificationsContacts')
|
765
|
+
)
|
766
|
+
context = Seahorse::Client::RequestContext.new(
|
767
|
+
operation_name: operation_name,
|
768
|
+
operation: config.api.operation(operation_name),
|
769
|
+
client: self,
|
770
|
+
params: params,
|
771
|
+
config: config,
|
772
|
+
tracer: tracer
|
773
|
+
)
|
774
|
+
context[:gem_name] = 'aws-sdk-notificationscontacts'
|
775
|
+
context[:gem_version] = '1.0.0'
|
776
|
+
Seahorse::Client::Request.new(handlers, context)
|
777
|
+
end
|
778
|
+
|
779
|
+
# @api private
|
780
|
+
# @deprecated
|
781
|
+
def waiter_names
|
782
|
+
[]
|
783
|
+
end
|
784
|
+
|
785
|
+
class << self
|
786
|
+
|
787
|
+
# @api private
|
788
|
+
attr_reader :identifier
|
789
|
+
|
790
|
+
# @api private
|
791
|
+
def errors_module
|
792
|
+
Errors
|
793
|
+
end
|
794
|
+
|
795
|
+
end
|
796
|
+
end
|
797
|
+
end
|