aws-sdk-notifications 1.0.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 +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-notifications/client.rb +1562 -0
- data/lib/aws-sdk-notifications/client_api.rb +861 -0
- data/lib/aws-sdk-notifications/customizations.rb +0 -0
- data/lib/aws-sdk-notifications/endpoint_parameters.rb +59 -0
- data/lib/aws-sdk-notifications/endpoint_provider.rb +35 -0
- data/lib/aws-sdk-notifications/endpoints.rb +20 -0
- data/lib/aws-sdk-notifications/errors.rb +217 -0
- data/lib/aws-sdk-notifications/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-notifications/resource.rb +26 -0
- data/lib/aws-sdk-notifications/types.rb +2075 -0
- data/lib/aws-sdk-notifications/waiters.rb +15 -0
- data/lib/aws-sdk-notifications.rb +62 -0
- data/sig/client.rbs +347 -0
- data/sig/errors.rbs +48 -0
- data/sig/resource.rbs +82 -0
- data/sig/types.rbs +467 -0
- data/sig/waiters.rbs +13 -0
- metadata +100 -0
@@ -0,0 +1,1562 @@
|
|
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::Notifications
|
40
|
+
# An API client for Notifications. To construct a client, you need to configure a `:region` and `:credentials`.
|
41
|
+
#
|
42
|
+
# client = Aws::Notifications::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 = :notifications
|
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::Notifications::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::Notifications::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::Notifications::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
|
+
# Associates a delivery [Channel][1] with a particular
|
451
|
+
# NotificationConfiguration. Supported Channels include AWS Chatbot, the
|
452
|
+
# AWS Console Mobile Application, and emails (notifications-contacts).
|
453
|
+
#
|
454
|
+
#
|
455
|
+
#
|
456
|
+
# [1]: https://docs.aws.amazon.com/notifications/latest/userguide/managing-delivery-channels.html
|
457
|
+
#
|
458
|
+
# @option params [required, String] :arn
|
459
|
+
# The Amazon Resource Name (ARN) of the Channel to associate with the
|
460
|
+
# NotificationConfiguration.
|
461
|
+
#
|
462
|
+
# Supported ARNs include AWS Chatbot, the Console Mobile Application,
|
463
|
+
# and notifications-contacts.
|
464
|
+
#
|
465
|
+
# @option params [required, String] :notification_configuration_arn
|
466
|
+
# The ARN of the NotificationConfiguration to associate with the
|
467
|
+
# Channel.
|
468
|
+
#
|
469
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
470
|
+
#
|
471
|
+
# @example Request syntax with placeholder values
|
472
|
+
#
|
473
|
+
# resp = client.associate_channel({
|
474
|
+
# arn: "ChannelArn", # required
|
475
|
+
# notification_configuration_arn: "NotificationConfigurationArn", # required
|
476
|
+
# })
|
477
|
+
#
|
478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AssociateChannel AWS API Documentation
|
479
|
+
#
|
480
|
+
# @overload associate_channel(params = {})
|
481
|
+
# @param [Hash] params ({})
|
482
|
+
def associate_channel(params = {}, options = {})
|
483
|
+
req = build_request(:associate_channel, params)
|
484
|
+
req.send_request(options)
|
485
|
+
end
|
486
|
+
|
487
|
+
# Creates an [EventRule][1] that is associated with a specified
|
488
|
+
# Notification Configuration.
|
489
|
+
#
|
490
|
+
#
|
491
|
+
#
|
492
|
+
# [1]: https://docs.aws.amazon.com/notifications/latest/userguide/glossary.html
|
493
|
+
#
|
494
|
+
# @option params [required, String] :notification_configuration_arn
|
495
|
+
# The Amazon Resource Name (ARN) of the NotificationConfiguration
|
496
|
+
# associated with this EventRule.
|
497
|
+
#
|
498
|
+
# @option params [required, String] :source
|
499
|
+
# The matched event source.
|
500
|
+
#
|
501
|
+
# Must match one of the valid EventBridge sources. Only AWS service
|
502
|
+
# sourced events are supported. For example, `aws.ec2` and
|
503
|
+
# `aws.cloudwatch`. For more information, see [Event delivery from AWS
|
504
|
+
# services][1] in the *Amazon EventBridge User Guide*.
|
505
|
+
#
|
506
|
+
#
|
507
|
+
#
|
508
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
|
509
|
+
#
|
510
|
+
# @option params [required, String] :event_type
|
511
|
+
# The event type to match.
|
512
|
+
#
|
513
|
+
# Must match one of the valid Amazon EventBridge event types. For
|
514
|
+
# example, EC2 Instance State-change Notification and AWS CloudWatch
|
515
|
+
# Alarm State Change. For more information, see [Event delivery from AWS
|
516
|
+
# services][1] in the *Amazon EventBridge User Guide*.
|
517
|
+
#
|
518
|
+
#
|
519
|
+
#
|
520
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
|
521
|
+
#
|
522
|
+
# @option params [String] :event_pattern
|
523
|
+
# An additional event pattern used to further filter the events this
|
524
|
+
# EventRule receives.
|
525
|
+
#
|
526
|
+
# For more information, see [Amazon EventBridge event patterns][1] in
|
527
|
+
# the *Amazon EventBridge User Guide.*
|
528
|
+
#
|
529
|
+
#
|
530
|
+
#
|
531
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
|
532
|
+
#
|
533
|
+
# @option params [required, Array<String>] :regions
|
534
|
+
# A list of AWS Regions that send events to this EventRule.
|
535
|
+
#
|
536
|
+
# @return [Types::CreateEventRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
537
|
+
#
|
538
|
+
# * {Types::CreateEventRuleResponse#arn #arn} => String
|
539
|
+
# * {Types::CreateEventRuleResponse#notification_configuration_arn #notification_configuration_arn} => String
|
540
|
+
# * {Types::CreateEventRuleResponse#status_summary_by_region #status_summary_by_region} => Hash<String,Types::EventRuleStatusSummary>
|
541
|
+
#
|
542
|
+
# @example Request syntax with placeholder values
|
543
|
+
#
|
544
|
+
# resp = client.create_event_rule({
|
545
|
+
# notification_configuration_arn: "NotificationConfigurationArn", # required
|
546
|
+
# source: "Source", # required
|
547
|
+
# event_type: "EventType", # required
|
548
|
+
# event_pattern: "EventRuleEventPattern",
|
549
|
+
# regions: ["Region"], # required
|
550
|
+
# })
|
551
|
+
#
|
552
|
+
# @example Response structure
|
553
|
+
#
|
554
|
+
# resp.arn #=> String
|
555
|
+
# resp.notification_configuration_arn #=> String
|
556
|
+
# resp.status_summary_by_region #=> Hash
|
557
|
+
# resp.status_summary_by_region["Region"].status #=> String, one of "ACTIVE", "INACTIVE", "CREATING", "UPDATING", "DELETING"
|
558
|
+
# resp.status_summary_by_region["Region"].reason #=> String
|
559
|
+
#
|
560
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/CreateEventRule AWS API Documentation
|
561
|
+
#
|
562
|
+
# @overload create_event_rule(params = {})
|
563
|
+
# @param [Hash] params ({})
|
564
|
+
def create_event_rule(params = {}, options = {})
|
565
|
+
req = build_request(:create_event_rule, params)
|
566
|
+
req.send_request(options)
|
567
|
+
end
|
568
|
+
|
569
|
+
# Creates a new NotificationConfiguration.
|
570
|
+
#
|
571
|
+
# @option params [required, String] :name
|
572
|
+
# The name of the NotificationConfiguration. Supports RFC 3986's
|
573
|
+
# unreserved characters.
|
574
|
+
#
|
575
|
+
# @option params [required, String] :description
|
576
|
+
# The description of the NotificationConfiguration.
|
577
|
+
#
|
578
|
+
# @option params [String] :aggregation_duration
|
579
|
+
# The aggregation preference of the NotificationConfiguration.
|
580
|
+
#
|
581
|
+
# * Values:
|
582
|
+
#
|
583
|
+
# * `LONG`
|
584
|
+
#
|
585
|
+
# * Aggregate notifications for long periods of time (12 hours).
|
586
|
+
#
|
587
|
+
# ^
|
588
|
+
# * `SHORT`
|
589
|
+
#
|
590
|
+
# * Aggregate notifications for short periods of time (5 minutes).
|
591
|
+
#
|
592
|
+
# ^
|
593
|
+
# * `NONE`
|
594
|
+
#
|
595
|
+
# * Don't aggregate notifications.
|
596
|
+
#
|
597
|
+
# No delay in delivery.
|
598
|
+
#
|
599
|
+
# @option params [Hash<String,String>] :tags
|
600
|
+
# A map of tags assigned to a resource. A tag is a string-to-string map
|
601
|
+
# of key-value pairs.
|
602
|
+
#
|
603
|
+
# @return [Types::CreateNotificationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
604
|
+
#
|
605
|
+
# * {Types::CreateNotificationConfigurationResponse#arn #arn} => String
|
606
|
+
# * {Types::CreateNotificationConfigurationResponse#status #status} => String
|
607
|
+
#
|
608
|
+
# @example Request syntax with placeholder values
|
609
|
+
#
|
610
|
+
# resp = client.create_notification_configuration({
|
611
|
+
# name: "NotificationConfigurationName", # required
|
612
|
+
# description: "NotificationConfigurationDescription", # required
|
613
|
+
# aggregation_duration: "LONG", # accepts LONG, SHORT, NONE
|
614
|
+
# tags: {
|
615
|
+
# "TagKey" => "TagValue",
|
616
|
+
# },
|
617
|
+
# })
|
618
|
+
#
|
619
|
+
# @example Response structure
|
620
|
+
#
|
621
|
+
# resp.arn #=> String
|
622
|
+
# resp.status #=> String, one of "ACTIVE", "PARTIALLY_ACTIVE", "INACTIVE", "DELETING"
|
623
|
+
#
|
624
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/CreateNotificationConfiguration AWS API Documentation
|
625
|
+
#
|
626
|
+
# @overload create_notification_configuration(params = {})
|
627
|
+
# @param [Hash] params ({})
|
628
|
+
def create_notification_configuration(params = {}, options = {})
|
629
|
+
req = build_request(:create_notification_configuration, params)
|
630
|
+
req.send_request(options)
|
631
|
+
end
|
632
|
+
|
633
|
+
# Deletes an EventRule.
|
634
|
+
#
|
635
|
+
# @option params [required, String] :arn
|
636
|
+
# The Amazon Resource Name (ARN) of the EventRule to delete.
|
637
|
+
#
|
638
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
639
|
+
#
|
640
|
+
# @example Request syntax with placeholder values
|
641
|
+
#
|
642
|
+
# resp = client.delete_event_rule({
|
643
|
+
# arn: "EventRuleArn", # required
|
644
|
+
# })
|
645
|
+
#
|
646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeleteEventRule AWS API Documentation
|
647
|
+
#
|
648
|
+
# @overload delete_event_rule(params = {})
|
649
|
+
# @param [Hash] params ({})
|
650
|
+
def delete_event_rule(params = {}, options = {})
|
651
|
+
req = build_request(:delete_event_rule, params)
|
652
|
+
req.send_request(options)
|
653
|
+
end
|
654
|
+
|
655
|
+
# Deletes a NotificationConfiguration.
|
656
|
+
#
|
657
|
+
# @option params [required, String] :arn
|
658
|
+
# The Amazon Resource Name (ARN) of the NotificationConfiguration to
|
659
|
+
# delete.
|
660
|
+
#
|
661
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
662
|
+
#
|
663
|
+
# @example Request syntax with placeholder values
|
664
|
+
#
|
665
|
+
# resp = client.delete_notification_configuration({
|
666
|
+
# arn: "NotificationConfigurationArn", # required
|
667
|
+
# })
|
668
|
+
#
|
669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeleteNotificationConfiguration AWS API Documentation
|
670
|
+
#
|
671
|
+
# @overload delete_notification_configuration(params = {})
|
672
|
+
# @param [Hash] params ({})
|
673
|
+
def delete_notification_configuration(params = {}, options = {})
|
674
|
+
req = build_request(:delete_notification_configuration, params)
|
675
|
+
req.send_request(options)
|
676
|
+
end
|
677
|
+
|
678
|
+
# Deregisters a NotificationHub in the specified Region.
|
679
|
+
#
|
680
|
+
# <note markdown="1"> You can't deregister the last NotificationHub in the account.
|
681
|
+
# NotificationEvents stored in the deregistered NotificationHub are no
|
682
|
+
# longer be visible. Recreating a new NotificationHub in the same Region
|
683
|
+
# restores access to those NotificationEvents.
|
684
|
+
#
|
685
|
+
# </note>
|
686
|
+
#
|
687
|
+
# @option params [required, String] :notification_hub_region
|
688
|
+
# The NotificationHub Region.
|
689
|
+
#
|
690
|
+
# @return [Types::DeregisterNotificationHubResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
691
|
+
#
|
692
|
+
# * {Types::DeregisterNotificationHubResponse#notification_hub_region #notification_hub_region} => String
|
693
|
+
# * {Types::DeregisterNotificationHubResponse#status_summary #status_summary} => Types::NotificationHubStatusSummary
|
694
|
+
#
|
695
|
+
# @example Request syntax with placeholder values
|
696
|
+
#
|
697
|
+
# resp = client.deregister_notification_hub({
|
698
|
+
# notification_hub_region: "Region", # required
|
699
|
+
# })
|
700
|
+
#
|
701
|
+
# @example Response structure
|
702
|
+
#
|
703
|
+
# resp.notification_hub_region #=> String
|
704
|
+
# resp.status_summary.status #=> String, one of "ACTIVE", "REGISTERING", "DEREGISTERING", "INACTIVE"
|
705
|
+
# resp.status_summary.reason #=> String
|
706
|
+
#
|
707
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeregisterNotificationHub AWS API Documentation
|
708
|
+
#
|
709
|
+
# @overload deregister_notification_hub(params = {})
|
710
|
+
# @param [Hash] params ({})
|
711
|
+
def deregister_notification_hub(params = {}, options = {})
|
712
|
+
req = build_request(:deregister_notification_hub, params)
|
713
|
+
req.send_request(options)
|
714
|
+
end
|
715
|
+
|
716
|
+
# Disassociates a Channel from a specified NotificationConfiguration.
|
717
|
+
# Supported Channels include AWS Chatbot, the AWS Console Mobile
|
718
|
+
# Application, and emails (notifications-contacts).
|
719
|
+
#
|
720
|
+
# @option params [required, String] :arn
|
721
|
+
# The Amazon Resource Name (ARN) of the Channel to disassociate.
|
722
|
+
#
|
723
|
+
# @option params [required, String] :notification_configuration_arn
|
724
|
+
# The ARN of the NotificationConfiguration to disassociate.
|
725
|
+
#
|
726
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
727
|
+
#
|
728
|
+
# @example Request syntax with placeholder values
|
729
|
+
#
|
730
|
+
# resp = client.disassociate_channel({
|
731
|
+
# arn: "ChannelArn", # required
|
732
|
+
# notification_configuration_arn: "NotificationConfigurationArn", # required
|
733
|
+
# })
|
734
|
+
#
|
735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisassociateChannel AWS API Documentation
|
736
|
+
#
|
737
|
+
# @overload disassociate_channel(params = {})
|
738
|
+
# @param [Hash] params ({})
|
739
|
+
def disassociate_channel(params = {}, options = {})
|
740
|
+
req = build_request(:disassociate_channel, params)
|
741
|
+
req.send_request(options)
|
742
|
+
end
|
743
|
+
|
744
|
+
# Returns a specified EventRule.
|
745
|
+
#
|
746
|
+
# @option params [required, String] :arn
|
747
|
+
# The Amazon Resource Name (ARN) of the EventRule to return.
|
748
|
+
#
|
749
|
+
# @return [Types::GetEventRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
750
|
+
#
|
751
|
+
# * {Types::GetEventRuleResponse#arn #arn} => String
|
752
|
+
# * {Types::GetEventRuleResponse#notification_configuration_arn #notification_configuration_arn} => String
|
753
|
+
# * {Types::GetEventRuleResponse#creation_time #creation_time} => Time
|
754
|
+
# * {Types::GetEventRuleResponse#source #source} => String
|
755
|
+
# * {Types::GetEventRuleResponse#event_type #event_type} => String
|
756
|
+
# * {Types::GetEventRuleResponse#event_pattern #event_pattern} => String
|
757
|
+
# * {Types::GetEventRuleResponse#regions #regions} => Array<String>
|
758
|
+
# * {Types::GetEventRuleResponse#managed_rules #managed_rules} => Array<String>
|
759
|
+
# * {Types::GetEventRuleResponse#status_summary_by_region #status_summary_by_region} => Hash<String,Types::EventRuleStatusSummary>
|
760
|
+
#
|
761
|
+
# @example Request syntax with placeholder values
|
762
|
+
#
|
763
|
+
# resp = client.get_event_rule({
|
764
|
+
# arn: "EventRuleArn", # required
|
765
|
+
# })
|
766
|
+
#
|
767
|
+
# @example Response structure
|
768
|
+
#
|
769
|
+
# resp.arn #=> String
|
770
|
+
# resp.notification_configuration_arn #=> String
|
771
|
+
# resp.creation_time #=> Time
|
772
|
+
# resp.source #=> String
|
773
|
+
# resp.event_type #=> String
|
774
|
+
# resp.event_pattern #=> String
|
775
|
+
# resp.regions #=> Array
|
776
|
+
# resp.regions[0] #=> String
|
777
|
+
# resp.managed_rules #=> Array
|
778
|
+
# resp.managed_rules[0] #=> String
|
779
|
+
# resp.status_summary_by_region #=> Hash
|
780
|
+
# resp.status_summary_by_region["Region"].status #=> String, one of "ACTIVE", "INACTIVE", "CREATING", "UPDATING", "DELETING"
|
781
|
+
# resp.status_summary_by_region["Region"].reason #=> String
|
782
|
+
#
|
783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetEventRule AWS API Documentation
|
784
|
+
#
|
785
|
+
# @overload get_event_rule(params = {})
|
786
|
+
# @param [Hash] params ({})
|
787
|
+
def get_event_rule(params = {}, options = {})
|
788
|
+
req = build_request(:get_event_rule, params)
|
789
|
+
req.send_request(options)
|
790
|
+
end
|
791
|
+
|
792
|
+
# Returns a specified NotificationConfiguration.
|
793
|
+
#
|
794
|
+
# @option params [required, String] :arn
|
795
|
+
# The Amazon Resource Name (ARN) of the NotificationConfiguration to
|
796
|
+
# return.
|
797
|
+
#
|
798
|
+
# @return [Types::GetNotificationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
799
|
+
#
|
800
|
+
# * {Types::GetNotificationConfigurationResponse#arn #arn} => String
|
801
|
+
# * {Types::GetNotificationConfigurationResponse#name #name} => String
|
802
|
+
# * {Types::GetNotificationConfigurationResponse#description #description} => String
|
803
|
+
# * {Types::GetNotificationConfigurationResponse#status #status} => String
|
804
|
+
# * {Types::GetNotificationConfigurationResponse#creation_time #creation_time} => Time
|
805
|
+
# * {Types::GetNotificationConfigurationResponse#aggregation_duration #aggregation_duration} => String
|
806
|
+
#
|
807
|
+
# @example Request syntax with placeholder values
|
808
|
+
#
|
809
|
+
# resp = client.get_notification_configuration({
|
810
|
+
# arn: "NotificationConfigurationArn", # required
|
811
|
+
# })
|
812
|
+
#
|
813
|
+
# @example Response structure
|
814
|
+
#
|
815
|
+
# resp.arn #=> String
|
816
|
+
# resp.name #=> String
|
817
|
+
# resp.description #=> String
|
818
|
+
# resp.status #=> String, one of "ACTIVE", "PARTIALLY_ACTIVE", "INACTIVE", "DELETING"
|
819
|
+
# resp.creation_time #=> Time
|
820
|
+
# resp.aggregation_duration #=> String, one of "LONG", "SHORT", "NONE"
|
821
|
+
#
|
822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationConfiguration AWS API Documentation
|
823
|
+
#
|
824
|
+
# @overload get_notification_configuration(params = {})
|
825
|
+
# @param [Hash] params ({})
|
826
|
+
def get_notification_configuration(params = {}, options = {})
|
827
|
+
req = build_request(:get_notification_configuration, params)
|
828
|
+
req.send_request(options)
|
829
|
+
end
|
830
|
+
|
831
|
+
# Returns a specified NotificationEvent.
|
832
|
+
#
|
833
|
+
# User Notifications stores notifications in the individual Regions you
|
834
|
+
# register as notification hubs and the Region of the source event rule.
|
835
|
+
# GetNotificationEvent only returns notifications stored in the same
|
836
|
+
# Region in which the action is called. User Notifications doesn't
|
837
|
+
# backfill notifications to new Regions selected as notification hubs.
|
838
|
+
# For this reason, we recommend that you make calls in your oldest
|
839
|
+
# registered notification hub. For more information, see [Notification
|
840
|
+
# hubs][1] in the *AWS User Notifications User Guide*.
|
841
|
+
#
|
842
|
+
#
|
843
|
+
#
|
844
|
+
# [1]: https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html
|
845
|
+
#
|
846
|
+
# @option params [required, String] :arn
|
847
|
+
# The Amazon Resource Name (ARN) of the NotificationEvent to return.
|
848
|
+
#
|
849
|
+
# @option params [String] :locale
|
850
|
+
# The locale code of the language used for the retrieved
|
851
|
+
# NotificationEvent. The default locale is English `en_US`.
|
852
|
+
#
|
853
|
+
# @return [Types::GetNotificationEventResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
854
|
+
#
|
855
|
+
# * {Types::GetNotificationEventResponse#arn #arn} => String
|
856
|
+
# * {Types::GetNotificationEventResponse#notification_configuration_arn #notification_configuration_arn} => String
|
857
|
+
# * {Types::GetNotificationEventResponse#creation_time #creation_time} => Time
|
858
|
+
# * {Types::GetNotificationEventResponse#content #content} => Types::NotificationEvent
|
859
|
+
#
|
860
|
+
# @example Request syntax with placeholder values
|
861
|
+
#
|
862
|
+
# resp = client.get_notification_event({
|
863
|
+
# arn: "NotificationEventArn", # required
|
864
|
+
# locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
|
865
|
+
# })
|
866
|
+
#
|
867
|
+
# @example Response structure
|
868
|
+
#
|
869
|
+
# resp.arn #=> String
|
870
|
+
# resp.notification_configuration_arn #=> String
|
871
|
+
# resp.creation_time #=> Time
|
872
|
+
# resp.content.schema_version #=> String, one of "v1.0"
|
873
|
+
# resp.content.id #=> String
|
874
|
+
# resp.content.source_event_metadata.event_type_version #=> String
|
875
|
+
# resp.content.source_event_metadata.source_event_id #=> String
|
876
|
+
# resp.content.source_event_metadata.event_origin_region #=> String
|
877
|
+
# resp.content.source_event_metadata.related_account #=> String
|
878
|
+
# resp.content.source_event_metadata.source #=> String
|
879
|
+
# resp.content.source_event_metadata.event_occurrence_time #=> Time
|
880
|
+
# resp.content.source_event_metadata.event_type #=> String
|
881
|
+
# resp.content.source_event_metadata.related_resources #=> Array
|
882
|
+
# resp.content.source_event_metadata.related_resources[0].id #=> String
|
883
|
+
# resp.content.source_event_metadata.related_resources[0].arn #=> String
|
884
|
+
# resp.content.source_event_metadata.related_resources[0].detail_url #=> String
|
885
|
+
# resp.content.source_event_metadata.related_resources[0].tags #=> Array
|
886
|
+
# resp.content.source_event_metadata.related_resources[0].tags[0] #=> String
|
887
|
+
# resp.content.message_components.headline #=> String
|
888
|
+
# resp.content.message_components.paragraph_summary #=> String
|
889
|
+
# resp.content.message_components.complete_description #=> String
|
890
|
+
# resp.content.message_components.dimensions #=> Array
|
891
|
+
# resp.content.message_components.dimensions[0].name #=> String
|
892
|
+
# resp.content.message_components.dimensions[0].value #=> String
|
893
|
+
# resp.content.source_event_detail_url #=> String
|
894
|
+
# resp.content.source_event_detail_url_display_text #=> String
|
895
|
+
# resp.content.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
|
896
|
+
# resp.content.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
|
897
|
+
# resp.content.aggregation_event_type #=> String, one of "AGGREGATE", "CHILD", "NONE"
|
898
|
+
# resp.content.aggregate_notification_event_arn #=> String
|
899
|
+
# resp.content.start_time #=> Time
|
900
|
+
# resp.content.end_time #=> Time
|
901
|
+
# resp.content.text_parts #=> Hash
|
902
|
+
# resp.content.text_parts["TextPartId"].type #=> String, one of "LOCALIZED_TEXT", "PLAIN_TEXT", "URL"
|
903
|
+
# resp.content.text_parts["TextPartId"].display_text #=> String
|
904
|
+
# resp.content.text_parts["TextPartId"].text_by_locale #=> Hash
|
905
|
+
# resp.content.text_parts["TextPartId"].text_by_locale["LocaleCode"] #=> String
|
906
|
+
# resp.content.text_parts["TextPartId"].url #=> String
|
907
|
+
# resp.content.media #=> Array
|
908
|
+
# resp.content.media[0].media_id #=> String
|
909
|
+
# resp.content.media[0].type #=> String, one of "IMAGE"
|
910
|
+
# resp.content.media[0].url #=> String
|
911
|
+
# resp.content.media[0].caption #=> String
|
912
|
+
#
|
913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationEvent AWS API Documentation
|
914
|
+
#
|
915
|
+
# @overload get_notification_event(params = {})
|
916
|
+
# @param [Hash] params ({})
|
917
|
+
def get_notification_event(params = {}, options = {})
|
918
|
+
req = build_request(:get_notification_event, params)
|
919
|
+
req.send_request(options)
|
920
|
+
end
|
921
|
+
|
922
|
+
# Returns a list of Channels for a NotificationConfiguration.
|
923
|
+
#
|
924
|
+
# @option params [required, String] :notification_configuration_arn
|
925
|
+
# The Amazon Resource Name (ARN) of the NotificationConfiguration.
|
926
|
+
#
|
927
|
+
# @option params [Integer] :max_results
|
928
|
+
# The maximum number of results to be returned in this call. The default
|
929
|
+
# value is 20.
|
930
|
+
#
|
931
|
+
# @option params [String] :next_token
|
932
|
+
# The start token for paginated calls. Retrieved from the response of a
|
933
|
+
# previous ListNotificationEvents call. NextToken uses Base64 encoding.
|
934
|
+
#
|
935
|
+
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
936
|
+
#
|
937
|
+
# * {Types::ListChannelsResponse#next_token #next_token} => String
|
938
|
+
# * {Types::ListChannelsResponse#channels #channels} => Array<String>
|
939
|
+
#
|
940
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
941
|
+
#
|
942
|
+
# @example Request syntax with placeholder values
|
943
|
+
#
|
944
|
+
# resp = client.list_channels({
|
945
|
+
# notification_configuration_arn: "NotificationConfigurationArn", # required
|
946
|
+
# max_results: 1,
|
947
|
+
# next_token: "NextToken",
|
948
|
+
# })
|
949
|
+
#
|
950
|
+
# @example Response structure
|
951
|
+
#
|
952
|
+
# resp.next_token #=> String
|
953
|
+
# resp.channels #=> Array
|
954
|
+
# resp.channels[0] #=> String
|
955
|
+
#
|
956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListChannels AWS API Documentation
|
957
|
+
#
|
958
|
+
# @overload list_channels(params = {})
|
959
|
+
# @param [Hash] params ({})
|
960
|
+
def list_channels(params = {}, options = {})
|
961
|
+
req = build_request(:list_channels, params)
|
962
|
+
req.send_request(options)
|
963
|
+
end
|
964
|
+
|
965
|
+
# Returns a list of EventRules according to specified filters, in
|
966
|
+
# reverse chronological order (newest first).
|
967
|
+
#
|
968
|
+
# @option params [required, String] :notification_configuration_arn
|
969
|
+
# The Amazon Resource Name (ARN) of the NotificationConfiguration.
|
970
|
+
#
|
971
|
+
# @option params [Integer] :max_results
|
972
|
+
# The maximum number of results to be returned in this call. The default
|
973
|
+
# value is 20.
|
974
|
+
#
|
975
|
+
# @option params [String] :next_token
|
976
|
+
# The start token for paginated calls. Retrieved from the response of a
|
977
|
+
# previous ListEventRules call. Next token uses Base64 encoding.
|
978
|
+
#
|
979
|
+
# @return [Types::ListEventRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
980
|
+
#
|
981
|
+
# * {Types::ListEventRulesResponse#next_token #next_token} => String
|
982
|
+
# * {Types::ListEventRulesResponse#event_rules #event_rules} => Array<Types::EventRuleStructure>
|
983
|
+
#
|
984
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
985
|
+
#
|
986
|
+
# @example Request syntax with placeholder values
|
987
|
+
#
|
988
|
+
# resp = client.list_event_rules({
|
989
|
+
# notification_configuration_arn: "NotificationConfigurationArn", # required
|
990
|
+
# max_results: 1,
|
991
|
+
# next_token: "NextToken",
|
992
|
+
# })
|
993
|
+
#
|
994
|
+
# @example Response structure
|
995
|
+
#
|
996
|
+
# resp.next_token #=> String
|
997
|
+
# resp.event_rules #=> Array
|
998
|
+
# resp.event_rules[0].arn #=> String
|
999
|
+
# resp.event_rules[0].notification_configuration_arn #=> String
|
1000
|
+
# resp.event_rules[0].creation_time #=> Time
|
1001
|
+
# resp.event_rules[0].source #=> String
|
1002
|
+
# resp.event_rules[0].event_type #=> String
|
1003
|
+
# resp.event_rules[0].event_pattern #=> String
|
1004
|
+
# resp.event_rules[0].regions #=> Array
|
1005
|
+
# resp.event_rules[0].regions[0] #=> String
|
1006
|
+
# resp.event_rules[0].managed_rules #=> Array
|
1007
|
+
# resp.event_rules[0].managed_rules[0] #=> String
|
1008
|
+
# resp.event_rules[0].status_summary_by_region #=> Hash
|
1009
|
+
# resp.event_rules[0].status_summary_by_region["Region"].status #=> String, one of "ACTIVE", "INACTIVE", "CREATING", "UPDATING", "DELETING"
|
1010
|
+
# resp.event_rules[0].status_summary_by_region["Region"].reason #=> String
|
1011
|
+
#
|
1012
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListEventRules AWS API Documentation
|
1013
|
+
#
|
1014
|
+
# @overload list_event_rules(params = {})
|
1015
|
+
# @param [Hash] params ({})
|
1016
|
+
def list_event_rules(params = {}, options = {})
|
1017
|
+
req = build_request(:list_event_rules, params)
|
1018
|
+
req.send_request(options)
|
1019
|
+
end
|
1020
|
+
|
1021
|
+
# Returns a list of abbreviated NotificationConfigurations according to
|
1022
|
+
# specified filters, in reverse chronological order (newest first).
|
1023
|
+
#
|
1024
|
+
# @option params [String] :event_rule_source
|
1025
|
+
# The matched event source.
|
1026
|
+
#
|
1027
|
+
# Must match one of the valid EventBridge sources. Only AWS service
|
1028
|
+
# sourced events are supported. For example, `aws.ec2` and
|
1029
|
+
# `aws.cloudwatch`. For more information, see [Event delivery from AWS
|
1030
|
+
# services][1] in the *Amazon EventBridge User Guide*.
|
1031
|
+
#
|
1032
|
+
#
|
1033
|
+
#
|
1034
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
|
1035
|
+
#
|
1036
|
+
# @option params [String] :channel_arn
|
1037
|
+
# The Amazon Resource Name (ARN) of the Channel to match.
|
1038
|
+
#
|
1039
|
+
# @option params [String] :status
|
1040
|
+
# The NotificationConfiguration status to match.
|
1041
|
+
#
|
1042
|
+
# * Values:
|
1043
|
+
#
|
1044
|
+
# * `ACTIVE`
|
1045
|
+
#
|
1046
|
+
# * All EventRules are `ACTIVE` and any call can be run.
|
1047
|
+
#
|
1048
|
+
# ^
|
1049
|
+
# * `PARTIALLY_ACTIVE`
|
1050
|
+
#
|
1051
|
+
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
|
1052
|
+
# can be run.
|
1053
|
+
#
|
1054
|
+
# * Any call can be run.
|
1055
|
+
# * `INACTIVE`
|
1056
|
+
#
|
1057
|
+
# * All EventRules are `INACTIVE` and any call can be run.
|
1058
|
+
#
|
1059
|
+
# ^
|
1060
|
+
# * `DELETING`
|
1061
|
+
#
|
1062
|
+
# * This NotificationConfiguration is being deleted.
|
1063
|
+
#
|
1064
|
+
# * Only `GET` and `LIST` calls can be run.
|
1065
|
+
#
|
1066
|
+
# @option params [Integer] :max_results
|
1067
|
+
# The maximum number of results to be returned in this call. Defaults to
|
1068
|
+
# 20.
|
1069
|
+
#
|
1070
|
+
# @option params [String] :next_token
|
1071
|
+
# The start token for paginated calls. Retrieved from the response of a
|
1072
|
+
# previous ListEventRules call. Next token uses Base64 encoding.
|
1073
|
+
#
|
1074
|
+
# @return [Types::ListNotificationConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1075
|
+
#
|
1076
|
+
# * {Types::ListNotificationConfigurationsResponse#next_token #next_token} => String
|
1077
|
+
# * {Types::ListNotificationConfigurationsResponse#notification_configurations #notification_configurations} => Array<Types::NotificationConfigurationStructure>
|
1078
|
+
#
|
1079
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1080
|
+
#
|
1081
|
+
# @example Request syntax with placeholder values
|
1082
|
+
#
|
1083
|
+
# resp = client.list_notification_configurations({
|
1084
|
+
# event_rule_source: "Source",
|
1085
|
+
# channel_arn: "ChannelArn",
|
1086
|
+
# status: "ACTIVE", # accepts ACTIVE, PARTIALLY_ACTIVE, INACTIVE, DELETING
|
1087
|
+
# max_results: 1,
|
1088
|
+
# next_token: "NextToken",
|
1089
|
+
# })
|
1090
|
+
#
|
1091
|
+
# @example Response structure
|
1092
|
+
#
|
1093
|
+
# resp.next_token #=> String
|
1094
|
+
# resp.notification_configurations #=> Array
|
1095
|
+
# resp.notification_configurations[0].arn #=> String
|
1096
|
+
# resp.notification_configurations[0].name #=> String
|
1097
|
+
# resp.notification_configurations[0].description #=> String
|
1098
|
+
# resp.notification_configurations[0].status #=> String, one of "ACTIVE", "PARTIALLY_ACTIVE", "INACTIVE", "DELETING"
|
1099
|
+
# resp.notification_configurations[0].creation_time #=> Time
|
1100
|
+
# resp.notification_configurations[0].aggregation_duration #=> String, one of "LONG", "SHORT", "NONE"
|
1101
|
+
#
|
1102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationConfigurations AWS API Documentation
|
1103
|
+
#
|
1104
|
+
# @overload list_notification_configurations(params = {})
|
1105
|
+
# @param [Hash] params ({})
|
1106
|
+
def list_notification_configurations(params = {}, options = {})
|
1107
|
+
req = build_request(:list_notification_configurations, params)
|
1108
|
+
req.send_request(options)
|
1109
|
+
end
|
1110
|
+
|
1111
|
+
# Returns a list of NotificationEvents according to specified filters,
|
1112
|
+
# in reverse chronological order (newest first).
|
1113
|
+
#
|
1114
|
+
# User Notifications stores notifications in the individual Regions you
|
1115
|
+
# register as notification hubs and the Region of the source event rule.
|
1116
|
+
# ListNotificationEvents only returns notifications stored in the same
|
1117
|
+
# Region in which the action is called. User Notifications doesn't
|
1118
|
+
# backfill notifications to new Regions selected as notification hubs.
|
1119
|
+
# For this reason, we recommend that you make calls in your oldest
|
1120
|
+
# registered notification hub. For more information, see [Notification
|
1121
|
+
# hubs][1] in the *AWS User Notifications User Guide*.
|
1122
|
+
#
|
1123
|
+
#
|
1124
|
+
#
|
1125
|
+
# [1]: https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html
|
1126
|
+
#
|
1127
|
+
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
1128
|
+
# The earliest time of events to return from this call.
|
1129
|
+
#
|
1130
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
1131
|
+
# Latest time of events to return from this call.
|
1132
|
+
#
|
1133
|
+
# @option params [String] :locale
|
1134
|
+
# The locale code of the language used for the retrieved
|
1135
|
+
# NotificationEvent. The default locale is English `(en_US)`.
|
1136
|
+
#
|
1137
|
+
# @option params [String] :source
|
1138
|
+
# The matched event source.
|
1139
|
+
#
|
1140
|
+
# Must match one of the valid EventBridge sources. Only AWS service
|
1141
|
+
# sourced events are supported. For example, `aws.ec2` and
|
1142
|
+
# `aws.cloudwatch`. For more information, see [Event delivery from AWS
|
1143
|
+
# services][1] in the *Amazon EventBridge User Guide*.
|
1144
|
+
#
|
1145
|
+
#
|
1146
|
+
#
|
1147
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
|
1148
|
+
#
|
1149
|
+
# @option params [Boolean] :include_child_events
|
1150
|
+
# Include aggregated child events in the result.
|
1151
|
+
#
|
1152
|
+
# @option params [String] :aggregate_notification_event_arn
|
1153
|
+
# The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn
|
1154
|
+
# to match.
|
1155
|
+
#
|
1156
|
+
# @option params [Integer] :max_results
|
1157
|
+
# The maximum number of results to be returned in this call. Defaults to
|
1158
|
+
# 20.
|
1159
|
+
#
|
1160
|
+
# @option params [String] :next_token
|
1161
|
+
# The start token for paginated calls. Retrieved from the response of a
|
1162
|
+
# previous ListEventRules call. Next token uses Base64 encoding.
|
1163
|
+
#
|
1164
|
+
# @return [Types::ListNotificationEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1165
|
+
#
|
1166
|
+
# * {Types::ListNotificationEventsResponse#next_token #next_token} => String
|
1167
|
+
# * {Types::ListNotificationEventsResponse#notification_events #notification_events} => Array<Types::NotificationEventOverview>
|
1168
|
+
#
|
1169
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1170
|
+
#
|
1171
|
+
# @example Request syntax with placeholder values
|
1172
|
+
#
|
1173
|
+
# resp = client.list_notification_events({
|
1174
|
+
# start_time: Time.now,
|
1175
|
+
# end_time: Time.now,
|
1176
|
+
# locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
|
1177
|
+
# source: "Source",
|
1178
|
+
# include_child_events: false,
|
1179
|
+
# aggregate_notification_event_arn: "NotificationEventArn",
|
1180
|
+
# max_results: 1,
|
1181
|
+
# next_token: "NextToken",
|
1182
|
+
# })
|
1183
|
+
#
|
1184
|
+
# @example Response structure
|
1185
|
+
#
|
1186
|
+
# resp.next_token #=> String
|
1187
|
+
# resp.notification_events #=> Array
|
1188
|
+
# resp.notification_events[0].arn #=> String
|
1189
|
+
# resp.notification_events[0].notification_configuration_arn #=> String
|
1190
|
+
# resp.notification_events[0].related_account #=> String
|
1191
|
+
# resp.notification_events[0].creation_time #=> Time
|
1192
|
+
# resp.notification_events[0].notification_event.schema_version #=> String, one of "v1.0"
|
1193
|
+
# resp.notification_events[0].notification_event.source_event_metadata.event_origin_region #=> String
|
1194
|
+
# resp.notification_events[0].notification_event.source_event_metadata.source #=> String
|
1195
|
+
# resp.notification_events[0].notification_event.source_event_metadata.event_type #=> String
|
1196
|
+
# resp.notification_events[0].notification_event.message_components.headline #=> String
|
1197
|
+
# resp.notification_events[0].notification_event.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
|
1198
|
+
# resp.notification_events[0].notification_event.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
|
1199
|
+
# resp.notification_events[0].aggregation_event_type #=> String, one of "AGGREGATE", "CHILD", "NONE"
|
1200
|
+
# resp.notification_events[0].aggregate_notification_event_arn #=> String
|
1201
|
+
#
|
1202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationEvents AWS API Documentation
|
1203
|
+
#
|
1204
|
+
# @overload list_notification_events(params = {})
|
1205
|
+
# @param [Hash] params ({})
|
1206
|
+
def list_notification_events(params = {}, options = {})
|
1207
|
+
req = build_request(:list_notification_events, params)
|
1208
|
+
req.send_request(options)
|
1209
|
+
end
|
1210
|
+
|
1211
|
+
# Returns a list of NotificationHubs.
|
1212
|
+
#
|
1213
|
+
# @option params [Integer] :max_results
|
1214
|
+
# The maximum number of records to list in a single response.
|
1215
|
+
#
|
1216
|
+
# @option params [String] :next_token
|
1217
|
+
# A pagination token. Set to null to start listing notification hubs
|
1218
|
+
# from the start.
|
1219
|
+
#
|
1220
|
+
# @return [Types::ListNotificationHubsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1221
|
+
#
|
1222
|
+
# * {Types::ListNotificationHubsResponse#notification_hubs #notification_hubs} => Array<Types::NotificationHubOverview>
|
1223
|
+
# * {Types::ListNotificationHubsResponse#next_token #next_token} => String
|
1224
|
+
#
|
1225
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1226
|
+
#
|
1227
|
+
# @example Request syntax with placeholder values
|
1228
|
+
#
|
1229
|
+
# resp = client.list_notification_hubs({
|
1230
|
+
# max_results: 1,
|
1231
|
+
# next_token: "NextToken",
|
1232
|
+
# })
|
1233
|
+
#
|
1234
|
+
# @example Response structure
|
1235
|
+
#
|
1236
|
+
# resp.notification_hubs #=> Array
|
1237
|
+
# resp.notification_hubs[0].notification_hub_region #=> String
|
1238
|
+
# resp.notification_hubs[0].status_summary.status #=> String, one of "ACTIVE", "REGISTERING", "DEREGISTERING", "INACTIVE"
|
1239
|
+
# resp.notification_hubs[0].status_summary.reason #=> String
|
1240
|
+
# resp.notification_hubs[0].creation_time #=> Time
|
1241
|
+
# resp.notification_hubs[0].last_activation_time #=> Time
|
1242
|
+
# resp.next_token #=> String
|
1243
|
+
#
|
1244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationHubs AWS API Documentation
|
1245
|
+
#
|
1246
|
+
# @overload list_notification_hubs(params = {})
|
1247
|
+
# @param [Hash] params ({})
|
1248
|
+
def list_notification_hubs(params = {}, options = {})
|
1249
|
+
req = build_request(:list_notification_hubs, params)
|
1250
|
+
req.send_request(options)
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# Returns a list of tags for a specified Amazon Resource Name (ARN).
|
1254
|
+
#
|
1255
|
+
# For more information, see [Tagging your AWS resources][1] in the
|
1256
|
+
# *Tagging AWS Resources User Guide*.
|
1257
|
+
#
|
1258
|
+
# <note markdown="1"> This is only supported for NotificationConfigurations.
|
1259
|
+
#
|
1260
|
+
# </note>
|
1261
|
+
#
|
1262
|
+
#
|
1263
|
+
#
|
1264
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html
|
1265
|
+
#
|
1266
|
+
# @option params [required, String] :arn
|
1267
|
+
# The Amazon Resource Name (ARN) to use to list tags.
|
1268
|
+
#
|
1269
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1270
|
+
#
|
1271
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
1272
|
+
#
|
1273
|
+
# @example Request syntax with placeholder values
|
1274
|
+
#
|
1275
|
+
# resp = client.list_tags_for_resource({
|
1276
|
+
# arn: "NotificationConfigurationArn", # required
|
1277
|
+
# })
|
1278
|
+
#
|
1279
|
+
# @example Response structure
|
1280
|
+
#
|
1281
|
+
# resp.tags #=> Hash
|
1282
|
+
# resp.tags["TagKey"] #=> String
|
1283
|
+
#
|
1284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListTagsForResource AWS API Documentation
|
1285
|
+
#
|
1286
|
+
# @overload list_tags_for_resource(params = {})
|
1287
|
+
# @param [Hash] params ({})
|
1288
|
+
def list_tags_for_resource(params = {}, options = {})
|
1289
|
+
req = build_request(:list_tags_for_resource, params)
|
1290
|
+
req.send_request(options)
|
1291
|
+
end
|
1292
|
+
|
1293
|
+
# Registers a NotificationHub in the specified Region.
|
1294
|
+
#
|
1295
|
+
# There is a maximum of one NotificationHub per Region. You can have a
|
1296
|
+
# maximum of 3 NotificationHubs at a time.
|
1297
|
+
#
|
1298
|
+
# @option params [required, String] :notification_hub_region
|
1299
|
+
# The Region of the NotificationHub.
|
1300
|
+
#
|
1301
|
+
# @return [Types::RegisterNotificationHubResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1302
|
+
#
|
1303
|
+
# * {Types::RegisterNotificationHubResponse#notification_hub_region #notification_hub_region} => String
|
1304
|
+
# * {Types::RegisterNotificationHubResponse#status_summary #status_summary} => Types::NotificationHubStatusSummary
|
1305
|
+
# * {Types::RegisterNotificationHubResponse#creation_time #creation_time} => Time
|
1306
|
+
# * {Types::RegisterNotificationHubResponse#last_activation_time #last_activation_time} => Time
|
1307
|
+
#
|
1308
|
+
# @example Request syntax with placeholder values
|
1309
|
+
#
|
1310
|
+
# resp = client.register_notification_hub({
|
1311
|
+
# notification_hub_region: "Region", # required
|
1312
|
+
# })
|
1313
|
+
#
|
1314
|
+
# @example Response structure
|
1315
|
+
#
|
1316
|
+
# resp.notification_hub_region #=> String
|
1317
|
+
# resp.status_summary.status #=> String, one of "ACTIVE", "REGISTERING", "DEREGISTERING", "INACTIVE"
|
1318
|
+
# resp.status_summary.reason #=> String
|
1319
|
+
# resp.creation_time #=> Time
|
1320
|
+
# resp.last_activation_time #=> Time
|
1321
|
+
#
|
1322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/RegisterNotificationHub AWS API Documentation
|
1323
|
+
#
|
1324
|
+
# @overload register_notification_hub(params = {})
|
1325
|
+
# @param [Hash] params ({})
|
1326
|
+
def register_notification_hub(params = {}, options = {})
|
1327
|
+
req = build_request(:register_notification_hub, params)
|
1328
|
+
req.send_request(options)
|
1329
|
+
end
|
1330
|
+
|
1331
|
+
# Tags the resource with a tag key and value.
|
1332
|
+
#
|
1333
|
+
# For more information, see [Tagging your AWS resources][1] in the
|
1334
|
+
# *Tagging AWS Resources User Guide*.
|
1335
|
+
#
|
1336
|
+
# <note markdown="1"> This is only supported for NotificationConfigurations.
|
1337
|
+
#
|
1338
|
+
# </note>
|
1339
|
+
#
|
1340
|
+
#
|
1341
|
+
#
|
1342
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html
|
1343
|
+
#
|
1344
|
+
# @option params [required, String] :arn
|
1345
|
+
# The Amazon Resource Name (ARN) to use to tag a resource.
|
1346
|
+
#
|
1347
|
+
# @option params [required, Hash<String,String>] :tags
|
1348
|
+
# A map of tags assigned to a resource. A tag is a string-to-string map
|
1349
|
+
# of key-value pairs.
|
1350
|
+
#
|
1351
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1352
|
+
#
|
1353
|
+
# @example Request syntax with placeholder values
|
1354
|
+
#
|
1355
|
+
# resp = client.tag_resource({
|
1356
|
+
# arn: "NotificationConfigurationArn", # required
|
1357
|
+
# tags: { # required
|
1358
|
+
# "TagKey" => "TagValue",
|
1359
|
+
# },
|
1360
|
+
# })
|
1361
|
+
#
|
1362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/TagResource AWS API Documentation
|
1363
|
+
#
|
1364
|
+
# @overload tag_resource(params = {})
|
1365
|
+
# @param [Hash] params ({})
|
1366
|
+
def tag_resource(params = {}, options = {})
|
1367
|
+
req = build_request(:tag_resource, params)
|
1368
|
+
req.send_request(options)
|
1369
|
+
end
|
1370
|
+
|
1371
|
+
# Untags a resource with a specified Amazon Resource Name (ARN).
|
1372
|
+
#
|
1373
|
+
# For more information, see [Tagging your AWS resources][1] in the
|
1374
|
+
# *Tagging AWS Resources User Guide*.
|
1375
|
+
#
|
1376
|
+
#
|
1377
|
+
#
|
1378
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html
|
1379
|
+
#
|
1380
|
+
# @option params [required, String] :arn
|
1381
|
+
# The Amazon Resource Name (ARN) to use to untag a resource.
|
1382
|
+
#
|
1383
|
+
# @option params [required, Array<String>] :tag_keys
|
1384
|
+
# The tag keys to use to untag a resource.
|
1385
|
+
#
|
1386
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1387
|
+
#
|
1388
|
+
# @example Request syntax with placeholder values
|
1389
|
+
#
|
1390
|
+
# resp = client.untag_resource({
|
1391
|
+
# arn: "NotificationConfigurationArn", # required
|
1392
|
+
# tag_keys: ["TagKey"], # required
|
1393
|
+
# })
|
1394
|
+
#
|
1395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UntagResource AWS API Documentation
|
1396
|
+
#
|
1397
|
+
# @overload untag_resource(params = {})
|
1398
|
+
# @param [Hash] params ({})
|
1399
|
+
def untag_resource(params = {}, options = {})
|
1400
|
+
req = build_request(:untag_resource, params)
|
1401
|
+
req.send_request(options)
|
1402
|
+
end
|
1403
|
+
|
1404
|
+
# Updates an existing EventRule.
|
1405
|
+
#
|
1406
|
+
# @option params [required, String] :arn
|
1407
|
+
# The Amazon Resource Name (ARN) to use to update the EventRule.
|
1408
|
+
#
|
1409
|
+
# @option params [String] :event_pattern
|
1410
|
+
# An additional event pattern used to further filter the events this
|
1411
|
+
# EventRule receives.
|
1412
|
+
#
|
1413
|
+
# For more information, see [Amazon EventBridge event patterns][1] in
|
1414
|
+
# the *Amazon EventBridge User Guide.*
|
1415
|
+
#
|
1416
|
+
#
|
1417
|
+
#
|
1418
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
|
1419
|
+
#
|
1420
|
+
# @option params [Array<String>] :regions
|
1421
|
+
# A list of AWS Regions that sends events to this EventRule.
|
1422
|
+
#
|
1423
|
+
# @return [Types::UpdateEventRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1424
|
+
#
|
1425
|
+
# * {Types::UpdateEventRuleResponse#arn #arn} => String
|
1426
|
+
# * {Types::UpdateEventRuleResponse#notification_configuration_arn #notification_configuration_arn} => String
|
1427
|
+
# * {Types::UpdateEventRuleResponse#status_summary_by_region #status_summary_by_region} => Hash<String,Types::EventRuleStatusSummary>
|
1428
|
+
#
|
1429
|
+
# @example Request syntax with placeholder values
|
1430
|
+
#
|
1431
|
+
# resp = client.update_event_rule({
|
1432
|
+
# arn: "EventRuleArn", # required
|
1433
|
+
# event_pattern: "EventRuleEventPattern",
|
1434
|
+
# regions: ["Region"],
|
1435
|
+
# })
|
1436
|
+
#
|
1437
|
+
# @example Response structure
|
1438
|
+
#
|
1439
|
+
# resp.arn #=> String
|
1440
|
+
# resp.notification_configuration_arn #=> String
|
1441
|
+
# resp.status_summary_by_region #=> Hash
|
1442
|
+
# resp.status_summary_by_region["Region"].status #=> String, one of "ACTIVE", "INACTIVE", "CREATING", "UPDATING", "DELETING"
|
1443
|
+
# resp.status_summary_by_region["Region"].reason #=> String
|
1444
|
+
#
|
1445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UpdateEventRule AWS API Documentation
|
1446
|
+
#
|
1447
|
+
# @overload update_event_rule(params = {})
|
1448
|
+
# @param [Hash] params ({})
|
1449
|
+
def update_event_rule(params = {}, options = {})
|
1450
|
+
req = build_request(:update_event_rule, params)
|
1451
|
+
req.send_request(options)
|
1452
|
+
end
|
1453
|
+
|
1454
|
+
# Updates a NotificationConfiguration.
|
1455
|
+
#
|
1456
|
+
# @option params [required, String] :arn
|
1457
|
+
# The Amazon Resource Name (ARN) used to update the
|
1458
|
+
# NotificationConfiguration.
|
1459
|
+
#
|
1460
|
+
# @option params [String] :name
|
1461
|
+
# The name of the NotificationConfiguration.
|
1462
|
+
#
|
1463
|
+
# @option params [String] :description
|
1464
|
+
# The description of the NotificationConfiguration.
|
1465
|
+
#
|
1466
|
+
# @option params [String] :aggregation_duration
|
1467
|
+
# The status of this NotificationConfiguration.
|
1468
|
+
#
|
1469
|
+
# The status should always be `INACTIVE` when part of the
|
1470
|
+
# CreateNotificationConfiguration response.
|
1471
|
+
#
|
1472
|
+
# * Values:
|
1473
|
+
#
|
1474
|
+
# * `ACTIVE`
|
1475
|
+
#
|
1476
|
+
# * All EventRules are `ACTIVE` and any call can be run.
|
1477
|
+
#
|
1478
|
+
# ^
|
1479
|
+
# * `PARTIALLY_ACTIVE`
|
1480
|
+
#
|
1481
|
+
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
|
1482
|
+
# can be run.
|
1483
|
+
#
|
1484
|
+
# * Any call can be run.
|
1485
|
+
# * `INACTIVE`
|
1486
|
+
#
|
1487
|
+
# * All EventRules are `INACTIVE` and any call can be run.
|
1488
|
+
#
|
1489
|
+
# ^
|
1490
|
+
# * `DELETING`
|
1491
|
+
#
|
1492
|
+
# * This NotificationConfiguration is being deleted.
|
1493
|
+
#
|
1494
|
+
# * Only `GET` and `LIST` calls can be run.
|
1495
|
+
#
|
1496
|
+
# @return [Types::UpdateNotificationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1497
|
+
#
|
1498
|
+
# * {Types::UpdateNotificationConfigurationResponse#arn #arn} => String
|
1499
|
+
#
|
1500
|
+
# @example Request syntax with placeholder values
|
1501
|
+
#
|
1502
|
+
# resp = client.update_notification_configuration({
|
1503
|
+
# arn: "NotificationConfigurationArn", # required
|
1504
|
+
# name: "NotificationConfigurationName",
|
1505
|
+
# description: "NotificationConfigurationDescription",
|
1506
|
+
# aggregation_duration: "LONG", # accepts LONG, SHORT, NONE
|
1507
|
+
# })
|
1508
|
+
#
|
1509
|
+
# @example Response structure
|
1510
|
+
#
|
1511
|
+
# resp.arn #=> String
|
1512
|
+
#
|
1513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UpdateNotificationConfiguration AWS API Documentation
|
1514
|
+
#
|
1515
|
+
# @overload update_notification_configuration(params = {})
|
1516
|
+
# @param [Hash] params ({})
|
1517
|
+
def update_notification_configuration(params = {}, options = {})
|
1518
|
+
req = build_request(:update_notification_configuration, params)
|
1519
|
+
req.send_request(options)
|
1520
|
+
end
|
1521
|
+
|
1522
|
+
# @!endgroup
|
1523
|
+
|
1524
|
+
# @param params ({})
|
1525
|
+
# @api private
|
1526
|
+
def build_request(operation_name, params = {})
|
1527
|
+
handlers = @handlers.for(operation_name)
|
1528
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
1529
|
+
Aws::Telemetry.module_to_tracer_name('Aws::Notifications')
|
1530
|
+
)
|
1531
|
+
context = Seahorse::Client::RequestContext.new(
|
1532
|
+
operation_name: operation_name,
|
1533
|
+
operation: config.api.operation(operation_name),
|
1534
|
+
client: self,
|
1535
|
+
params: params,
|
1536
|
+
config: config,
|
1537
|
+
tracer: tracer
|
1538
|
+
)
|
1539
|
+
context[:gem_name] = 'aws-sdk-notifications'
|
1540
|
+
context[:gem_version] = '1.0.0'
|
1541
|
+
Seahorse::Client::Request.new(handlers, context)
|
1542
|
+
end
|
1543
|
+
|
1544
|
+
# @api private
|
1545
|
+
# @deprecated
|
1546
|
+
def waiter_names
|
1547
|
+
[]
|
1548
|
+
end
|
1549
|
+
|
1550
|
+
class << self
|
1551
|
+
|
1552
|
+
# @api private
|
1553
|
+
attr_reader :identifier
|
1554
|
+
|
1555
|
+
# @api private
|
1556
|
+
def errors_module
|
1557
|
+
Errors
|
1558
|
+
end
|
1559
|
+
|
1560
|
+
end
|
1561
|
+
end
|
1562
|
+
end
|