aws-sdk-eventbridgev2 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-eventbridgev2/client.rb +2322 -0
- data/lib/aws-sdk-eventbridgev2/client_api.rb +1266 -0
- data/lib/aws-sdk-eventbridgev2/customizations.rb +0 -0
- data/lib/aws-sdk-eventbridgev2/endpoint_parameters.rb +98 -0
- data/lib/aws-sdk-eventbridgev2/endpoint_provider.rb +95 -0
- data/lib/aws-sdk-eventbridgev2/endpoints.rb +166 -0
- data/lib/aws-sdk-eventbridgev2/errors.rb +298 -0
- data/lib/aws-sdk-eventbridgev2/plugins/endpoints.rb +102 -0
- data/lib/aws-sdk-eventbridgev2/resource.rb +26 -0
- data/lib/aws-sdk-eventbridgev2/types.rb +3185 -0
- data/lib/aws-sdk-eventbridgev2/waiters.rb +178 -0
- data/lib/aws-sdk-eventbridgev2.rb +62 -0
- data/sig/client.rbs +641 -0
- data/sig/errors.rbs +61 -0
- data/sig/params.rbs +72 -0
- data/sig/resource.rbs +86 -0
- data/sig/types.rbs +787 -0
- data/sig/waiters.rbs +33 -0
- metadata +98 -0
|
@@ -0,0 +1,2322 @@
|
|
|
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'
|
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery'
|
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern'
|
|
22
|
+
require 'aws-sdk-core/plugins/response_paging'
|
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
|
32
|
+
require 'aws-sdk-core/plugins/request_compression'
|
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
|
35
|
+
require 'aws-sdk-core/plugins/telemetry'
|
|
36
|
+
require 'aws-sdk-core/plugins/sign'
|
|
37
|
+
require 'aws-sdk-core/plugins/protocols/rpc_v2'
|
|
38
|
+
|
|
39
|
+
module Aws::EventBridgeV2
|
|
40
|
+
# An API client for EventBridgeV2. To construct a client, you need to configure a `:region` and `:credentials`.
|
|
41
|
+
#
|
|
42
|
+
# client = Aws::EventBridgeV2::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 = :eventbridgev2
|
|
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::RpcV2)
|
|
88
|
+
add_plugin(Aws::EventBridgeV2::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 used for authentication. This can be any class that includes and implements
|
|
99
|
+
# `Aws::CredentialProvider`, or instance of any one of the 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 locations will be searched for credentials:
|
|
128
|
+
#
|
|
129
|
+
# * `Aws.config[:credentials]`
|
|
130
|
+
#
|
|
131
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
|
132
|
+
# `:account_id` options.
|
|
133
|
+
#
|
|
134
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
|
135
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
|
136
|
+
#
|
|
137
|
+
# * `~/.aws/credentials`
|
|
138
|
+
#
|
|
139
|
+
# * `~/.aws/config`
|
|
140
|
+
#
|
|
141
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
|
|
142
|
+
# Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
|
143
|
+
# enable retries and extended timeouts. Instance profile credential fetching can be disabled by
|
|
144
|
+
# setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
|
|
145
|
+
#
|
|
146
|
+
# @option options [required, String] :region
|
|
147
|
+
# The AWS region to connect to. The configured `:region` is
|
|
148
|
+
# used to determine the service `:endpoint`. When not passed,
|
|
149
|
+
# a default `:region` is searched for in the following locations:
|
|
150
|
+
#
|
|
151
|
+
# * `Aws.config[:region]`
|
|
152
|
+
# * `ENV['AWS_REGION']`
|
|
153
|
+
# * `ENV['AMAZON_REGION']`
|
|
154
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
|
155
|
+
# * `~/.aws/credentials`
|
|
156
|
+
# * `~/.aws/config`
|
|
157
|
+
#
|
|
158
|
+
# @option options [String] :access_key_id
|
|
159
|
+
#
|
|
160
|
+
# @option options [String] :account_id
|
|
161
|
+
#
|
|
162
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
|
163
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
|
164
|
+
# the background every 60 secs (default). Defaults to `false`.
|
|
165
|
+
#
|
|
166
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
|
167
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
|
168
|
+
# until there is sufficent client side capacity to retry the request.
|
|
169
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
|
170
|
+
# not retry instead of sleeping.
|
|
171
|
+
#
|
|
172
|
+
# @option options [Array<String>] :auth_scheme_preference
|
|
173
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
|
174
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
|
175
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
|
176
|
+
#
|
|
177
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
|
178
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
|
179
|
+
# this client.
|
|
180
|
+
#
|
|
181
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
|
182
|
+
# Allows you to provide an identifier for this client which will be attached to
|
|
183
|
+
# all generated client side metrics. Defaults to an empty string.
|
|
184
|
+
#
|
|
185
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
|
186
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
|
187
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
|
188
|
+
#
|
|
189
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
|
190
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
|
191
|
+
# agent is running on, where client metrics will be published via UDP.
|
|
192
|
+
#
|
|
193
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
|
194
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
|
195
|
+
# will use the Client Side Monitoring Agent Publisher.
|
|
196
|
+
#
|
|
197
|
+
# @option options [Boolean] :convert_params (true)
|
|
198
|
+
# When `true`, an attempt is made to coerce request parameters into
|
|
199
|
+
# the required types.
|
|
200
|
+
#
|
|
201
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
|
202
|
+
# Used only in `standard` and `adaptive` retry modes. Specifies whether to apply
|
|
203
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
|
204
|
+
#
|
|
205
|
+
# @option options [String] :defaults_mode ("legacy")
|
|
206
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
|
207
|
+
# accepted modes and the configuration defaults that are included.
|
|
208
|
+
#
|
|
209
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
210
|
+
# When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
|
|
211
|
+
#
|
|
212
|
+
# @option options [Boolean] :disable_request_compression (false)
|
|
213
|
+
# When set to 'true' the request body will not be compressed
|
|
214
|
+
# for supported operations.
|
|
215
|
+
#
|
|
216
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
|
217
|
+
# Normally you should not configure the `:endpoint` option
|
|
218
|
+
# directly. This is normally constructed from the `:region`
|
|
219
|
+
# option. Configuring `:endpoint` is normally reserved for
|
|
220
|
+
# connecting to test or custom endpoints. The endpoint should
|
|
221
|
+
# be a URI formatted like:
|
|
222
|
+
#
|
|
223
|
+
# 'http://example.com'
|
|
224
|
+
# 'https://example.com'
|
|
225
|
+
# 'http://example.com:123'
|
|
226
|
+
#
|
|
227
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
|
228
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
|
229
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
|
230
|
+
#
|
|
231
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
|
232
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
|
233
|
+
#
|
|
234
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
|
235
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
|
236
|
+
# Use this option to config the time interval in seconds for making
|
|
237
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
|
238
|
+
#
|
|
239
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
|
240
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
241
|
+
#
|
|
242
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
|
243
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
|
244
|
+
# variables and the shared configuration file.
|
|
245
|
+
#
|
|
246
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
247
|
+
# The log formatter.
|
|
248
|
+
#
|
|
249
|
+
# @option options [Symbol] :log_level (:info)
|
|
250
|
+
# The log level to send messages to the `:logger` at.
|
|
251
|
+
#
|
|
252
|
+
# @option options [Logger] :logger
|
|
253
|
+
# The Logger instance to send log messages to. If this option
|
|
254
|
+
# is not set, logging will be disabled.
|
|
255
|
+
#
|
|
256
|
+
# @option options [Integer] :max_attempts (3)
|
|
257
|
+
# An integer representing the maximum number attempts that will be made for
|
|
258
|
+
# a single request, including the initial attempt. For example,
|
|
259
|
+
# setting this value to 5 will result in a request being retried up to
|
|
260
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
|
261
|
+
#
|
|
262
|
+
# @option options [String] :profile ("default")
|
|
263
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
|
264
|
+
# When not specified, 'default' is used.
|
|
265
|
+
#
|
|
266
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
|
267
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
|
268
|
+
#
|
|
269
|
+
# * `when_supported` - (default) When set, a checksum will be
|
|
270
|
+
# calculated for all request payloads of operations modeled with the
|
|
271
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
|
272
|
+
# `requestAlgorithmMember` is modeled.
|
|
273
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
|
274
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
|
275
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
|
276
|
+
# is modeled and supplied.
|
|
277
|
+
#
|
|
278
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
|
279
|
+
# The minimum size in bytes that triggers compression for request
|
|
280
|
+
# bodies. The value must be non-negative integer value between 0
|
|
281
|
+
# and 10485780 bytes inclusive.
|
|
282
|
+
#
|
|
283
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
|
284
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
|
285
|
+
#
|
|
286
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
|
287
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
|
288
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
|
289
|
+
# are supported.
|
|
290
|
+
# * `when_required` - When set, checksum validation is not performed on
|
|
291
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
|
292
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
|
293
|
+
#
|
|
294
|
+
# @option options [Proc] :retry_backoff
|
|
295
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
|
296
|
+
# This option is only used in the `legacy` retry mode.
|
|
297
|
+
#
|
|
298
|
+
# @option options [Float] :retry_base_delay (0.3)
|
|
299
|
+
# The base delay in seconds used by the default backoff function. This option
|
|
300
|
+
# is only used in the `legacy` retry mode.
|
|
301
|
+
#
|
|
302
|
+
# @option options [Symbol] :retry_jitter (:none)
|
|
303
|
+
# A delay randomiser function used by the default backoff function.
|
|
304
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
|
305
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
|
306
|
+
# in the `legacy` retry mode.
|
|
307
|
+
#
|
|
308
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
|
309
|
+
#
|
|
310
|
+
# @option options [Integer] :retry_limit (3)
|
|
311
|
+
# The maximum number of times to retry failed requests. Only
|
|
312
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
313
|
+
# are retried. Generally, these are throttling errors, data
|
|
314
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
|
315
|
+
# endpoint discovery, and errors from expired credentials.
|
|
316
|
+
# This option is only used in the `legacy` retry mode.
|
|
317
|
+
#
|
|
318
|
+
# @option options [Integer] :retry_max_delay (0)
|
|
319
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
|
320
|
+
# used by the default backoff function. This option is only used in the
|
|
321
|
+
# `legacy` retry mode.
|
|
322
|
+
#
|
|
323
|
+
# @option options [String] :retry_mode ("legacy")
|
|
324
|
+
# Specifies which retry algorithm to use. Values are:
|
|
325
|
+
#
|
|
326
|
+
# * `legacy` - The pre-existing retry behavior. This is the default
|
|
327
|
+
# value if no retry mode is provided.
|
|
328
|
+
#
|
|
329
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
|
330
|
+
# This includes support for retry quotas, which limit the number of
|
|
331
|
+
# unsuccessful retries a client can make.
|
|
332
|
+
#
|
|
333
|
+
# * `adaptive` - A retry mode that includes all the functionality of
|
|
334
|
+
# `standard` mode along with automatic client side throttling.
|
|
335
|
+
#
|
|
336
|
+
# @option options [String] :sdk_ua_app_id
|
|
337
|
+
# A unique and opaque application ID that is appended to the
|
|
338
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
|
339
|
+
# maximum length of 50. This variable is sourced from environment
|
|
340
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
|
341
|
+
#
|
|
342
|
+
# @option options [String] :secret_access_key
|
|
343
|
+
#
|
|
344
|
+
# @option options [String] :session_token
|
|
345
|
+
#
|
|
346
|
+
# @option options [Array] :sigv4a_signing_region_set
|
|
347
|
+
# A list of regions that should be signed with SigV4a signing. When
|
|
348
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
|
349
|
+
# in the following locations:
|
|
350
|
+
#
|
|
351
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
|
352
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
|
353
|
+
# * `~/.aws/config`
|
|
354
|
+
#
|
|
355
|
+
# @option options [Boolean] :stub_responses (false)
|
|
356
|
+
# Causes the client to return stubbed responses. By default
|
|
357
|
+
# fake responses are generated and returned. You can specify
|
|
358
|
+
# the response data to return or errors to raise by calling
|
|
359
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
|
360
|
+
#
|
|
361
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
362
|
+
# requests are made, and retries are disabled.
|
|
363
|
+
#
|
|
364
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
|
365
|
+
# Allows you to provide a telemetry provider, which is used to
|
|
366
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
|
367
|
+
# will not record or emit any telemetry data. The SDK supports the
|
|
368
|
+
# following telemetry providers:
|
|
369
|
+
#
|
|
370
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
|
371
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
|
372
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
|
373
|
+
#
|
|
374
|
+
# @option options [Aws::TokenProvider] :token_provider
|
|
375
|
+
# Your Bearer token used for authentication. This can be any class that includes and implements
|
|
376
|
+
# `Aws::TokenProvider`, or instance of any one of the following classes:
|
|
377
|
+
#
|
|
378
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
|
379
|
+
# tokens.
|
|
380
|
+
#
|
|
381
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
|
382
|
+
# access token generated from `aws login`.
|
|
383
|
+
#
|
|
384
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
|
385
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
|
386
|
+
#
|
|
387
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
|
388
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
|
389
|
+
# will be used if available.
|
|
390
|
+
#
|
|
391
|
+
# @option options [Boolean] :use_fips_endpoint
|
|
392
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
|
393
|
+
# When a `fips` region is used, the region is normalized and this config
|
|
394
|
+
# is set to `true`.
|
|
395
|
+
#
|
|
396
|
+
# @option options [Boolean] :validate_params (true)
|
|
397
|
+
# When `true`, request parameters are validated before
|
|
398
|
+
# sending the request.
|
|
399
|
+
#
|
|
400
|
+
# @option options [String] :account_id_endpoint_mode
|
|
401
|
+
# The account ID endpoint mode to use. This can be one of the following values:
|
|
402
|
+
# * `preferred` - The default behavior. Use the account ID endpoint if
|
|
403
|
+
# available, otherwise use the standard endpoint.
|
|
404
|
+
# * `disabled` - Never use the account ID endpoint. Only use the standard
|
|
405
|
+
# endpoint.
|
|
406
|
+
# * `required` - Always use the account ID endpoint. If the account ID
|
|
407
|
+
# cannot be retrieved from credentials, an error is raised.
|
|
408
|
+
#
|
|
409
|
+
# @option options [Aws::EventBridgeV2::EndpointProvider] :endpoint_provider
|
|
410
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
|
411
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
|
412
|
+
# `Aws::EventBridgeV2::EndpointParameters`.
|
|
413
|
+
#
|
|
414
|
+
# @option options [Float] :http_continue_timeout (1)
|
|
415
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
|
416
|
+
# request body. This option has no effect unless the request has "Expect"
|
|
417
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
|
418
|
+
# behaviour. This value can safely be set per request on the session.
|
|
419
|
+
#
|
|
420
|
+
# @option options [Float] :http_idle_timeout (5)
|
|
421
|
+
# The number of seconds a connection is allowed to sit idle before it
|
|
422
|
+
# is considered stale. Stale connections are closed and removed from the
|
|
423
|
+
# pool before making a request.
|
|
424
|
+
#
|
|
425
|
+
# @option options [Float] :http_open_timeout (15)
|
|
426
|
+
# The default number of seconds to wait for response data.
|
|
427
|
+
# This value can safely be set per-request on the session.
|
|
428
|
+
#
|
|
429
|
+
# @option options [URI::HTTP,String] :http_proxy
|
|
430
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
|
431
|
+
#
|
|
432
|
+
# @option options [Float] :http_read_timeout (60)
|
|
433
|
+
# The default number of seconds to wait for response data.
|
|
434
|
+
# This value can safely be set per-request on the session.
|
|
435
|
+
#
|
|
436
|
+
# @option options [Boolean] :http_wire_trace (false)
|
|
437
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
|
438
|
+
#
|
|
439
|
+
# @option options [Proc] :on_chunk_received
|
|
440
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
441
|
+
# of the response body is received. It provides three arguments: the chunk,
|
|
442
|
+
# the number of bytes received, and the total number of
|
|
443
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
|
444
|
+
#
|
|
445
|
+
# @option options [Proc] :on_chunk_sent
|
|
446
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
447
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
|
448
|
+
# the number of bytes read from the body, and the total number of
|
|
449
|
+
# bytes in the body.
|
|
450
|
+
#
|
|
451
|
+
# @option options [Boolean] :raise_response_errors (true)
|
|
452
|
+
# When `true`, response errors are raised.
|
|
453
|
+
#
|
|
454
|
+
# @option options [String] :ssl_ca_bundle
|
|
455
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
|
456
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
|
457
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
|
458
|
+
#
|
|
459
|
+
# @option options [String] :ssl_ca_directory
|
|
460
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
|
461
|
+
# authority files for verifying peer certificates. If you do
|
|
462
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
|
463
|
+
# default will be used if available.
|
|
464
|
+
#
|
|
465
|
+
# @option options [String] :ssl_ca_store
|
|
466
|
+
# Sets the X509::Store to verify peer certificate.
|
|
467
|
+
#
|
|
468
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
|
469
|
+
# Sets a client certificate when creating http connections.
|
|
470
|
+
#
|
|
471
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
|
472
|
+
# Sets a client key when creating http connections.
|
|
473
|
+
#
|
|
474
|
+
# @option options [Float] :ssl_timeout
|
|
475
|
+
# Sets the SSL timeout in seconds
|
|
476
|
+
#
|
|
477
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
|
478
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
|
479
|
+
#
|
|
480
|
+
def initialize(*args)
|
|
481
|
+
super
|
|
482
|
+
end
|
|
483
|
+
|
|
484
|
+
# @!group API Operations
|
|
485
|
+
|
|
486
|
+
# Creates an event bus. Provisioning is asynchronous: the bus is
|
|
487
|
+
# returned in the CREATING state and transitions to ACTIVE when ready
|
|
488
|
+
# (see the EventBusActive waiter). Retries carrying the same ClientToken
|
|
489
|
+
# are idempotent.
|
|
490
|
+
#
|
|
491
|
+
# @option params [required, String] :name
|
|
492
|
+
# Name of an event bus. The first character must be alphanumeric; the
|
|
493
|
+
# remaining characters may also include '.', '-', and '\_'. The
|
|
494
|
+
# grammar matches the name segment of EventBusArn
|
|
495
|
+
# (event-busv2/<name>/<id>), so every valid name can be represented in
|
|
496
|
+
# the bus's ARN. The same type is used everywhere a bus name
|
|
497
|
+
# appears.</p> </id></name>
|
|
498
|
+
#
|
|
499
|
+
# @option params [String] :description
|
|
500
|
+
# Free-text description. Used by every resource type that has one: event
|
|
501
|
+
# buses, subscribers, and event sources.
|
|
502
|
+
#
|
|
503
|
+
# @option params [Types::EncryptionConfiguration] :encryption_configuration
|
|
504
|
+
# Encryption configuration for an event bus.
|
|
505
|
+
#
|
|
506
|
+
# @option params [Types::StorageConfiguration] :storage_configuration
|
|
507
|
+
# Event storage configuration for an event bus.
|
|
508
|
+
#
|
|
509
|
+
# @option params [Hash<String,String>] :tags
|
|
510
|
+
# Tags attached to a resource, as key-value pairs.
|
|
511
|
+
#
|
|
512
|
+
# @option params [String] :client_token
|
|
513
|
+
# Unique, case-sensitive identifier that ensures the idempotency of the
|
|
514
|
+
# request. The SDK generates one automatically when the field is
|
|
515
|
+
# omitted.
|
|
516
|
+
#
|
|
517
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
518
|
+
# not need to pass this option.**
|
|
519
|
+
#
|
|
520
|
+
# @return [Types::CreateEventBusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
521
|
+
#
|
|
522
|
+
# * {Types::CreateEventBusResponse#event_bus_arn #event_bus_arn} => String
|
|
523
|
+
# * {Types::CreateEventBusResponse#name #name} => String
|
|
524
|
+
# * {Types::CreateEventBusResponse#description #description} => String
|
|
525
|
+
# * {Types::CreateEventBusResponse#encryption_configuration #encryption_configuration} => Types::EncryptionConfiguration
|
|
526
|
+
# * {Types::CreateEventBusResponse#storage_configuration #storage_configuration} => Types::StorageConfigurationOutput
|
|
527
|
+
# * {Types::CreateEventBusResponse#state #state} => String
|
|
528
|
+
# * {Types::CreateEventBusResponse#state_reason #state_reason} => String
|
|
529
|
+
# * {Types::CreateEventBusResponse#creation_time #creation_time} => Time
|
|
530
|
+
#
|
|
531
|
+
# @example Request syntax with placeholder values
|
|
532
|
+
#
|
|
533
|
+
# resp = client.create_event_bus({
|
|
534
|
+
# name: "EventBusName", # required
|
|
535
|
+
# description: "Description",
|
|
536
|
+
# encryption_configuration: {
|
|
537
|
+
# kms_key_identifier: "KmsKeyIdentifier",
|
|
538
|
+
# },
|
|
539
|
+
# storage_configuration: {
|
|
540
|
+
# retention_period_in_days: 1,
|
|
541
|
+
# },
|
|
542
|
+
# tags: {
|
|
543
|
+
# "TagKey" => "TagValue",
|
|
544
|
+
# },
|
|
545
|
+
# client_token: "ClientToken",
|
|
546
|
+
# })
|
|
547
|
+
#
|
|
548
|
+
# @example Response structure
|
|
549
|
+
#
|
|
550
|
+
# resp.event_bus_arn #=> String
|
|
551
|
+
# resp.name #=> String
|
|
552
|
+
# resp.description #=> String
|
|
553
|
+
# resp.encryption_configuration.kms_key_identifier #=> String
|
|
554
|
+
# resp.storage_configuration.retention_period_in_days #=> Integer
|
|
555
|
+
# resp.storage_configuration.retention_window_start_time #=> Time
|
|
556
|
+
# resp.state #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "ACTIVE", "DELETE_FAILED"
|
|
557
|
+
# resp.state_reason #=> String
|
|
558
|
+
# resp.creation_time #=> Time
|
|
559
|
+
#
|
|
560
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/CreateEventBus AWS API Documentation
|
|
561
|
+
#
|
|
562
|
+
# @overload create_event_bus(params = {})
|
|
563
|
+
# @param [Hash] params ({})
|
|
564
|
+
def create_event_bus(params = {}, options = {})
|
|
565
|
+
req = build_request(:create_event_bus, params)
|
|
566
|
+
req.send_request(options)
|
|
567
|
+
end
|
|
568
|
+
|
|
569
|
+
# Creates an EventSource, which forwards events from an origin (an AWS
|
|
570
|
+
# service or another account) onto an event bus. The bus must be ACTIVE.
|
|
571
|
+
# Retries carrying the same ClientToken are idempotent.
|
|
572
|
+
#
|
|
573
|
+
# @option params [required, String] :name
|
|
574
|
+
# EventSource name. First character alphanumeric; the rest may add
|
|
575
|
+
# '.', '-', '\_'. Names may not begin with the reserved "aws."
|
|
576
|
+
# prefix. The grammar matches the ARN local-name segment in
|
|
577
|
+
# EventSourceArn (event-sourcev2/<type>/<name>/<id>), mirroring
|
|
578
|
+
# EventBusName, so a name the ARN cannot represent cannot be
|
|
579
|
+
# created.</p> </id></name></type>
|
|
580
|
+
#
|
|
581
|
+
# @option params [required, String] :event_bus_arn
|
|
582
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
583
|
+
#
|
|
584
|
+
# @option params [required, Types::EventSourceConfiguration] :configuration
|
|
585
|
+
# Discriminated EventSource configuration. Exactly one variant must be
|
|
586
|
+
# set.
|
|
587
|
+
#
|
|
588
|
+
# @option params [String] :description
|
|
589
|
+
# Free-text description. Used by every resource type that has one: event
|
|
590
|
+
# buses, subscribers, and event sources.
|
|
591
|
+
#
|
|
592
|
+
# @option params [Hash<String,String>] :tags
|
|
593
|
+
# Tags attached to a resource, as key-value pairs.
|
|
594
|
+
#
|
|
595
|
+
# @option params [String] :client_token
|
|
596
|
+
# Unique, case-sensitive identifier that ensures the idempotency of the
|
|
597
|
+
# request. The SDK generates one automatically when the field is
|
|
598
|
+
# omitted.
|
|
599
|
+
#
|
|
600
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
601
|
+
# not need to pass this option.**
|
|
602
|
+
#
|
|
603
|
+
# @return [Types::CreateEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
604
|
+
#
|
|
605
|
+
# * {Types::CreateEventSourceResponse#event_source_arn #event_source_arn} => String
|
|
606
|
+
# * {Types::CreateEventSourceResponse#name #name} => String
|
|
607
|
+
# * {Types::CreateEventSourceResponse#event_bus_arn #event_bus_arn} => String
|
|
608
|
+
# * {Types::CreateEventSourceResponse#state #state} => String
|
|
609
|
+
# * {Types::CreateEventSourceResponse#creation_time #creation_time} => Time
|
|
610
|
+
#
|
|
611
|
+
# @example Request syntax with placeholder values
|
|
612
|
+
#
|
|
613
|
+
# resp = client.create_event_source({
|
|
614
|
+
# name: "EventSourceName", # required
|
|
615
|
+
# event_bus_arn: "EventBusArn", # required
|
|
616
|
+
# configuration: { # required
|
|
617
|
+
# aws_service_events_configuration: {
|
|
618
|
+
# aws_service: "AwsServiceSource", # required
|
|
619
|
+
# pattern: "AwsServiceEventsSourceConfigurationPatternString",
|
|
620
|
+
# on_failure_configuration: {
|
|
621
|
+
# arn: "DeadLetterQueueArn",
|
|
622
|
+
# },
|
|
623
|
+
# },
|
|
624
|
+
# partner_events_configuration: {
|
|
625
|
+
# partner_event_source_arn: "PartnerEventSourceArn", # required
|
|
626
|
+
# pattern: "PartnerEventsSourceConfigurationPatternString",
|
|
627
|
+
# partner_bus_kms_key_identifier: "KmsKeyIdentifier",
|
|
628
|
+
# on_failure_configuration: {
|
|
629
|
+
# arn: "DeadLetterQueueArn",
|
|
630
|
+
# },
|
|
631
|
+
# },
|
|
632
|
+
# },
|
|
633
|
+
# description: "Description",
|
|
634
|
+
# tags: {
|
|
635
|
+
# "TagKey" => "TagValue",
|
|
636
|
+
# },
|
|
637
|
+
# client_token: "ClientToken",
|
|
638
|
+
# })
|
|
639
|
+
#
|
|
640
|
+
# @example Response structure
|
|
641
|
+
#
|
|
642
|
+
# resp.event_source_arn #=> String
|
|
643
|
+
# resp.name #=> String
|
|
644
|
+
# resp.event_bus_arn #=> String
|
|
645
|
+
# resp.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
|
|
646
|
+
# resp.creation_time #=> Time
|
|
647
|
+
#
|
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/CreateEventSource AWS API Documentation
|
|
649
|
+
#
|
|
650
|
+
# @overload create_event_source(params = {})
|
|
651
|
+
# @param [Hash] params ({})
|
|
652
|
+
def create_event_source(params = {}, options = {})
|
|
653
|
+
req = build_request(:create_event_source, params)
|
|
654
|
+
req.send_request(options)
|
|
655
|
+
end
|
|
656
|
+
|
|
657
|
+
# Creates a subscriber on an event bus, which delivers matching events
|
|
658
|
+
# to the configured target. The bus must be ACTIVE. Retries carrying the
|
|
659
|
+
# same ClientToken are idempotent.
|
|
660
|
+
#
|
|
661
|
+
# @option params [required, String] :name
|
|
662
|
+
# Name of a subscriber. The first character must be alphanumeric; the
|
|
663
|
+
# remaining characters may also include '.', '-', and '\_'.
|
|
664
|
+
#
|
|
665
|
+
# @option params [required, String] :event_bus_arn
|
|
666
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
667
|
+
#
|
|
668
|
+
# @option params [required, Types::InvokeConfiguration] :invoke_configuration
|
|
669
|
+
# Configuration for how the subscriber invokes its target.
|
|
670
|
+
#
|
|
671
|
+
# @option params [String] :description
|
|
672
|
+
# Free-text description. Used by every resource type that has one: event
|
|
673
|
+
# buses, subscribers, and event sources.
|
|
674
|
+
#
|
|
675
|
+
# @option params [Types::FilterConfiguration] :filter_configuration
|
|
676
|
+
# Configuration for filtering events delivered to a subscriber. On
|
|
677
|
+
# CreateSubscriber, Filters is required and must contain at least one
|
|
678
|
+
# Filter with a non-empty Pattern. On UpdateSubscriber, an empty
|
|
679
|
+
# `FilterConfiguration:{}` clears the existing filter. Any non-empty
|
|
680
|
+
# shape (including `{Language:X}` without Filters) must contain a valid
|
|
681
|
+
# Filters list — same contract as CreateSubscriber. A non-empty Filters
|
|
682
|
+
# list overwrites; an omitted FilterConfiguration preserves existing
|
|
683
|
+
# state. All Filters are implicitly ANDed — an event must match every
|
|
684
|
+
# Filter to be delivered.
|
|
685
|
+
#
|
|
686
|
+
# @option params [String] :type
|
|
687
|
+
# Delivery ordering mode of a subscriber: FIFO delivers events in order
|
|
688
|
+
# within an event group; UNORDERED delivers without an ordering
|
|
689
|
+
# guarantee.
|
|
690
|
+
#
|
|
691
|
+
# @option params [String] :starting_position
|
|
692
|
+
# Starting position for a subscriber.
|
|
693
|
+
#
|
|
694
|
+
# @option params [Types::PointInTimeConfiguration] :point_in_time_configuration
|
|
695
|
+
# Point-in-time configuration for a subscriber. Only applicable when
|
|
696
|
+
# StartingPosition is POINT\_IN\_TIME.
|
|
697
|
+
#
|
|
698
|
+
# @option params [Types::BatchConfiguration] :batch_configuration
|
|
699
|
+
# Batching configuration for a subscriber.
|
|
700
|
+
#
|
|
701
|
+
# @option params [Types::Transformer] :transformer
|
|
702
|
+
# Not applicable to universal (aws-sdk) targets, whose input
|
|
703
|
+
# transformation is UniversalTargetParameters.Input; a Transformer on
|
|
704
|
+
# such a target is rejected.
|
|
705
|
+
#
|
|
706
|
+
# @option params [Types::RetryPolicy] :retry_policy
|
|
707
|
+
# Retry policy for a subscriber.
|
|
708
|
+
#
|
|
709
|
+
# @option params [Types::OnFailureConfiguration] :on_failure_configuration
|
|
710
|
+
# On-failure configuration: where a failed delivery is sent. Shared by
|
|
711
|
+
# the subscriber and the EventSource.
|
|
712
|
+
#
|
|
713
|
+
# @option params [Types::LogConfiguration] :log_configuration
|
|
714
|
+
# Log configuration for a subscriber.
|
|
715
|
+
#
|
|
716
|
+
# @option params [String] :state
|
|
717
|
+
# Customer-controlled run state of a subscriber, set on create or
|
|
718
|
+
# update. Distinct from the bus lifecycle vocabulary, where ACTIVE means
|
|
719
|
+
# "provisioned and healthy". Delivery requires State RUNNING on a
|
|
720
|
+
# subscriber that is not revoked.
|
|
721
|
+
#
|
|
722
|
+
# @option params [Hash<String,String>] :tags
|
|
723
|
+
# Tags attached to a resource, as key-value pairs.
|
|
724
|
+
#
|
|
725
|
+
# @option params [String] :client_token
|
|
726
|
+
# Unique, case-sensitive identifier that ensures the idempotency of the
|
|
727
|
+
# request. The SDK generates one automatically when the field is
|
|
728
|
+
# omitted.
|
|
729
|
+
#
|
|
730
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
731
|
+
# not need to pass this option.**
|
|
732
|
+
#
|
|
733
|
+
# @return [Types::CreateSubscriberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
734
|
+
#
|
|
735
|
+
# * {Types::CreateSubscriberResponse#subscriber_arn #subscriber_arn} => String
|
|
736
|
+
# * {Types::CreateSubscriberResponse#name #name} => String
|
|
737
|
+
# * {Types::CreateSubscriberResponse#event_bus_arn #event_bus_arn} => String
|
|
738
|
+
# * {Types::CreateSubscriberResponse#type #type} => String
|
|
739
|
+
# * {Types::CreateSubscriberResponse#starting_position #starting_position} => String
|
|
740
|
+
# * {Types::CreateSubscriberResponse#point_in_time_configuration #point_in_time_configuration} => Types::PointInTimeConfiguration
|
|
741
|
+
# * {Types::CreateSubscriberResponse#state #state} => String
|
|
742
|
+
# * {Types::CreateSubscriberResponse#creation_time #creation_time} => Time
|
|
743
|
+
#
|
|
744
|
+
# @example Request syntax with placeholder values
|
|
745
|
+
#
|
|
746
|
+
# resp = client.create_subscriber({
|
|
747
|
+
# name: "SubscriberName", # required
|
|
748
|
+
# event_bus_arn: "EventBusArn", # required
|
|
749
|
+
# invoke_configuration: { # required
|
|
750
|
+
# role_arn: "RoleArn", # required
|
|
751
|
+
# lambda_parameters: {
|
|
752
|
+
# invocation_type: "EVENT", # accepts EVENT, REQUEST_RESPONSE
|
|
753
|
+
# qualifier: "LambdaParametersQualifierString",
|
|
754
|
+
# durable_execution_name: "LambdaParametersDurableExecutionNameString",
|
|
755
|
+
# tenant_id: "LambdaParametersTenantIdString",
|
|
756
|
+
# invocation_timeout_seconds: "LambdaParametersInvocationTimeoutSecondsString",
|
|
757
|
+
# },
|
|
758
|
+
# sqs_parameters: {
|
|
759
|
+
# message_group_id: "SqsParametersMessageGroupIdString",
|
|
760
|
+
# message_deduplication_id: "SqsParametersMessageDeduplicationIdString",
|
|
761
|
+
# delay_seconds: "SqsParametersDelaySecondsString",
|
|
762
|
+
# message_attributes: {
|
|
763
|
+
# "MessageAttributeName" => {
|
|
764
|
+
# data_type: "SqsMessageAttributeValueDataTypeString",
|
|
765
|
+
# string_value: "String",
|
|
766
|
+
# binary_value: "String",
|
|
767
|
+
# },
|
|
768
|
+
# },
|
|
769
|
+
# message_system_attributes: {
|
|
770
|
+
# "MessageAttributeName" => {
|
|
771
|
+
# data_type: "SqsMessageAttributeValueDataTypeString",
|
|
772
|
+
# string_value: "String",
|
|
773
|
+
# binary_value: "String",
|
|
774
|
+
# },
|
|
775
|
+
# },
|
|
776
|
+
# },
|
|
777
|
+
# sns_parameters: {
|
|
778
|
+
# message_group_id: "SnsParametersMessageGroupIdString",
|
|
779
|
+
# message_deduplication_id: "SnsParametersMessageDeduplicationIdString",
|
|
780
|
+
# subject: "SnsParametersSubjectString",
|
|
781
|
+
# message_structure: "SnsParametersMessageStructureString",
|
|
782
|
+
# message_attributes: {
|
|
783
|
+
# "MessageAttributeName" => {
|
|
784
|
+
# data_type: "SnsMessageAttributeValueDataTypeString",
|
|
785
|
+
# string_value: "String",
|
|
786
|
+
# binary_value: "String",
|
|
787
|
+
# },
|
|
788
|
+
# },
|
|
789
|
+
# },
|
|
790
|
+
# kinesis_parameters: {
|
|
791
|
+
# partition_key: "KinesisParametersPartitionKeyString",
|
|
792
|
+
# explicit_hash_key: "KinesisParametersExplicitHashKeyString",
|
|
793
|
+
# },
|
|
794
|
+
# step_functions_parameters: {
|
|
795
|
+
# invocation_type: "EVENT", # accepts EVENT, REQUEST_RESPONSE
|
|
796
|
+
# name: "StepFunctionsParametersNameString",
|
|
797
|
+
# trace_header: "StepFunctionsParametersTraceHeaderString",
|
|
798
|
+
# invocation_timeout_seconds: "StepFunctionsParametersInvocationTimeoutSecondsString",
|
|
799
|
+
# },
|
|
800
|
+
# http_parameters: {
|
|
801
|
+
# path_parameter_values: ["PathParameter"],
|
|
802
|
+
# header_parameters: {
|
|
803
|
+
# "HeaderKey" => "HeaderValue",
|
|
804
|
+
# },
|
|
805
|
+
# query_string_parameters: {
|
|
806
|
+
# "QueryStringKey" => "QueryStringValue",
|
|
807
|
+
# },
|
|
808
|
+
# invocation_timeout_seconds: "String",
|
|
809
|
+
# },
|
|
810
|
+
# universal_target_parameters: {
|
|
811
|
+
# input: "UniversalTargetInput", # required
|
|
812
|
+
# invocation_timeout_seconds: "String",
|
|
813
|
+
# },
|
|
814
|
+
# event_bus_v2_parameters: {
|
|
815
|
+
# metadata: {
|
|
816
|
+
# "String" => "String",
|
|
817
|
+
# },
|
|
818
|
+
# system_metadata: {
|
|
819
|
+
# event_group_id: "String",
|
|
820
|
+
# deduplication_id: "String",
|
|
821
|
+
# },
|
|
822
|
+
# deduplication_configuration: {
|
|
823
|
+
# deduplication_type: "CONTENT_BASED", # required, accepts CONTENT_BASED
|
|
824
|
+
# },
|
|
825
|
+
# },
|
|
826
|
+
# target_arn: "TargetResourceArn", # required
|
|
827
|
+
# },
|
|
828
|
+
# description: "Description",
|
|
829
|
+
# filter_configuration: {
|
|
830
|
+
# language: "EVENT_BRIDGE_PATTERN", # accepts EVENT_BRIDGE_PATTERN
|
|
831
|
+
# filters: [
|
|
832
|
+
# {
|
|
833
|
+
# pattern: "EventPattern", # required
|
|
834
|
+
# scope: "DATA", # required, accepts DATA, METADATA, SYSTEM_METADATA
|
|
835
|
+
# },
|
|
836
|
+
# ],
|
|
837
|
+
# },
|
|
838
|
+
# type: "FIFO", # accepts FIFO, UNORDERED
|
|
839
|
+
# starting_position: "LATEST", # accepts LATEST, POINT_IN_TIME
|
|
840
|
+
# point_in_time_configuration: {
|
|
841
|
+
# point_type: "HORIZON", # required, accepts HORIZON, TIMESTAMP
|
|
842
|
+
# starting_point: Time.now,
|
|
843
|
+
# end_point: Time.now,
|
|
844
|
+
# },
|
|
845
|
+
# batch_configuration: {
|
|
846
|
+
# max_batch_size: 1,
|
|
847
|
+
# max_batch_window_in_seconds: 1,
|
|
848
|
+
# },
|
|
849
|
+
# transformer: {
|
|
850
|
+
# type: "RAW", # accepts RAW, WITH_METADATA, JSONATA
|
|
851
|
+
# jsonata_configuration: {
|
|
852
|
+
# expression: "JsonataConfigurationExpressionString", # required
|
|
853
|
+
# },
|
|
854
|
+
# },
|
|
855
|
+
# retry_policy: {
|
|
856
|
+
# max_retry_attempts: 1,
|
|
857
|
+
# max_event_age_in_seconds: 1,
|
|
858
|
+
# retry_strategy: "ALL", # accepts ALL
|
|
859
|
+
# },
|
|
860
|
+
# on_failure_configuration: {
|
|
861
|
+
# arn: "DeadLetterQueueArn",
|
|
862
|
+
# },
|
|
863
|
+
# log_configuration: {
|
|
864
|
+
# level: "OFF", # accepts OFF, ERROR, INFO
|
|
865
|
+
# include_payload: "FULL", # accepts FULL, ON_ERROR_ONLY
|
|
866
|
+
# },
|
|
867
|
+
# state: "RUNNING", # accepts RUNNING, STOPPED
|
|
868
|
+
# tags: {
|
|
869
|
+
# "TagKey" => "TagValue",
|
|
870
|
+
# },
|
|
871
|
+
# client_token: "ClientToken",
|
|
872
|
+
# })
|
|
873
|
+
#
|
|
874
|
+
# @example Response structure
|
|
875
|
+
#
|
|
876
|
+
# resp.subscriber_arn #=> String
|
|
877
|
+
# resp.name #=> String
|
|
878
|
+
# resp.event_bus_arn #=> String
|
|
879
|
+
# resp.type #=> String, one of "FIFO", "UNORDERED"
|
|
880
|
+
# resp.starting_position #=> String, one of "LATEST", "POINT_IN_TIME"
|
|
881
|
+
# resp.point_in_time_configuration.point_type #=> String, one of "HORIZON", "TIMESTAMP"
|
|
882
|
+
# resp.point_in_time_configuration.starting_point #=> Time
|
|
883
|
+
# resp.point_in_time_configuration.end_point #=> Time
|
|
884
|
+
# resp.state #=> String, one of "RUNNING", "STOPPED"
|
|
885
|
+
# resp.creation_time #=> Time
|
|
886
|
+
#
|
|
887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/CreateSubscriber AWS API Documentation
|
|
888
|
+
#
|
|
889
|
+
# @overload create_subscriber(params = {})
|
|
890
|
+
# @param [Hash] params ({})
|
|
891
|
+
def create_subscriber(params = {}, options = {})
|
|
892
|
+
req = build_request(:create_subscriber, params)
|
|
893
|
+
req.send_request(options)
|
|
894
|
+
end
|
|
895
|
+
|
|
896
|
+
# Deletes an event bus. Deletion is asynchronous: the bus moves to
|
|
897
|
+
# DELETING and disappears when complete (see the EventBusDeleted
|
|
898
|
+
# waiter). A bus with subscribers or event sources cannot be deleted.
|
|
899
|
+
#
|
|
900
|
+
# @option params [required, String] :event_bus_arn
|
|
901
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
902
|
+
#
|
|
903
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
904
|
+
#
|
|
905
|
+
# @example Request syntax with placeholder values
|
|
906
|
+
#
|
|
907
|
+
# resp = client.delete_event_bus({
|
|
908
|
+
# event_bus_arn: "EventBusArn", # required
|
|
909
|
+
# })
|
|
910
|
+
#
|
|
911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteEventBus AWS API Documentation
|
|
912
|
+
#
|
|
913
|
+
# @overload delete_event_bus(params = {})
|
|
914
|
+
# @param [Hash] params ({})
|
|
915
|
+
def delete_event_bus(params = {}, options = {})
|
|
916
|
+
req = build_request(:delete_event_bus, params)
|
|
917
|
+
req.send_request(options)
|
|
918
|
+
end
|
|
919
|
+
|
|
920
|
+
# Deletes an EventSource. Forwarding from its origin stops.
|
|
921
|
+
#
|
|
922
|
+
# @option params [required, String] :event_source_arn
|
|
923
|
+
# EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment
|
|
924
|
+
# is set by the service (aws.service for AWS service events, aws.partner
|
|
925
|
+
# for partner events) and is not part of the resource's name. The id
|
|
926
|
+
# segment is a 25-character identifier generated by the service.</p>
|
|
927
|
+
# </id></name></type>
|
|
928
|
+
#
|
|
929
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
930
|
+
#
|
|
931
|
+
# @example Request syntax with placeholder values
|
|
932
|
+
#
|
|
933
|
+
# resp = client.delete_event_source({
|
|
934
|
+
# event_source_arn: "EventSourceArn", # required
|
|
935
|
+
# })
|
|
936
|
+
#
|
|
937
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteEventSource AWS API Documentation
|
|
938
|
+
#
|
|
939
|
+
# @overload delete_event_source(params = {})
|
|
940
|
+
# @param [Hash] params ({})
|
|
941
|
+
def delete_event_source(params = {}, options = {})
|
|
942
|
+
req = build_request(:delete_event_source, params)
|
|
943
|
+
req.send_request(options)
|
|
944
|
+
end
|
|
945
|
+
|
|
946
|
+
# Deletes the named resource policy attached to an event bus.
|
|
947
|
+
#
|
|
948
|
+
# @option params [required, String] :resource_arn
|
|
949
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
950
|
+
#
|
|
951
|
+
# @option params [String] :policy_name
|
|
952
|
+
# Which named policy to delete. Defaults to "default" when omitted (a
|
|
953
|
+
# delete AWS Resource Access Manager makes on the owner's behalf
|
|
954
|
+
# resolves to "AWS\_RAM" instead). The two writers are exclusive in both
|
|
955
|
+
# directions — only Resource Access Manager can delete "AWS\_RAM", and
|
|
956
|
+
# only the bus owner can delete "default" — so naming the other party's
|
|
957
|
+
# policy fails with AccessDeniedException. A well-formed name that is
|
|
958
|
+
# neither of the two fails with InvalidInputException.
|
|
959
|
+
#
|
|
960
|
+
# @option params [String] :expected_revision_id
|
|
961
|
+
# The delete succeeds only if the named policy's current revision ID
|
|
962
|
+
# matches this value; if it differs or the policy does not exist, the
|
|
963
|
+
# operation fails with ConflictException. The "NO\_POLICY" sentinel is
|
|
964
|
+
# not valid here. When omitted, deleting an absent policy is an
|
|
965
|
+
# idempotent success. Supplying this value makes the delete
|
|
966
|
+
# non-idempotent: once it succeeds the expected revision no longer
|
|
967
|
+
# exists, so retrying an unanswered request fails with ConflictException
|
|
968
|
+
# even though the policy was deleted. To establish the outcome, read the
|
|
969
|
+
# policy back: ResourceNotFoundException means the delete took effect.
|
|
970
|
+
#
|
|
971
|
+
# @return [Types::DeleteResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
972
|
+
#
|
|
973
|
+
# * {Types::DeleteResourcePolicyResponse#revision_id #revision_id} => String
|
|
974
|
+
#
|
|
975
|
+
# @example Request syntax with placeholder values
|
|
976
|
+
#
|
|
977
|
+
# resp = client.delete_resource_policy({
|
|
978
|
+
# resource_arn: "EventBusArn", # required
|
|
979
|
+
# policy_name: "PolicyName",
|
|
980
|
+
# expected_revision_id: "PolicyRevisionId",
|
|
981
|
+
# })
|
|
982
|
+
#
|
|
983
|
+
# @example Response structure
|
|
984
|
+
#
|
|
985
|
+
# resp.revision_id #=> String
|
|
986
|
+
#
|
|
987
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteResourcePolicy AWS API Documentation
|
|
988
|
+
#
|
|
989
|
+
# @overload delete_resource_policy(params = {})
|
|
990
|
+
# @param [Hash] params ({})
|
|
991
|
+
def delete_resource_policy(params = {}, options = {})
|
|
992
|
+
req = build_request(:delete_resource_policy, params)
|
|
993
|
+
req.send_request(options)
|
|
994
|
+
end
|
|
995
|
+
|
|
996
|
+
# Deletes a subscriber. Events are no longer delivered to its target.
|
|
997
|
+
#
|
|
998
|
+
# @option params [required, String] :subscriber_arn
|
|
999
|
+
# The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
|
|
1000
|
+
#
|
|
1001
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1002
|
+
#
|
|
1003
|
+
# @example Request syntax with placeholder values
|
|
1004
|
+
#
|
|
1005
|
+
# resp = client.delete_subscriber({
|
|
1006
|
+
# subscriber_arn: "SubscriberArn", # required
|
|
1007
|
+
# })
|
|
1008
|
+
#
|
|
1009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteSubscriber AWS API Documentation
|
|
1010
|
+
#
|
|
1011
|
+
# @overload delete_subscriber(params = {})
|
|
1012
|
+
# @param [Hash] params ({})
|
|
1013
|
+
def delete_subscriber(params = {}, options = {})
|
|
1014
|
+
req = build_request(:delete_subscriber, params)
|
|
1015
|
+
req.send_request(options)
|
|
1016
|
+
end
|
|
1017
|
+
|
|
1018
|
+
# Returns the full configuration and lifecycle state of an event bus.
|
|
1019
|
+
#
|
|
1020
|
+
# @option params [required, String] :event_bus_arn
|
|
1021
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
1022
|
+
#
|
|
1023
|
+
# @return [Types::DescribeEventBusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1024
|
+
#
|
|
1025
|
+
# * {Types::DescribeEventBusResponse#event_bus_arn #event_bus_arn} => String
|
|
1026
|
+
# * {Types::DescribeEventBusResponse#name #name} => String
|
|
1027
|
+
# * {Types::DescribeEventBusResponse#description #description} => String
|
|
1028
|
+
# * {Types::DescribeEventBusResponse#encryption_configuration #encryption_configuration} => Types::EncryptionConfiguration
|
|
1029
|
+
# * {Types::DescribeEventBusResponse#storage_configuration #storage_configuration} => Types::StorageConfigurationOutput
|
|
1030
|
+
# * {Types::DescribeEventBusResponse#creation_time #creation_time} => Time
|
|
1031
|
+
# * {Types::DescribeEventBusResponse#last_modified_time #last_modified_time} => Time
|
|
1032
|
+
# * {Types::DescribeEventBusResponse#state #state} => String
|
|
1033
|
+
# * {Types::DescribeEventBusResponse#state_reason #state_reason} => String
|
|
1034
|
+
#
|
|
1035
|
+
# @example Request syntax with placeholder values
|
|
1036
|
+
#
|
|
1037
|
+
# resp = client.describe_event_bus({
|
|
1038
|
+
# event_bus_arn: "EventBusArn", # required
|
|
1039
|
+
# })
|
|
1040
|
+
#
|
|
1041
|
+
# @example Response structure
|
|
1042
|
+
#
|
|
1043
|
+
# resp.event_bus_arn #=> String
|
|
1044
|
+
# resp.name #=> String
|
|
1045
|
+
# resp.description #=> String
|
|
1046
|
+
# resp.encryption_configuration.kms_key_identifier #=> String
|
|
1047
|
+
# resp.storage_configuration.retention_period_in_days #=> Integer
|
|
1048
|
+
# resp.storage_configuration.retention_window_start_time #=> Time
|
|
1049
|
+
# resp.creation_time #=> Time
|
|
1050
|
+
# resp.last_modified_time #=> Time
|
|
1051
|
+
# resp.state #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "ACTIVE", "DELETE_FAILED"
|
|
1052
|
+
# resp.state_reason #=> String
|
|
1053
|
+
#
|
|
1054
|
+
#
|
|
1055
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
|
1056
|
+
#
|
|
1057
|
+
# * event_bus_active
|
|
1058
|
+
# * event_bus_deleted
|
|
1059
|
+
#
|
|
1060
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DescribeEventBus AWS API Documentation
|
|
1061
|
+
#
|
|
1062
|
+
# @overload describe_event_bus(params = {})
|
|
1063
|
+
# @param [Hash] params ({})
|
|
1064
|
+
def describe_event_bus(params = {}, options = {})
|
|
1065
|
+
req = build_request(:describe_event_bus, params)
|
|
1066
|
+
req.send_request(options)
|
|
1067
|
+
end
|
|
1068
|
+
|
|
1069
|
+
# Returns the full configuration and lifecycle state of an EventSource.
|
|
1070
|
+
#
|
|
1071
|
+
# @option params [required, String] :event_source_arn
|
|
1072
|
+
# EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment
|
|
1073
|
+
# is set by the service (aws.service for AWS service events, aws.partner
|
|
1074
|
+
# for partner events) and is not part of the resource's name. The id
|
|
1075
|
+
# segment is a 25-character identifier generated by the service.</p>
|
|
1076
|
+
# </id></name></type>
|
|
1077
|
+
#
|
|
1078
|
+
# @return [Types::DescribeEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1079
|
+
#
|
|
1080
|
+
# * {Types::DescribeEventSourceResponse#event_source_arn #event_source_arn} => String
|
|
1081
|
+
# * {Types::DescribeEventSourceResponse#name #name} => String
|
|
1082
|
+
# * {Types::DescribeEventSourceResponse#event_bus_arn #event_bus_arn} => String
|
|
1083
|
+
# * {Types::DescribeEventSourceResponse#configuration #configuration} => Types::EventSourceConfiguration
|
|
1084
|
+
# * {Types::DescribeEventSourceResponse#description #description} => String
|
|
1085
|
+
# * {Types::DescribeEventSourceResponse#state #state} => String
|
|
1086
|
+
# * {Types::DescribeEventSourceResponse#revoked #revoked} => Boolean
|
|
1087
|
+
# * {Types::DescribeEventSourceResponse#creation_time #creation_time} => Time
|
|
1088
|
+
# * {Types::DescribeEventSourceResponse#last_modified_time #last_modified_time} => Time
|
|
1089
|
+
#
|
|
1090
|
+
# @example Request syntax with placeholder values
|
|
1091
|
+
#
|
|
1092
|
+
# resp = client.describe_event_source({
|
|
1093
|
+
# event_source_arn: "EventSourceArn", # required
|
|
1094
|
+
# })
|
|
1095
|
+
#
|
|
1096
|
+
# @example Response structure
|
|
1097
|
+
#
|
|
1098
|
+
# resp.event_source_arn #=> String
|
|
1099
|
+
# resp.name #=> String
|
|
1100
|
+
# resp.event_bus_arn #=> String
|
|
1101
|
+
# resp.configuration.aws_service_events_configuration.aws_service #=> String
|
|
1102
|
+
# resp.configuration.aws_service_events_configuration.pattern #=> String
|
|
1103
|
+
# resp.configuration.aws_service_events_configuration.on_failure_configuration.arn #=> String
|
|
1104
|
+
# resp.configuration.partner_events_configuration.partner_event_source_arn #=> String
|
|
1105
|
+
# resp.configuration.partner_events_configuration.pattern #=> String
|
|
1106
|
+
# resp.configuration.partner_events_configuration.partner_bus_kms_key_identifier #=> String
|
|
1107
|
+
# resp.configuration.partner_events_configuration.on_failure_configuration.arn #=> String
|
|
1108
|
+
# resp.description #=> String
|
|
1109
|
+
# resp.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
|
|
1110
|
+
# resp.revoked #=> Boolean
|
|
1111
|
+
# resp.creation_time #=> Time
|
|
1112
|
+
# resp.last_modified_time #=> Time
|
|
1113
|
+
#
|
|
1114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DescribeEventSource AWS API Documentation
|
|
1115
|
+
#
|
|
1116
|
+
# @overload describe_event_source(params = {})
|
|
1117
|
+
# @param [Hash] params ({})
|
|
1118
|
+
def describe_event_source(params = {}, options = {})
|
|
1119
|
+
req = build_request(:describe_event_source, params)
|
|
1120
|
+
req.send_request(options)
|
|
1121
|
+
end
|
|
1122
|
+
|
|
1123
|
+
# Returns the full configuration and state of a subscriber.
|
|
1124
|
+
#
|
|
1125
|
+
# @option params [required, String] :subscriber_arn
|
|
1126
|
+
# The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
|
|
1127
|
+
#
|
|
1128
|
+
# @return [Types::DescribeSubscriberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1129
|
+
#
|
|
1130
|
+
# * {Types::DescribeSubscriberResponse#subscriber_arn #subscriber_arn} => String
|
|
1131
|
+
# * {Types::DescribeSubscriberResponse#name #name} => String
|
|
1132
|
+
# * {Types::DescribeSubscriberResponse#event_bus_arn #event_bus_arn} => String
|
|
1133
|
+
# * {Types::DescribeSubscriberResponse#invoke_configuration #invoke_configuration} => Types::InvokeConfiguration
|
|
1134
|
+
# * {Types::DescribeSubscriberResponse#description #description} => String
|
|
1135
|
+
# * {Types::DescribeSubscriberResponse#filter_configuration #filter_configuration} => Types::FilterConfiguration
|
|
1136
|
+
# * {Types::DescribeSubscriberResponse#type #type} => String
|
|
1137
|
+
# * {Types::DescribeSubscriberResponse#starting_position #starting_position} => String
|
|
1138
|
+
# * {Types::DescribeSubscriberResponse#point_in_time_configuration #point_in_time_configuration} => Types::PointInTimeConfiguration
|
|
1139
|
+
# * {Types::DescribeSubscriberResponse#batch_configuration #batch_configuration} => Types::BatchConfiguration
|
|
1140
|
+
# * {Types::DescribeSubscriberResponse#transformer #transformer} => Types::Transformer
|
|
1141
|
+
# * {Types::DescribeSubscriberResponse#retry_policy #retry_policy} => Types::RetryPolicy
|
|
1142
|
+
# * {Types::DescribeSubscriberResponse#on_failure_configuration #on_failure_configuration} => Types::OnFailureConfiguration
|
|
1143
|
+
# * {Types::DescribeSubscriberResponse#log_configuration #log_configuration} => Types::LogConfiguration
|
|
1144
|
+
# * {Types::DescribeSubscriberResponse#state #state} => String
|
|
1145
|
+
# * {Types::DescribeSubscriberResponse#revoked #revoked} => Boolean
|
|
1146
|
+
# * {Types::DescribeSubscriberResponse#creation_time #creation_time} => Time
|
|
1147
|
+
# * {Types::DescribeSubscriberResponse#last_modified_time #last_modified_time} => Time
|
|
1148
|
+
#
|
|
1149
|
+
# @example Request syntax with placeholder values
|
|
1150
|
+
#
|
|
1151
|
+
# resp = client.describe_subscriber({
|
|
1152
|
+
# subscriber_arn: "SubscriberArn", # required
|
|
1153
|
+
# })
|
|
1154
|
+
#
|
|
1155
|
+
# @example Response structure
|
|
1156
|
+
#
|
|
1157
|
+
# resp.subscriber_arn #=> String
|
|
1158
|
+
# resp.name #=> String
|
|
1159
|
+
# resp.event_bus_arn #=> String
|
|
1160
|
+
# resp.invoke_configuration.role_arn #=> String
|
|
1161
|
+
# resp.invoke_configuration.lambda_parameters.invocation_type #=> String, one of "EVENT", "REQUEST_RESPONSE"
|
|
1162
|
+
# resp.invoke_configuration.lambda_parameters.qualifier #=> String
|
|
1163
|
+
# resp.invoke_configuration.lambda_parameters.durable_execution_name #=> String
|
|
1164
|
+
# resp.invoke_configuration.lambda_parameters.tenant_id #=> String
|
|
1165
|
+
# resp.invoke_configuration.lambda_parameters.invocation_timeout_seconds #=> String
|
|
1166
|
+
# resp.invoke_configuration.sqs_parameters.message_group_id #=> String
|
|
1167
|
+
# resp.invoke_configuration.sqs_parameters.message_deduplication_id #=> String
|
|
1168
|
+
# resp.invoke_configuration.sqs_parameters.delay_seconds #=> String
|
|
1169
|
+
# resp.invoke_configuration.sqs_parameters.message_attributes #=> Hash
|
|
1170
|
+
# resp.invoke_configuration.sqs_parameters.message_attributes["MessageAttributeName"].data_type #=> String
|
|
1171
|
+
# resp.invoke_configuration.sqs_parameters.message_attributes["MessageAttributeName"].string_value #=> String
|
|
1172
|
+
# resp.invoke_configuration.sqs_parameters.message_attributes["MessageAttributeName"].binary_value #=> String
|
|
1173
|
+
# resp.invoke_configuration.sqs_parameters.message_system_attributes #=> Hash
|
|
1174
|
+
# resp.invoke_configuration.sqs_parameters.message_system_attributes["MessageAttributeName"].data_type #=> String
|
|
1175
|
+
# resp.invoke_configuration.sqs_parameters.message_system_attributes["MessageAttributeName"].string_value #=> String
|
|
1176
|
+
# resp.invoke_configuration.sqs_parameters.message_system_attributes["MessageAttributeName"].binary_value #=> String
|
|
1177
|
+
# resp.invoke_configuration.sns_parameters.message_group_id #=> String
|
|
1178
|
+
# resp.invoke_configuration.sns_parameters.message_deduplication_id #=> String
|
|
1179
|
+
# resp.invoke_configuration.sns_parameters.subject #=> String
|
|
1180
|
+
# resp.invoke_configuration.sns_parameters.message_structure #=> String
|
|
1181
|
+
# resp.invoke_configuration.sns_parameters.message_attributes #=> Hash
|
|
1182
|
+
# resp.invoke_configuration.sns_parameters.message_attributes["MessageAttributeName"].data_type #=> String
|
|
1183
|
+
# resp.invoke_configuration.sns_parameters.message_attributes["MessageAttributeName"].string_value #=> String
|
|
1184
|
+
# resp.invoke_configuration.sns_parameters.message_attributes["MessageAttributeName"].binary_value #=> String
|
|
1185
|
+
# resp.invoke_configuration.kinesis_parameters.partition_key #=> String
|
|
1186
|
+
# resp.invoke_configuration.kinesis_parameters.explicit_hash_key #=> String
|
|
1187
|
+
# resp.invoke_configuration.step_functions_parameters.invocation_type #=> String, one of "EVENT", "REQUEST_RESPONSE"
|
|
1188
|
+
# resp.invoke_configuration.step_functions_parameters.name #=> String
|
|
1189
|
+
# resp.invoke_configuration.step_functions_parameters.trace_header #=> String
|
|
1190
|
+
# resp.invoke_configuration.step_functions_parameters.invocation_timeout_seconds #=> String
|
|
1191
|
+
# resp.invoke_configuration.http_parameters.path_parameter_values #=> Array
|
|
1192
|
+
# resp.invoke_configuration.http_parameters.path_parameter_values[0] #=> String
|
|
1193
|
+
# resp.invoke_configuration.http_parameters.header_parameters #=> Hash
|
|
1194
|
+
# resp.invoke_configuration.http_parameters.header_parameters["HeaderKey"] #=> String
|
|
1195
|
+
# resp.invoke_configuration.http_parameters.query_string_parameters #=> Hash
|
|
1196
|
+
# resp.invoke_configuration.http_parameters.query_string_parameters["QueryStringKey"] #=> String
|
|
1197
|
+
# resp.invoke_configuration.http_parameters.invocation_timeout_seconds #=> String
|
|
1198
|
+
# resp.invoke_configuration.universal_target_parameters.input #=> String
|
|
1199
|
+
# resp.invoke_configuration.universal_target_parameters.invocation_timeout_seconds #=> String
|
|
1200
|
+
# resp.invoke_configuration.event_bus_v2_parameters.metadata #=> Hash
|
|
1201
|
+
# resp.invoke_configuration.event_bus_v2_parameters.metadata["String"] #=> String
|
|
1202
|
+
# resp.invoke_configuration.event_bus_v2_parameters.system_metadata.event_group_id #=> String
|
|
1203
|
+
# resp.invoke_configuration.event_bus_v2_parameters.system_metadata.deduplication_id #=> String
|
|
1204
|
+
# resp.invoke_configuration.event_bus_v2_parameters.deduplication_configuration.deduplication_type #=> String, one of "CONTENT_BASED"
|
|
1205
|
+
# resp.invoke_configuration.target_arn #=> String
|
|
1206
|
+
# resp.description #=> String
|
|
1207
|
+
# resp.filter_configuration.language #=> String, one of "EVENT_BRIDGE_PATTERN"
|
|
1208
|
+
# resp.filter_configuration.filters #=> Array
|
|
1209
|
+
# resp.filter_configuration.filters[0].pattern #=> String
|
|
1210
|
+
# resp.filter_configuration.filters[0].scope #=> String, one of "DATA", "METADATA", "SYSTEM_METADATA"
|
|
1211
|
+
# resp.type #=> String, one of "FIFO", "UNORDERED"
|
|
1212
|
+
# resp.starting_position #=> String, one of "LATEST", "POINT_IN_TIME"
|
|
1213
|
+
# resp.point_in_time_configuration.point_type #=> String, one of "HORIZON", "TIMESTAMP"
|
|
1214
|
+
# resp.point_in_time_configuration.starting_point #=> Time
|
|
1215
|
+
# resp.point_in_time_configuration.end_point #=> Time
|
|
1216
|
+
# resp.batch_configuration.max_batch_size #=> Integer
|
|
1217
|
+
# resp.batch_configuration.max_batch_window_in_seconds #=> Integer
|
|
1218
|
+
# resp.transformer.type #=> String, one of "RAW", "WITH_METADATA", "JSONATA"
|
|
1219
|
+
# resp.transformer.jsonata_configuration.expression #=> String
|
|
1220
|
+
# resp.retry_policy.max_retry_attempts #=> Integer
|
|
1221
|
+
# resp.retry_policy.max_event_age_in_seconds #=> Integer
|
|
1222
|
+
# resp.retry_policy.retry_strategy #=> String, one of "ALL"
|
|
1223
|
+
# resp.on_failure_configuration.arn #=> String
|
|
1224
|
+
# resp.log_configuration.level #=> String, one of "OFF", "ERROR", "INFO"
|
|
1225
|
+
# resp.log_configuration.include_payload #=> String, one of "FULL", "ON_ERROR_ONLY"
|
|
1226
|
+
# resp.state #=> String, one of "RUNNING", "STOPPED"
|
|
1227
|
+
# resp.revoked #=> Boolean
|
|
1228
|
+
# resp.creation_time #=> Time
|
|
1229
|
+
# resp.last_modified_time #=> Time
|
|
1230
|
+
#
|
|
1231
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DescribeSubscriber AWS API Documentation
|
|
1232
|
+
#
|
|
1233
|
+
# @overload describe_subscriber(params = {})
|
|
1234
|
+
# @param [Hash] params ({})
|
|
1235
|
+
def describe_subscriber(params = {}, options = {})
|
|
1236
|
+
req = build_request(:describe_subscriber, params)
|
|
1237
|
+
req.send_request(options)
|
|
1238
|
+
end
|
|
1239
|
+
|
|
1240
|
+
# Returns the named resource policy attached to an event bus. Fails with
|
|
1241
|
+
# ResourceNotFoundException when the event bus or the named policy does
|
|
1242
|
+
# not exist.
|
|
1243
|
+
#
|
|
1244
|
+
# @option params [required, String] :resource_arn
|
|
1245
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
1246
|
+
#
|
|
1247
|
+
# @option params [String] :policy_name
|
|
1248
|
+
# Which named policy to read. Defaults to "default" when omitted (a read
|
|
1249
|
+
# AWS Resource Access Manager makes on the owner's behalf resolves to
|
|
1250
|
+
# "AWS\_RAM" instead). Unlike writing, neither name is reserved on a
|
|
1251
|
+
# read: the bus owner can read both. There is no fallback between the
|
|
1252
|
+
# two, so a bus shared only through Resource Access Manager fails with
|
|
1253
|
+
# ResourceNotFoundException until "AWS\_RAM" is named explicitly. A
|
|
1254
|
+
# well-formed name that is neither of the two fails with
|
|
1255
|
+
# InvalidInputException.
|
|
1256
|
+
#
|
|
1257
|
+
# @return [Types::GetResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1258
|
+
#
|
|
1259
|
+
# * {Types::GetResourcePolicyResponse#resource_arn #resource_arn} => String
|
|
1260
|
+
# * {Types::GetResourcePolicyResponse#policy_document #policy_document} => String
|
|
1261
|
+
# * {Types::GetResourcePolicyResponse#policy_name #policy_name} => String
|
|
1262
|
+
# * {Types::GetResourcePolicyResponse#revision_id #revision_id} => String
|
|
1263
|
+
#
|
|
1264
|
+
# @example Request syntax with placeholder values
|
|
1265
|
+
#
|
|
1266
|
+
# resp = client.get_resource_policy({
|
|
1267
|
+
# resource_arn: "EventBusArn", # required
|
|
1268
|
+
# policy_name: "PolicyName",
|
|
1269
|
+
# })
|
|
1270
|
+
#
|
|
1271
|
+
# @example Response structure
|
|
1272
|
+
#
|
|
1273
|
+
# resp.resource_arn #=> String
|
|
1274
|
+
# resp.policy_document #=> String
|
|
1275
|
+
# resp.policy_name #=> String
|
|
1276
|
+
# resp.revision_id #=> String
|
|
1277
|
+
#
|
|
1278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/GetResourcePolicy AWS API Documentation
|
|
1279
|
+
#
|
|
1280
|
+
# @overload get_resource_policy(params = {})
|
|
1281
|
+
# @param [Hash] params ({})
|
|
1282
|
+
def get_resource_policy(params = {}, options = {})
|
|
1283
|
+
req = build_request(:get_resource_policy, params)
|
|
1284
|
+
req.send_request(options)
|
|
1285
|
+
end
|
|
1286
|
+
|
|
1287
|
+
# Lists the event buses visible to the caller: buses the account owns
|
|
1288
|
+
# and buses shared with it through AWS RAM. Shared entries carry
|
|
1289
|
+
# identity fields only (Name, EventBusArn, EventBusAccountId); owned
|
|
1290
|
+
# entries carry every summary field. Set EventBusAccountId to scope the
|
|
1291
|
+
# list to one owner account.
|
|
1292
|
+
#
|
|
1293
|
+
# @option params [String] :name_prefix
|
|
1294
|
+
# Name of an event bus. The first character must be alphanumeric; the
|
|
1295
|
+
# remaining characters may also include '.', '-', and '\_'. The
|
|
1296
|
+
# grammar matches the name segment of EventBusArn
|
|
1297
|
+
# (event-busv2/<name>/<id>), so every valid name can be represented in
|
|
1298
|
+
# the bus's ARN. The same type is used everywhere a bus name
|
|
1299
|
+
# appears.</p> </id></name>
|
|
1300
|
+
#
|
|
1301
|
+
# @option params [String] :event_bus_account_id
|
|
1302
|
+
# AWS Account Id.
|
|
1303
|
+
#
|
|
1304
|
+
# @option params [String] :next_token
|
|
1305
|
+
# Opaque pagination token returned by a List operation. Pass it back in
|
|
1306
|
+
# the next request to retrieve the next page of results.
|
|
1307
|
+
#
|
|
1308
|
+
# @option params [Integer] :max_results
|
|
1309
|
+
# Maximum number of results to return in one page of a List operation.
|
|
1310
|
+
#
|
|
1311
|
+
# @return [Types::ListEventBusesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1312
|
+
#
|
|
1313
|
+
# * {Types::ListEventBusesResponse#event_buses #event_buses} => Array<Types::EventBusSummary>
|
|
1314
|
+
# * {Types::ListEventBusesResponse#next_token #next_token} => String
|
|
1315
|
+
#
|
|
1316
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1317
|
+
#
|
|
1318
|
+
# @example Request syntax with placeholder values
|
|
1319
|
+
#
|
|
1320
|
+
# resp = client.list_event_buses({
|
|
1321
|
+
# name_prefix: "EventBusName",
|
|
1322
|
+
# event_bus_account_id: "AccountId",
|
|
1323
|
+
# next_token: "NextToken",
|
|
1324
|
+
# max_results: 1,
|
|
1325
|
+
# })
|
|
1326
|
+
#
|
|
1327
|
+
# @example Response structure
|
|
1328
|
+
#
|
|
1329
|
+
# resp.event_buses #=> Array
|
|
1330
|
+
# resp.event_buses[0].name #=> String
|
|
1331
|
+
# resp.event_buses[0].event_bus_arn #=> String
|
|
1332
|
+
# resp.event_buses[0].description #=> String
|
|
1333
|
+
# resp.event_buses[0].creation_time #=> Time
|
|
1334
|
+
# resp.event_buses[0].last_modified_time #=> Time
|
|
1335
|
+
# resp.event_buses[0].state #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "ACTIVE", "DELETE_FAILED"
|
|
1336
|
+
# resp.event_buses[0].state_reason #=> String
|
|
1337
|
+
# resp.event_buses[0].event_bus_account_id #=> String
|
|
1338
|
+
# resp.next_token #=> String
|
|
1339
|
+
#
|
|
1340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListEventBuses AWS API Documentation
|
|
1341
|
+
#
|
|
1342
|
+
# @overload list_event_buses(params = {})
|
|
1343
|
+
# @param [Hash] params ({})
|
|
1344
|
+
def list_event_buses(params = {}, options = {})
|
|
1345
|
+
req = build_request(:list_event_buses, params)
|
|
1346
|
+
req.send_request(options)
|
|
1347
|
+
end
|
|
1348
|
+
|
|
1349
|
+
# Lists EventSources as summaries. By default the list spans the
|
|
1350
|
+
# EventSources the caller account owns; set EventBusArn to scope it to
|
|
1351
|
+
# one bus. Use DescribeEventSource to retrieve full configuration.
|
|
1352
|
+
#
|
|
1353
|
+
# @option params [String] :event_bus_arn
|
|
1354
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
1355
|
+
#
|
|
1356
|
+
# @option params [String] :name_prefix
|
|
1357
|
+
# EventSource name. First character alphanumeric; the rest may add
|
|
1358
|
+
# '.', '-', '\_'. Names may not begin with the reserved "aws."
|
|
1359
|
+
# prefix. The grammar matches the ARN local-name segment in
|
|
1360
|
+
# EventSourceArn (event-sourcev2/<type>/<name>/<id>), mirroring
|
|
1361
|
+
# EventBusName, so a name the ARN cannot represent cannot be
|
|
1362
|
+
# created.</p> </id></name></type>
|
|
1363
|
+
#
|
|
1364
|
+
# @option params [String] :next_token
|
|
1365
|
+
# Opaque pagination token returned by a List operation. Pass it back in
|
|
1366
|
+
# the next request to retrieve the next page of results.
|
|
1367
|
+
#
|
|
1368
|
+
# @option params [Integer] :max_results
|
|
1369
|
+
# Maximum number of results to return in one page of a List operation.
|
|
1370
|
+
#
|
|
1371
|
+
# @return [Types::ListEventSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1372
|
+
#
|
|
1373
|
+
# * {Types::ListEventSourcesResponse#event_sources #event_sources} => Array<Types::EventSourceSummary>
|
|
1374
|
+
# * {Types::ListEventSourcesResponse#next_token #next_token} => String
|
|
1375
|
+
#
|
|
1376
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1377
|
+
#
|
|
1378
|
+
# @example Request syntax with placeholder values
|
|
1379
|
+
#
|
|
1380
|
+
# resp = client.list_event_sources({
|
|
1381
|
+
# event_bus_arn: "EventBusArn",
|
|
1382
|
+
# name_prefix: "EventSourceName",
|
|
1383
|
+
# next_token: "NextToken",
|
|
1384
|
+
# max_results: 1,
|
|
1385
|
+
# })
|
|
1386
|
+
#
|
|
1387
|
+
# @example Response structure
|
|
1388
|
+
#
|
|
1389
|
+
# resp.event_sources #=> Array
|
|
1390
|
+
# resp.event_sources[0].event_source_arn #=> String
|
|
1391
|
+
# resp.event_sources[0].name #=> String
|
|
1392
|
+
# resp.event_sources[0].event_bus_arn #=> String
|
|
1393
|
+
# resp.event_sources[0].type #=> String, one of "AWS_SERVICE_EVENTS", "PARTNER_EVENTS"
|
|
1394
|
+
# resp.event_sources[0].state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
|
|
1395
|
+
# resp.event_sources[0].revoked #=> Boolean
|
|
1396
|
+
# resp.event_sources[0].creation_time #=> Time
|
|
1397
|
+
# resp.event_sources[0].last_modified_time #=> Time
|
|
1398
|
+
# resp.event_sources[0].event_source_account_id #=> String
|
|
1399
|
+
# resp.next_token #=> String
|
|
1400
|
+
#
|
|
1401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListEventSources AWS API Documentation
|
|
1402
|
+
#
|
|
1403
|
+
# @overload list_event_sources(params = {})
|
|
1404
|
+
# @param [Hash] params ({})
|
|
1405
|
+
def list_event_sources(params = {}, options = {})
|
|
1406
|
+
req = build_request(:list_event_sources, params)
|
|
1407
|
+
req.send_request(options)
|
|
1408
|
+
end
|
|
1409
|
+
|
|
1410
|
+
# Lists the resource policies attached to an event bus as summaries
|
|
1411
|
+
# (policy name and revision ID). Use GetResourcePolicy to retrieve a
|
|
1412
|
+
# policy document.
|
|
1413
|
+
#
|
|
1414
|
+
# @option params [required, String] :resource_arn
|
|
1415
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
1416
|
+
#
|
|
1417
|
+
# @option params [String] :next_token
|
|
1418
|
+
# Opaque pagination token returned by a List operation. Pass it back in
|
|
1419
|
+
# the next request to retrieve the next page of results.
|
|
1420
|
+
#
|
|
1421
|
+
# @option params [Integer] :max_results
|
|
1422
|
+
# Maximum number of results to return in one page of a List operation.
|
|
1423
|
+
#
|
|
1424
|
+
# @return [Types::ListResourcePoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1425
|
+
#
|
|
1426
|
+
# * {Types::ListResourcePoliciesResponse#policy_summaries #policy_summaries} => Array<Types::ResourcePolicySummary>
|
|
1427
|
+
# * {Types::ListResourcePoliciesResponse#next_token #next_token} => String
|
|
1428
|
+
#
|
|
1429
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1430
|
+
#
|
|
1431
|
+
# @example Request syntax with placeholder values
|
|
1432
|
+
#
|
|
1433
|
+
# resp = client.list_resource_policies({
|
|
1434
|
+
# resource_arn: "EventBusArn", # required
|
|
1435
|
+
# next_token: "NextToken",
|
|
1436
|
+
# max_results: 1,
|
|
1437
|
+
# })
|
|
1438
|
+
#
|
|
1439
|
+
# @example Response structure
|
|
1440
|
+
#
|
|
1441
|
+
# resp.policy_summaries #=> Array
|
|
1442
|
+
# resp.policy_summaries[0].policy_name #=> String
|
|
1443
|
+
# resp.policy_summaries[0].revision_id #=> String
|
|
1444
|
+
# resp.next_token #=> String
|
|
1445
|
+
#
|
|
1446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListResourcePolicies AWS API Documentation
|
|
1447
|
+
#
|
|
1448
|
+
# @overload list_resource_policies(params = {})
|
|
1449
|
+
# @param [Hash] params ({})
|
|
1450
|
+
def list_resource_policies(params = {}, options = {})
|
|
1451
|
+
req = build_request(:list_resource_policies, params)
|
|
1452
|
+
req.send_request(options)
|
|
1453
|
+
end
|
|
1454
|
+
|
|
1455
|
+
# Lists subscribers as summaries. By default the list spans the
|
|
1456
|
+
# subscribers the caller account owns across all buses; set EventBusArn
|
|
1457
|
+
# to scope it to one bus. Use DescribeSubscriber to retrieve full
|
|
1458
|
+
# configuration.
|
|
1459
|
+
#
|
|
1460
|
+
# @option params [String] :event_bus_arn
|
|
1461
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
1462
|
+
#
|
|
1463
|
+
# @option params [String] :name_prefix
|
|
1464
|
+
# Name of a subscriber. The first character must be alphanumeric; the
|
|
1465
|
+
# remaining characters may also include '.', '-', and '\_'.
|
|
1466
|
+
#
|
|
1467
|
+
# @option params [String] :next_token
|
|
1468
|
+
# Opaque pagination token returned by a List operation. Pass it back in
|
|
1469
|
+
# the next request to retrieve the next page of results.
|
|
1470
|
+
#
|
|
1471
|
+
# @option params [Integer] :max_results
|
|
1472
|
+
# Maximum number of results to return in one page of a List operation.
|
|
1473
|
+
#
|
|
1474
|
+
# @return [Types::ListSubscribersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1475
|
+
#
|
|
1476
|
+
# * {Types::ListSubscribersResponse#subscribers #subscribers} => Array<Types::SubscriberSummary>
|
|
1477
|
+
# * {Types::ListSubscribersResponse#next_token #next_token} => String
|
|
1478
|
+
#
|
|
1479
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1480
|
+
#
|
|
1481
|
+
# @example Request syntax with placeholder values
|
|
1482
|
+
#
|
|
1483
|
+
# resp = client.list_subscribers({
|
|
1484
|
+
# event_bus_arn: "EventBusArn",
|
|
1485
|
+
# name_prefix: "SubscriberName",
|
|
1486
|
+
# next_token: "NextToken",
|
|
1487
|
+
# max_results: 1,
|
|
1488
|
+
# })
|
|
1489
|
+
#
|
|
1490
|
+
# @example Response structure
|
|
1491
|
+
#
|
|
1492
|
+
# resp.subscribers #=> Array
|
|
1493
|
+
# resp.subscribers[0].subscriber_arn #=> String
|
|
1494
|
+
# resp.subscribers[0].name #=> String
|
|
1495
|
+
# resp.subscribers[0].event_bus_arn #=> String
|
|
1496
|
+
# resp.subscribers[0].target_arn #=> String
|
|
1497
|
+
# resp.subscribers[0].type #=> String, one of "FIFO", "UNORDERED"
|
|
1498
|
+
# resp.subscribers[0].revoked #=> Boolean
|
|
1499
|
+
# resp.subscribers[0].state #=> String, one of "RUNNING", "STOPPED"
|
|
1500
|
+
# resp.subscribers[0].creation_time #=> Time
|
|
1501
|
+
# resp.subscribers[0].last_modified_time #=> Time
|
|
1502
|
+
# resp.subscribers[0].subscriber_account_id #=> String
|
|
1503
|
+
# resp.next_token #=> String
|
|
1504
|
+
#
|
|
1505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListSubscribers AWS API Documentation
|
|
1506
|
+
#
|
|
1507
|
+
# @overload list_subscribers(params = {})
|
|
1508
|
+
# @param [Hash] params ({})
|
|
1509
|
+
def list_subscribers(params = {}, options = {})
|
|
1510
|
+
req = build_request(:list_subscribers, params)
|
|
1511
|
+
req.send_request(options)
|
|
1512
|
+
end
|
|
1513
|
+
|
|
1514
|
+
# Lists the tags on an event bus, subscriber, or event source.
|
|
1515
|
+
#
|
|
1516
|
+
# @option params [required, String] :resource_arn
|
|
1517
|
+
# ARN for an EventBridge resource that supports tagging: event buses,
|
|
1518
|
+
# subscribers, and event sources.
|
|
1519
|
+
#
|
|
1520
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1521
|
+
#
|
|
1522
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
|
1523
|
+
#
|
|
1524
|
+
# @example Request syntax with placeholder values
|
|
1525
|
+
#
|
|
1526
|
+
# resp = client.list_tags_for_resource({
|
|
1527
|
+
# resource_arn: "TaggableResourceArn", # required
|
|
1528
|
+
# })
|
|
1529
|
+
#
|
|
1530
|
+
# @example Response structure
|
|
1531
|
+
#
|
|
1532
|
+
# resp.tags #=> Hash
|
|
1533
|
+
# resp.tags["TagKey"] #=> String
|
|
1534
|
+
#
|
|
1535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListTagsForResource AWS API Documentation
|
|
1536
|
+
#
|
|
1537
|
+
# @overload list_tags_for_resource(params = {})
|
|
1538
|
+
# @param [Hash] params ({})
|
|
1539
|
+
def list_tags_for_resource(params = {}, options = {})
|
|
1540
|
+
req = build_request(:list_tags_for_resource, params)
|
|
1541
|
+
req.send_request(options)
|
|
1542
|
+
end
|
|
1543
|
+
|
|
1544
|
+
# Publishes events to an event bus.
|
|
1545
|
+
#
|
|
1546
|
+
# @option params [required, String] :event_bus_arn
|
|
1547
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
1548
|
+
#
|
|
1549
|
+
# @option params [required, Array<Types::PutEventsRequestEntry>] :entries
|
|
1550
|
+
# List of event entries to publish. Must contain at least one entry.
|
|
1551
|
+
#
|
|
1552
|
+
# @option params [Types::DeduplicationConfiguration] :deduplication_configuration
|
|
1553
|
+
# Request-level deduplication settings, applied to every entry in the
|
|
1554
|
+
# batch.
|
|
1555
|
+
#
|
|
1556
|
+
# @return [Types::PutEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1557
|
+
#
|
|
1558
|
+
# * {Types::PutEventsResponse#failed_entry_count #failed_entry_count} => Integer
|
|
1559
|
+
# * {Types::PutEventsResponse#entries #data.entries} => Array<Types::PutEventsResultEntry> (This method conflicts with a method on Response, call it through the data member)
|
|
1560
|
+
#
|
|
1561
|
+
# @example Request syntax with placeholder values
|
|
1562
|
+
#
|
|
1563
|
+
# resp = client.put_events({
|
|
1564
|
+
# event_bus_arn: "EventBusArn", # required
|
|
1565
|
+
# entries: [ # required
|
|
1566
|
+
# {
|
|
1567
|
+
# source: "Source", # required
|
|
1568
|
+
# detail_type: "DetailType", # required
|
|
1569
|
+
# detail: "EventDetail",
|
|
1570
|
+
# resources: ["EventResource"],
|
|
1571
|
+
# time: Time.now,
|
|
1572
|
+
# system_metadata: {
|
|
1573
|
+
# event_group_id: "EventGroupId",
|
|
1574
|
+
# deduplication_id: "EventDeduplicationId",
|
|
1575
|
+
# },
|
|
1576
|
+
# },
|
|
1577
|
+
# ],
|
|
1578
|
+
# deduplication_configuration: {
|
|
1579
|
+
# deduplication_type: "CONTENT_BASED", # required, accepts CONTENT_BASED
|
|
1580
|
+
# },
|
|
1581
|
+
# })
|
|
1582
|
+
#
|
|
1583
|
+
# @example Response structure
|
|
1584
|
+
#
|
|
1585
|
+
# resp.failed_entry_count #=> Integer
|
|
1586
|
+
# resp.data.entries #=> Array
|
|
1587
|
+
# resp.data.entries[0].event_id #=> String
|
|
1588
|
+
# resp.data.entries[0].sequence_number #=> String
|
|
1589
|
+
# resp.data.entries[0].success_code #=> String, one of "PUBLISHED", "DEDUPLICATED"
|
|
1590
|
+
# resp.data.entries[0].error_code #=> String
|
|
1591
|
+
# resp.data.entries[0].error_message #=> String
|
|
1592
|
+
#
|
|
1593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutEvents AWS API Documentation
|
|
1594
|
+
#
|
|
1595
|
+
# @overload put_events(params = {})
|
|
1596
|
+
# @param [Hash] params ({})
|
|
1597
|
+
def put_events(params = {}, options = {})
|
|
1598
|
+
req = build_request(:put_events, params)
|
|
1599
|
+
req.send_request(options)
|
|
1600
|
+
end
|
|
1601
|
+
|
|
1602
|
+
# Publishes pre-shaped events to an event bus.
|
|
1603
|
+
#
|
|
1604
|
+
# @option params [required, String] :event_bus_arn
|
|
1605
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
1606
|
+
#
|
|
1607
|
+
# @option params [required, Array<Types::PutRawEventsRequestEntry>] :entries
|
|
1608
|
+
# List of event entries to publish. Must contain at least one entry.
|
|
1609
|
+
#
|
|
1610
|
+
# @option params [Types::SchemaRegistryConfiguration] :schema_registry_configuration
|
|
1611
|
+
# Schema-registry settings for encoding open-format (Avro/Protobuf)
|
|
1612
|
+
# events. Required for open-format entries; ignored for JSON entries.
|
|
1613
|
+
# The registry is read with the caller's credentials, so the caller
|
|
1614
|
+
# needs read access to the registry it references.
|
|
1615
|
+
#
|
|
1616
|
+
# @option params [Types::DeduplicationConfiguration] :deduplication_configuration
|
|
1617
|
+
# Request-level deduplication settings, applied to every entry in the
|
|
1618
|
+
# batch.
|
|
1619
|
+
#
|
|
1620
|
+
# @return [Types::PutRawEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1621
|
+
#
|
|
1622
|
+
# * {Types::PutRawEventsResponse#failed_entry_count #failed_entry_count} => Integer
|
|
1623
|
+
# * {Types::PutRawEventsResponse#entries #data.entries} => Array<Types::PutRawEventsResultEntry> (This method conflicts with a method on Response, call it through the data member)
|
|
1624
|
+
#
|
|
1625
|
+
# @example Request syntax with placeholder values
|
|
1626
|
+
#
|
|
1627
|
+
# resp = client.put_raw_events({
|
|
1628
|
+
# event_bus_arn: "EventBusArn", # required
|
|
1629
|
+
# entries: [ # required
|
|
1630
|
+
# {
|
|
1631
|
+
# data: "data", # required
|
|
1632
|
+
# metadata: {
|
|
1633
|
+
# "EventMetadataKey" => "EventMetadataValue",
|
|
1634
|
+
# },
|
|
1635
|
+
# system_metadata: { # required
|
|
1636
|
+
# content_type: "ContentType", # required
|
|
1637
|
+
# deduplication_id: "EventDeduplicationId",
|
|
1638
|
+
# event_group_id: "EventGroupId",
|
|
1639
|
+
# },
|
|
1640
|
+
# },
|
|
1641
|
+
# ],
|
|
1642
|
+
# schema_registry_configuration: {
|
|
1643
|
+
# registry_uri: "SchemaRegistryUri", # required
|
|
1644
|
+
# confluent_public_registry_configuration: {
|
|
1645
|
+
# connection_arn: "ConnectionArn", # required
|
|
1646
|
+
# },
|
|
1647
|
+
# },
|
|
1648
|
+
# deduplication_configuration: {
|
|
1649
|
+
# deduplication_type: "CONTENT_BASED", # required, accepts CONTENT_BASED
|
|
1650
|
+
# },
|
|
1651
|
+
# })
|
|
1652
|
+
#
|
|
1653
|
+
# @example Response structure
|
|
1654
|
+
#
|
|
1655
|
+
# resp.failed_entry_count #=> Integer
|
|
1656
|
+
# resp.data.entries #=> Array
|
|
1657
|
+
# resp.data.entries[0].event_id #=> String
|
|
1658
|
+
# resp.data.entries[0].sequence_number #=> String
|
|
1659
|
+
# resp.data.entries[0].success_code #=> String, one of "PUBLISHED", "DEDUPLICATED"
|
|
1660
|
+
# resp.data.entries[0].error_code #=> String
|
|
1661
|
+
# resp.data.entries[0].error_message #=> String
|
|
1662
|
+
#
|
|
1663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutRawEvents AWS API Documentation
|
|
1664
|
+
#
|
|
1665
|
+
# @overload put_raw_events(params = {})
|
|
1666
|
+
# @param [Hash] params ({})
|
|
1667
|
+
def put_raw_events(params = {}, options = {})
|
|
1668
|
+
req = build_request(:put_raw_events, params)
|
|
1669
|
+
req.send_request(options)
|
|
1670
|
+
end
|
|
1671
|
+
|
|
1672
|
+
# Attaches a named resource policy to an event bus — the only resource
|
|
1673
|
+
# type that supports policies; other resource ARNs are rejected. Each
|
|
1674
|
+
# bus holds two named policies: "default" (customer-managed, full IAM
|
|
1675
|
+
# policy language including Deny) and "AWS\_RAM" (written exclusively by
|
|
1676
|
+
# AWS Resource Access Manager to reflect resource shares). Both policies
|
|
1677
|
+
# are evaluated on cross-account authorization; an explicit Deny in
|
|
1678
|
+
# either overrides an Allow in the other. Operations that omit
|
|
1679
|
+
# PolicyName target "default". A "default" policy that would grant
|
|
1680
|
+
# public access is rejected with PublicPolicyException and is not
|
|
1681
|
+
# attached; this check is always on and cannot be disabled.
|
|
1682
|
+
#
|
|
1683
|
+
# @option params [required, String] :resource_arn
|
|
1684
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
1685
|
+
#
|
|
1686
|
+
# @option params [required, String] :policy_document
|
|
1687
|
+
# A resource policy document, as a JSON string. The "default" policy can
|
|
1688
|
+
# be up to 20 KB (20,480 bytes of UTF-8) by default. This quota is
|
|
1689
|
+
# adjustable in Service Quotas. A "default" policy that exceeds the
|
|
1690
|
+
# quota is rejected with PolicyLengthExceededException. No policy
|
|
1691
|
+
# document can exceed 389,120 bytes of UTF-8, regardless of the quota.
|
|
1692
|
+
#
|
|
1693
|
+
# @option params [String] :policy_name
|
|
1694
|
+
# Which named policy to write. Defaults to "default", the
|
|
1695
|
+
# customer-managed policy, when omitted (a write AWS Resource Access
|
|
1696
|
+
# Manager makes on the owner's behalf resolves to "AWS\_RAM" instead).
|
|
1697
|
+
# The two writers are exclusive in both directions — only Resource
|
|
1698
|
+
# Access Manager can write "AWS\_RAM", and only the bus owner can write
|
|
1699
|
+
# "default" — so naming the other party's policy fails with
|
|
1700
|
+
# AccessDeniedException. A well-formed name that is neither of the two
|
|
1701
|
+
# fails with InvalidInputException.
|
|
1702
|
+
#
|
|
1703
|
+
# @option params [String] :expected_revision_id
|
|
1704
|
+
# The write succeeds only if the named policy's current revision ID
|
|
1705
|
+
# matches this value; a policy that does not exist yet matches only the
|
|
1706
|
+
# sentinel "NO\_POLICY" (create-only). On mismatch the operation fails
|
|
1707
|
+
# with ConflictException. When omitted, the write is unconditional.
|
|
1708
|
+
# Every attempt stores a newly generated revision ID, so retrying an
|
|
1709
|
+
# unanswered request can conflict with the caller's own earlier
|
|
1710
|
+
# attempt; read the policy back and compare it with the one you intended
|
|
1711
|
+
# before treating a conflict as another writer's change.
|
|
1712
|
+
#
|
|
1713
|
+
# @return [Types::PutResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1714
|
+
#
|
|
1715
|
+
# * {Types::PutResourcePolicyResponse#resource_arn #resource_arn} => String
|
|
1716
|
+
# * {Types::PutResourcePolicyResponse#policy_name #policy_name} => String
|
|
1717
|
+
# * {Types::PutResourcePolicyResponse#revision_id #revision_id} => String
|
|
1718
|
+
#
|
|
1719
|
+
# @example Request syntax with placeholder values
|
|
1720
|
+
#
|
|
1721
|
+
# resp = client.put_resource_policy({
|
|
1722
|
+
# resource_arn: "EventBusArn", # required
|
|
1723
|
+
# policy_document: "PolicyDocument", # required
|
|
1724
|
+
# policy_name: "PolicyName",
|
|
1725
|
+
# expected_revision_id: "PolicyRevisionId",
|
|
1726
|
+
# })
|
|
1727
|
+
#
|
|
1728
|
+
# @example Response structure
|
|
1729
|
+
#
|
|
1730
|
+
# resp.resource_arn #=> String
|
|
1731
|
+
# resp.policy_name #=> String
|
|
1732
|
+
# resp.revision_id #=> String
|
|
1733
|
+
#
|
|
1734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutResourcePolicy AWS API Documentation
|
|
1735
|
+
#
|
|
1736
|
+
# @overload put_resource_policy(params = {})
|
|
1737
|
+
# @param [Hash] params ({})
|
|
1738
|
+
def put_resource_policy(params = {}, options = {})
|
|
1739
|
+
req = build_request(:put_resource_policy, params)
|
|
1740
|
+
req.send_request(options)
|
|
1741
|
+
end
|
|
1742
|
+
|
|
1743
|
+
# Revokes a subscriber or an EventSource. The bus owner calls this to
|
|
1744
|
+
# withdraw a misbehaving resource attached to their bus. Revocation is
|
|
1745
|
+
# terminal: there is no operation that clears it. A revoked resource
|
|
1746
|
+
# refuses mutating operations with InvalidStateException; delete stays
|
|
1747
|
+
# available for cleanup.
|
|
1748
|
+
#
|
|
1749
|
+
# @option params [required, String] :arn
|
|
1750
|
+
# ARN of a resource a bus owner can revoke: a subscriber or an
|
|
1751
|
+
# EventSource. The pattern is the revocable subset of
|
|
1752
|
+
# TaggableResourceArn; buses are not revocable.
|
|
1753
|
+
#
|
|
1754
|
+
# @return [Types::RevokeResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1755
|
+
#
|
|
1756
|
+
# * {Types::RevokeResourceResponse#arn #arn} => String
|
|
1757
|
+
#
|
|
1758
|
+
# @example Request syntax with placeholder values
|
|
1759
|
+
#
|
|
1760
|
+
# resp = client.revoke_resource({
|
|
1761
|
+
# arn: "RevocableResourceArn", # required
|
|
1762
|
+
# })
|
|
1763
|
+
#
|
|
1764
|
+
# @example Response structure
|
|
1765
|
+
#
|
|
1766
|
+
# resp.arn #=> String
|
|
1767
|
+
#
|
|
1768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/RevokeResource AWS API Documentation
|
|
1769
|
+
#
|
|
1770
|
+
# @overload revoke_resource(params = {})
|
|
1771
|
+
# @param [Hash] params ({})
|
|
1772
|
+
def revoke_resource(params = {}, options = {})
|
|
1773
|
+
req = build_request(:revoke_resource, params)
|
|
1774
|
+
req.send_request(options)
|
|
1775
|
+
end
|
|
1776
|
+
|
|
1777
|
+
# Adds or replaces tags on an event bus, subscriber, or event source.
|
|
1778
|
+
#
|
|
1779
|
+
# @option params [required, String] :resource_arn
|
|
1780
|
+
# ARN for an EventBridge resource that supports tagging: event buses,
|
|
1781
|
+
# subscribers, and event sources.
|
|
1782
|
+
#
|
|
1783
|
+
# @option params [required, Hash<String,String>] :tags
|
|
1784
|
+
# Tags attached to a resource, as key-value pairs.
|
|
1785
|
+
#
|
|
1786
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1787
|
+
#
|
|
1788
|
+
# @example Request syntax with placeholder values
|
|
1789
|
+
#
|
|
1790
|
+
# resp = client.tag_resource({
|
|
1791
|
+
# resource_arn: "TaggableResourceArn", # required
|
|
1792
|
+
# tags: { # required
|
|
1793
|
+
# "TagKey" => "TagValue",
|
|
1794
|
+
# },
|
|
1795
|
+
# })
|
|
1796
|
+
#
|
|
1797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/TagResource AWS API Documentation
|
|
1798
|
+
#
|
|
1799
|
+
# @overload tag_resource(params = {})
|
|
1800
|
+
# @param [Hash] params ({})
|
|
1801
|
+
def tag_resource(params = {}, options = {})
|
|
1802
|
+
req = build_request(:tag_resource, params)
|
|
1803
|
+
req.send_request(options)
|
|
1804
|
+
end
|
|
1805
|
+
|
|
1806
|
+
# Removes tags from an event bus, subscriber, or event source.
|
|
1807
|
+
#
|
|
1808
|
+
# @option params [required, String] :resource_arn
|
|
1809
|
+
# ARN for an EventBridge resource that supports tagging: event buses,
|
|
1810
|
+
# subscribers, and event sources.
|
|
1811
|
+
#
|
|
1812
|
+
# @option params [required, Array<String>] :tag_keys
|
|
1813
|
+
# List of tag keys.
|
|
1814
|
+
#
|
|
1815
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1816
|
+
#
|
|
1817
|
+
# @example Request syntax with placeholder values
|
|
1818
|
+
#
|
|
1819
|
+
# resp = client.untag_resource({
|
|
1820
|
+
# resource_arn: "TaggableResourceArn", # required
|
|
1821
|
+
# tag_keys: ["TagKey"], # required
|
|
1822
|
+
# })
|
|
1823
|
+
#
|
|
1824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UntagResource AWS API Documentation
|
|
1825
|
+
#
|
|
1826
|
+
# @overload untag_resource(params = {})
|
|
1827
|
+
# @param [Hash] params ({})
|
|
1828
|
+
def untag_resource(params = {}, options = {})
|
|
1829
|
+
req = build_request(:untag_resource, params)
|
|
1830
|
+
req.send_request(options)
|
|
1831
|
+
end
|
|
1832
|
+
|
|
1833
|
+
# Updates an event bus. The update is asynchronous: the bus moves to
|
|
1834
|
+
# UPDATING and returns to ACTIVE when the change is applied. Fields
|
|
1835
|
+
# omitted from the request are left unchanged.
|
|
1836
|
+
#
|
|
1837
|
+
# @option params [required, String] :event_bus_arn
|
|
1838
|
+
# The Amazon Resource Name (ARN) that uniquely identifies an event bus.
|
|
1839
|
+
#
|
|
1840
|
+
# @option params [String] :description
|
|
1841
|
+
# Free-text description. Used by every resource type that has one: event
|
|
1842
|
+
# buses, subscribers, and event sources.
|
|
1843
|
+
#
|
|
1844
|
+
# @option params [Types::EncryptionConfiguration] :encryption_configuration
|
|
1845
|
+
# Encryption configuration for an event bus.
|
|
1846
|
+
#
|
|
1847
|
+
# @option params [Types::StorageConfiguration] :storage_configuration
|
|
1848
|
+
# Event storage configuration for an event bus.
|
|
1849
|
+
#
|
|
1850
|
+
# @return [Types::UpdateEventBusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1851
|
+
#
|
|
1852
|
+
# * {Types::UpdateEventBusResponse#event_bus_arn #event_bus_arn} => String
|
|
1853
|
+
# * {Types::UpdateEventBusResponse#name #name} => String
|
|
1854
|
+
# * {Types::UpdateEventBusResponse#description #description} => String
|
|
1855
|
+
# * {Types::UpdateEventBusResponse#encryption_configuration #encryption_configuration} => Types::EncryptionConfiguration
|
|
1856
|
+
# * {Types::UpdateEventBusResponse#storage_configuration #storage_configuration} => Types::StorageConfigurationOutput
|
|
1857
|
+
# * {Types::UpdateEventBusResponse#state #state} => String
|
|
1858
|
+
# * {Types::UpdateEventBusResponse#state_reason #state_reason} => String
|
|
1859
|
+
# * {Types::UpdateEventBusResponse#last_modified_time #last_modified_time} => Time
|
|
1860
|
+
#
|
|
1861
|
+
# @example Request syntax with placeholder values
|
|
1862
|
+
#
|
|
1863
|
+
# resp = client.update_event_bus({
|
|
1864
|
+
# event_bus_arn: "EventBusArn", # required
|
|
1865
|
+
# description: "Description",
|
|
1866
|
+
# encryption_configuration: {
|
|
1867
|
+
# kms_key_identifier: "KmsKeyIdentifier",
|
|
1868
|
+
# },
|
|
1869
|
+
# storage_configuration: {
|
|
1870
|
+
# retention_period_in_days: 1,
|
|
1871
|
+
# },
|
|
1872
|
+
# })
|
|
1873
|
+
#
|
|
1874
|
+
# @example Response structure
|
|
1875
|
+
#
|
|
1876
|
+
# resp.event_bus_arn #=> String
|
|
1877
|
+
# resp.name #=> String
|
|
1878
|
+
# resp.description #=> String
|
|
1879
|
+
# resp.encryption_configuration.kms_key_identifier #=> String
|
|
1880
|
+
# resp.storage_configuration.retention_period_in_days #=> Integer
|
|
1881
|
+
# resp.storage_configuration.retention_window_start_time #=> Time
|
|
1882
|
+
# resp.state #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "ACTIVE", "DELETE_FAILED"
|
|
1883
|
+
# resp.state_reason #=> String
|
|
1884
|
+
# resp.last_modified_time #=> Time
|
|
1885
|
+
#
|
|
1886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UpdateEventBus AWS API Documentation
|
|
1887
|
+
#
|
|
1888
|
+
# @overload update_event_bus(params = {})
|
|
1889
|
+
# @param [Hash] params ({})
|
|
1890
|
+
def update_event_bus(params = {}, options = {})
|
|
1891
|
+
req = build_request(:update_event_bus, params)
|
|
1892
|
+
req.send_request(options)
|
|
1893
|
+
end
|
|
1894
|
+
|
|
1895
|
+
# Updates an EventSource. Fields omitted from the request are left
|
|
1896
|
+
# unchanged.
|
|
1897
|
+
#
|
|
1898
|
+
# @option params [required, String] :event_source_arn
|
|
1899
|
+
# EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment
|
|
1900
|
+
# is set by the service (aws.service for AWS service events, aws.partner
|
|
1901
|
+
# for partner events) and is not part of the resource's name. The id
|
|
1902
|
+
# segment is a 25-character identifier generated by the service.</p>
|
|
1903
|
+
# </id></name></type>
|
|
1904
|
+
#
|
|
1905
|
+
# @option params [Types::EventSourceConfiguration] :configuration
|
|
1906
|
+
# Discriminated EventSource configuration. Exactly one variant must be
|
|
1907
|
+
# set.
|
|
1908
|
+
#
|
|
1909
|
+
# @option params [String] :description
|
|
1910
|
+
# Free-text description. Used by every resource type that has one: event
|
|
1911
|
+
# buses, subscribers, and event sources.
|
|
1912
|
+
#
|
|
1913
|
+
# @return [Types::UpdateEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1914
|
+
#
|
|
1915
|
+
# * {Types::UpdateEventSourceResponse#event_source_arn #event_source_arn} => String
|
|
1916
|
+
# * {Types::UpdateEventSourceResponse#name #name} => String
|
|
1917
|
+
# * {Types::UpdateEventSourceResponse#event_bus_arn #event_bus_arn} => String
|
|
1918
|
+
# * {Types::UpdateEventSourceResponse#state #state} => String
|
|
1919
|
+
# * {Types::UpdateEventSourceResponse#last_modified_time #last_modified_time} => Time
|
|
1920
|
+
#
|
|
1921
|
+
# @example Request syntax with placeholder values
|
|
1922
|
+
#
|
|
1923
|
+
# resp = client.update_event_source({
|
|
1924
|
+
# event_source_arn: "EventSourceArn", # required
|
|
1925
|
+
# configuration: {
|
|
1926
|
+
# aws_service_events_configuration: {
|
|
1927
|
+
# aws_service: "AwsServiceSource", # required
|
|
1928
|
+
# pattern: "AwsServiceEventsSourceConfigurationPatternString",
|
|
1929
|
+
# on_failure_configuration: {
|
|
1930
|
+
# arn: "DeadLetterQueueArn",
|
|
1931
|
+
# },
|
|
1932
|
+
# },
|
|
1933
|
+
# partner_events_configuration: {
|
|
1934
|
+
# partner_event_source_arn: "PartnerEventSourceArn", # required
|
|
1935
|
+
# pattern: "PartnerEventsSourceConfigurationPatternString",
|
|
1936
|
+
# partner_bus_kms_key_identifier: "KmsKeyIdentifier",
|
|
1937
|
+
# on_failure_configuration: {
|
|
1938
|
+
# arn: "DeadLetterQueueArn",
|
|
1939
|
+
# },
|
|
1940
|
+
# },
|
|
1941
|
+
# },
|
|
1942
|
+
# description: "Description",
|
|
1943
|
+
# })
|
|
1944
|
+
#
|
|
1945
|
+
# @example Response structure
|
|
1946
|
+
#
|
|
1947
|
+
# resp.event_source_arn #=> String
|
|
1948
|
+
# resp.name #=> String
|
|
1949
|
+
# resp.event_bus_arn #=> String
|
|
1950
|
+
# resp.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
|
|
1951
|
+
# resp.last_modified_time #=> Time
|
|
1952
|
+
#
|
|
1953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UpdateEventSource AWS API Documentation
|
|
1954
|
+
#
|
|
1955
|
+
# @overload update_event_source(params = {})
|
|
1956
|
+
# @param [Hash] params ({})
|
|
1957
|
+
def update_event_source(params = {}, options = {})
|
|
1958
|
+
req = build_request(:update_event_source, params)
|
|
1959
|
+
req.send_request(options)
|
|
1960
|
+
end
|
|
1961
|
+
|
|
1962
|
+
# Updates a subscriber. Fields omitted from the request are left
|
|
1963
|
+
# unchanged.
|
|
1964
|
+
#
|
|
1965
|
+
# @option params [required, String] :subscriber_arn
|
|
1966
|
+
# The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
|
|
1967
|
+
#
|
|
1968
|
+
# @option params [String] :description
|
|
1969
|
+
# Free-text description. Used by every resource type that has one: event
|
|
1970
|
+
# buses, subscribers, and event sources.
|
|
1971
|
+
#
|
|
1972
|
+
# @option params [String] :state
|
|
1973
|
+
# Customer-controlled run state of a subscriber, set on create or
|
|
1974
|
+
# update. Distinct from the bus lifecycle vocabulary, where ACTIVE means
|
|
1975
|
+
# "provisioned and healthy". Delivery requires State RUNNING on a
|
|
1976
|
+
# subscriber that is not revoked.
|
|
1977
|
+
#
|
|
1978
|
+
# @option params [String] :resume_position
|
|
1979
|
+
# Position from which delivery resumes when a subscriber is unpaused.
|
|
1980
|
+
# Honored only on an UpdateSubscriber call that transitions State from
|
|
1981
|
+
# STOPPED to RUNNING (unpause); ignored on any other call and not
|
|
1982
|
+
# accepted on Create. Defaults to LAST\_PROCESSED when omitted.
|
|
1983
|
+
#
|
|
1984
|
+
# @option params [Types::UpdateInvokeConfiguration] :invoke_configuration
|
|
1985
|
+
# Update-able configuration for how the subscriber invokes its target.
|
|
1986
|
+
#
|
|
1987
|
+
# @option params [Types::FilterConfiguration] :filter_configuration
|
|
1988
|
+
# Configuration for filtering events delivered to a subscriber. On
|
|
1989
|
+
# CreateSubscriber, Filters is required and must contain at least one
|
|
1990
|
+
# Filter with a non-empty Pattern. On UpdateSubscriber, an empty
|
|
1991
|
+
# `FilterConfiguration:{}` clears the existing filter. Any non-empty
|
|
1992
|
+
# shape (including `{Language:X}` without Filters) must contain a valid
|
|
1993
|
+
# Filters list — same contract as CreateSubscriber. A non-empty Filters
|
|
1994
|
+
# list overwrites; an omitted FilterConfiguration preserves existing
|
|
1995
|
+
# state. All Filters are implicitly ANDed — an event must match every
|
|
1996
|
+
# Filter to be delivered.
|
|
1997
|
+
#
|
|
1998
|
+
# @option params [Types::BatchConfiguration] :batch_configuration
|
|
1999
|
+
# Batching configuration for a subscriber.
|
|
2000
|
+
#
|
|
2001
|
+
# @option params [Types::Transformer] :transformer
|
|
2002
|
+
# Not applicable to universal (aws-sdk) targets, whose input
|
|
2003
|
+
# transformation is UniversalTargetParameters.Input; a Transformer on
|
|
2004
|
+
# such a target is rejected.
|
|
2005
|
+
#
|
|
2006
|
+
# @option params [Types::RetryPolicy] :retry_policy
|
|
2007
|
+
# Retry policy for a subscriber.
|
|
2008
|
+
#
|
|
2009
|
+
# @option params [Types::OnFailureConfiguration] :on_failure_configuration
|
|
2010
|
+
# On-failure configuration: where a failed delivery is sent. Shared by
|
|
2011
|
+
# the subscriber and the EventSource.
|
|
2012
|
+
#
|
|
2013
|
+
# @option params [Types::LogConfiguration] :log_configuration
|
|
2014
|
+
# Log configuration for a subscriber.
|
|
2015
|
+
#
|
|
2016
|
+
# @return [Types::UpdateSubscriberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2017
|
+
#
|
|
2018
|
+
# * {Types::UpdateSubscriberResponse#subscriber_arn #subscriber_arn} => String
|
|
2019
|
+
# * {Types::UpdateSubscriberResponse#name #name} => String
|
|
2020
|
+
# * {Types::UpdateSubscriberResponse#event_bus_arn #event_bus_arn} => String
|
|
2021
|
+
# * {Types::UpdateSubscriberResponse#type #type} => String
|
|
2022
|
+
# * {Types::UpdateSubscriberResponse#starting_position #starting_position} => String
|
|
2023
|
+
# * {Types::UpdateSubscriberResponse#point_in_time_configuration #point_in_time_configuration} => Types::PointInTimeConfiguration
|
|
2024
|
+
# * {Types::UpdateSubscriberResponse#state #state} => String
|
|
2025
|
+
# * {Types::UpdateSubscriberResponse#last_modified_time #last_modified_time} => Time
|
|
2026
|
+
#
|
|
2027
|
+
# @example Request syntax with placeholder values
|
|
2028
|
+
#
|
|
2029
|
+
# resp = client.update_subscriber({
|
|
2030
|
+
# subscriber_arn: "SubscriberArn", # required
|
|
2031
|
+
# description: "Description",
|
|
2032
|
+
# state: "RUNNING", # accepts RUNNING, STOPPED
|
|
2033
|
+
# resume_position: "LAST_PROCESSED", # accepts LAST_PROCESSED, LATEST
|
|
2034
|
+
# invoke_configuration: {
|
|
2035
|
+
# role_arn: "RoleArn", # required
|
|
2036
|
+
# lambda_parameters: {
|
|
2037
|
+
# invocation_type: "EVENT", # accepts EVENT, REQUEST_RESPONSE
|
|
2038
|
+
# qualifier: "LambdaParametersQualifierString",
|
|
2039
|
+
# durable_execution_name: "LambdaParametersDurableExecutionNameString",
|
|
2040
|
+
# tenant_id: "LambdaParametersTenantIdString",
|
|
2041
|
+
# invocation_timeout_seconds: "LambdaParametersInvocationTimeoutSecondsString",
|
|
2042
|
+
# },
|
|
2043
|
+
# sqs_parameters: {
|
|
2044
|
+
# message_group_id: "SqsParametersMessageGroupIdString",
|
|
2045
|
+
# message_deduplication_id: "SqsParametersMessageDeduplicationIdString",
|
|
2046
|
+
# delay_seconds: "SqsParametersDelaySecondsString",
|
|
2047
|
+
# message_attributes: {
|
|
2048
|
+
# "MessageAttributeName" => {
|
|
2049
|
+
# data_type: "SqsMessageAttributeValueDataTypeString",
|
|
2050
|
+
# string_value: "String",
|
|
2051
|
+
# binary_value: "String",
|
|
2052
|
+
# },
|
|
2053
|
+
# },
|
|
2054
|
+
# message_system_attributes: {
|
|
2055
|
+
# "MessageAttributeName" => {
|
|
2056
|
+
# data_type: "SqsMessageAttributeValueDataTypeString",
|
|
2057
|
+
# string_value: "String",
|
|
2058
|
+
# binary_value: "String",
|
|
2059
|
+
# },
|
|
2060
|
+
# },
|
|
2061
|
+
# },
|
|
2062
|
+
# sns_parameters: {
|
|
2063
|
+
# message_group_id: "SnsParametersMessageGroupIdString",
|
|
2064
|
+
# message_deduplication_id: "SnsParametersMessageDeduplicationIdString",
|
|
2065
|
+
# subject: "SnsParametersSubjectString",
|
|
2066
|
+
# message_structure: "SnsParametersMessageStructureString",
|
|
2067
|
+
# message_attributes: {
|
|
2068
|
+
# "MessageAttributeName" => {
|
|
2069
|
+
# data_type: "SnsMessageAttributeValueDataTypeString",
|
|
2070
|
+
# string_value: "String",
|
|
2071
|
+
# binary_value: "String",
|
|
2072
|
+
# },
|
|
2073
|
+
# },
|
|
2074
|
+
# },
|
|
2075
|
+
# kinesis_parameters: {
|
|
2076
|
+
# partition_key: "KinesisParametersPartitionKeyString",
|
|
2077
|
+
# explicit_hash_key: "KinesisParametersExplicitHashKeyString",
|
|
2078
|
+
# },
|
|
2079
|
+
# step_functions_parameters: {
|
|
2080
|
+
# invocation_type: "EVENT", # accepts EVENT, REQUEST_RESPONSE
|
|
2081
|
+
# name: "StepFunctionsParametersNameString",
|
|
2082
|
+
# trace_header: "StepFunctionsParametersTraceHeaderString",
|
|
2083
|
+
# invocation_timeout_seconds: "StepFunctionsParametersInvocationTimeoutSecondsString",
|
|
2084
|
+
# },
|
|
2085
|
+
# http_parameters: {
|
|
2086
|
+
# path_parameter_values: ["PathParameter"],
|
|
2087
|
+
# header_parameters: {
|
|
2088
|
+
# "HeaderKey" => "HeaderValue",
|
|
2089
|
+
# },
|
|
2090
|
+
# query_string_parameters: {
|
|
2091
|
+
# "QueryStringKey" => "QueryStringValue",
|
|
2092
|
+
# },
|
|
2093
|
+
# invocation_timeout_seconds: "String",
|
|
2094
|
+
# },
|
|
2095
|
+
# universal_target_parameters: {
|
|
2096
|
+
# input: "UniversalTargetInput", # required
|
|
2097
|
+
# invocation_timeout_seconds: "String",
|
|
2098
|
+
# },
|
|
2099
|
+
# event_bus_v2_parameters: {
|
|
2100
|
+
# metadata: {
|
|
2101
|
+
# "String" => "String",
|
|
2102
|
+
# },
|
|
2103
|
+
# system_metadata: {
|
|
2104
|
+
# event_group_id: "String",
|
|
2105
|
+
# deduplication_id: "String",
|
|
2106
|
+
# },
|
|
2107
|
+
# deduplication_configuration: {
|
|
2108
|
+
# deduplication_type: "CONTENT_BASED", # required, accepts CONTENT_BASED
|
|
2109
|
+
# },
|
|
2110
|
+
# },
|
|
2111
|
+
# },
|
|
2112
|
+
# filter_configuration: {
|
|
2113
|
+
# language: "EVENT_BRIDGE_PATTERN", # accepts EVENT_BRIDGE_PATTERN
|
|
2114
|
+
# filters: [
|
|
2115
|
+
# {
|
|
2116
|
+
# pattern: "EventPattern", # required
|
|
2117
|
+
# scope: "DATA", # required, accepts DATA, METADATA, SYSTEM_METADATA
|
|
2118
|
+
# },
|
|
2119
|
+
# ],
|
|
2120
|
+
# },
|
|
2121
|
+
# batch_configuration: {
|
|
2122
|
+
# max_batch_size: 1,
|
|
2123
|
+
# max_batch_window_in_seconds: 1,
|
|
2124
|
+
# },
|
|
2125
|
+
# transformer: {
|
|
2126
|
+
# type: "RAW", # accepts RAW, WITH_METADATA, JSONATA
|
|
2127
|
+
# jsonata_configuration: {
|
|
2128
|
+
# expression: "JsonataConfigurationExpressionString", # required
|
|
2129
|
+
# },
|
|
2130
|
+
# },
|
|
2131
|
+
# retry_policy: {
|
|
2132
|
+
# max_retry_attempts: 1,
|
|
2133
|
+
# max_event_age_in_seconds: 1,
|
|
2134
|
+
# retry_strategy: "ALL", # accepts ALL
|
|
2135
|
+
# },
|
|
2136
|
+
# on_failure_configuration: {
|
|
2137
|
+
# arn: "DeadLetterQueueArn",
|
|
2138
|
+
# },
|
|
2139
|
+
# log_configuration: {
|
|
2140
|
+
# level: "OFF", # accepts OFF, ERROR, INFO
|
|
2141
|
+
# include_payload: "FULL", # accepts FULL, ON_ERROR_ONLY
|
|
2142
|
+
# },
|
|
2143
|
+
# })
|
|
2144
|
+
#
|
|
2145
|
+
# @example Response structure
|
|
2146
|
+
#
|
|
2147
|
+
# resp.subscriber_arn #=> String
|
|
2148
|
+
# resp.name #=> String
|
|
2149
|
+
# resp.event_bus_arn #=> String
|
|
2150
|
+
# resp.type #=> String, one of "FIFO", "UNORDERED"
|
|
2151
|
+
# resp.starting_position #=> String, one of "LATEST", "POINT_IN_TIME"
|
|
2152
|
+
# resp.point_in_time_configuration.point_type #=> String, one of "HORIZON", "TIMESTAMP"
|
|
2153
|
+
# resp.point_in_time_configuration.starting_point #=> Time
|
|
2154
|
+
# resp.point_in_time_configuration.end_point #=> Time
|
|
2155
|
+
# resp.state #=> String, one of "RUNNING", "STOPPED"
|
|
2156
|
+
# resp.last_modified_time #=> Time
|
|
2157
|
+
#
|
|
2158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UpdateSubscriber AWS API Documentation
|
|
2159
|
+
#
|
|
2160
|
+
# @overload update_subscriber(params = {})
|
|
2161
|
+
# @param [Hash] params ({})
|
|
2162
|
+
def update_subscriber(params = {}, options = {})
|
|
2163
|
+
req = build_request(:update_subscriber, params)
|
|
2164
|
+
req.send_request(options)
|
|
2165
|
+
end
|
|
2166
|
+
|
|
2167
|
+
# @!endgroup
|
|
2168
|
+
|
|
2169
|
+
# @param params ({})
|
|
2170
|
+
# @api private
|
|
2171
|
+
def build_request(operation_name, params = {})
|
|
2172
|
+
handlers = @handlers.for(operation_name)
|
|
2173
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
|
2174
|
+
Aws::Telemetry.module_to_tracer_name('Aws::EventBridgeV2')
|
|
2175
|
+
)
|
|
2176
|
+
context = Seahorse::Client::RequestContext.new(
|
|
2177
|
+
operation_name: operation_name,
|
|
2178
|
+
operation: config.api.operation(operation_name),
|
|
2179
|
+
client: self,
|
|
2180
|
+
params: params,
|
|
2181
|
+
config: config,
|
|
2182
|
+
tracer: tracer
|
|
2183
|
+
)
|
|
2184
|
+
context[:gem_name] = 'aws-sdk-eventbridgev2'
|
|
2185
|
+
context[:gem_version] = '1.0.0'
|
|
2186
|
+
Seahorse::Client::Request.new(handlers, context)
|
|
2187
|
+
end
|
|
2188
|
+
|
|
2189
|
+
# Polls an API operation until a resource enters a desired state.
|
|
2190
|
+
#
|
|
2191
|
+
# ## Basic Usage
|
|
2192
|
+
#
|
|
2193
|
+
# A waiter will call an API operation until:
|
|
2194
|
+
#
|
|
2195
|
+
# * It is successful
|
|
2196
|
+
# * It enters a terminal state
|
|
2197
|
+
# * It makes the maximum number of attempts
|
|
2198
|
+
#
|
|
2199
|
+
# In between attempts, the waiter will sleep.
|
|
2200
|
+
#
|
|
2201
|
+
# # polls in a loop, sleeping between attempts
|
|
2202
|
+
# client.wait_until(waiter_name, params)
|
|
2203
|
+
#
|
|
2204
|
+
# ## Configuration
|
|
2205
|
+
#
|
|
2206
|
+
# You can configure the maximum number of polling attempts, and the
|
|
2207
|
+
# delay (in seconds) between each polling attempt. You can pass
|
|
2208
|
+
# configuration as the final arguments hash.
|
|
2209
|
+
#
|
|
2210
|
+
# # poll for ~25 seconds
|
|
2211
|
+
# client.wait_until(waiter_name, params, {
|
|
2212
|
+
# max_attempts: 5,
|
|
2213
|
+
# delay: 5,
|
|
2214
|
+
# })
|
|
2215
|
+
#
|
|
2216
|
+
# ## Callbacks
|
|
2217
|
+
#
|
|
2218
|
+
# You can be notified before each polling attempt and before each
|
|
2219
|
+
# delay. If you throw `:success` or `:failure` from these callbacks,
|
|
2220
|
+
# it will terminate the waiter.
|
|
2221
|
+
#
|
|
2222
|
+
# started_at = Time.now
|
|
2223
|
+
# client.wait_until(waiter_name, params, {
|
|
2224
|
+
#
|
|
2225
|
+
# # disable max attempts
|
|
2226
|
+
# max_attempts: nil,
|
|
2227
|
+
#
|
|
2228
|
+
# # poll for 1 hour, instead of a number of attempts
|
|
2229
|
+
# before_wait: -> (attempts, response) do
|
|
2230
|
+
# throw :failure if Time.now - started_at > 3600
|
|
2231
|
+
# end
|
|
2232
|
+
# })
|
|
2233
|
+
#
|
|
2234
|
+
# ## Handling Errors
|
|
2235
|
+
#
|
|
2236
|
+
# When a waiter is unsuccessful, it will raise an error.
|
|
2237
|
+
# All of the failure errors extend from
|
|
2238
|
+
# {Aws::Waiters::Errors::WaiterFailed}.
|
|
2239
|
+
#
|
|
2240
|
+
# begin
|
|
2241
|
+
# client.wait_until(...)
|
|
2242
|
+
# rescue Aws::Waiters::Errors::WaiterFailed
|
|
2243
|
+
# # resource did not enter the desired state in time
|
|
2244
|
+
# end
|
|
2245
|
+
#
|
|
2246
|
+
# ## Valid Waiters
|
|
2247
|
+
#
|
|
2248
|
+
# The following table lists the valid waiter names, the operations they call,
|
|
2249
|
+
# and the default `:delay` and `:max_attempts` values.
|
|
2250
|
+
#
|
|
2251
|
+
# | waiter_name | params | :delay | :max_attempts |
|
|
2252
|
+
# | ----------------- | --------------------------- | -------- | ------------- |
|
|
2253
|
+
# | event_bus_active | {Client#describe_event_bus} | 2 | 60 |
|
|
2254
|
+
# | event_bus_deleted | {Client#describe_event_bus} | 2 | 60 |
|
|
2255
|
+
#
|
|
2256
|
+
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
|
2257
|
+
# because the waiter has entered a state that it will not transition
|
|
2258
|
+
# out of, preventing success.
|
|
2259
|
+
#
|
|
2260
|
+
# @raise [Errors::TooManyAttemptsError] Raised when the configured
|
|
2261
|
+
# maximum number of attempts have been made, and the waiter is not
|
|
2262
|
+
# yet successful.
|
|
2263
|
+
#
|
|
2264
|
+
# @raise [Errors::UnexpectedError] Raised when an error is encounted
|
|
2265
|
+
# while polling for a resource that is not expected.
|
|
2266
|
+
#
|
|
2267
|
+
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
|
|
2268
|
+
# for an unknown state.
|
|
2269
|
+
#
|
|
2270
|
+
# @return [Boolean] Returns `true` if the waiter was successful.
|
|
2271
|
+
# @param [Symbol] waiter_name
|
|
2272
|
+
# @param [Hash] params ({})
|
|
2273
|
+
# @param [Hash] options ({})
|
|
2274
|
+
# @option options [Integer] :max_attempts
|
|
2275
|
+
# @option options [Integer] :delay
|
|
2276
|
+
# @option options [Proc] :before_attempt
|
|
2277
|
+
# @option options [Proc] :before_wait
|
|
2278
|
+
def wait_until(waiter_name, params = {}, options = {})
|
|
2279
|
+
w = waiter(waiter_name, options)
|
|
2280
|
+
yield(w.waiter) if block_given? # deprecated
|
|
2281
|
+
w.wait(params)
|
|
2282
|
+
end
|
|
2283
|
+
|
|
2284
|
+
# @api private
|
|
2285
|
+
# @deprecated
|
|
2286
|
+
def waiter_names
|
|
2287
|
+
waiters.keys
|
|
2288
|
+
end
|
|
2289
|
+
|
|
2290
|
+
private
|
|
2291
|
+
|
|
2292
|
+
# @param [Symbol] waiter_name
|
|
2293
|
+
# @param [Hash] options ({})
|
|
2294
|
+
def waiter(waiter_name, options = {})
|
|
2295
|
+
waiter_class = waiters[waiter_name]
|
|
2296
|
+
if waiter_class
|
|
2297
|
+
waiter_class.new(options.merge(client: self))
|
|
2298
|
+
else
|
|
2299
|
+
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
|
|
2300
|
+
end
|
|
2301
|
+
end
|
|
2302
|
+
|
|
2303
|
+
def waiters
|
|
2304
|
+
{
|
|
2305
|
+
event_bus_active: Waiters::EventBusActive,
|
|
2306
|
+
event_bus_deleted: Waiters::EventBusDeleted
|
|
2307
|
+
}
|
|
2308
|
+
end
|
|
2309
|
+
|
|
2310
|
+
class << self
|
|
2311
|
+
|
|
2312
|
+
# @api private
|
|
2313
|
+
attr_reader :identifier
|
|
2314
|
+
|
|
2315
|
+
# @api private
|
|
2316
|
+
def errors_module
|
|
2317
|
+
Errors
|
|
2318
|
+
end
|
|
2319
|
+
|
|
2320
|
+
end
|
|
2321
|
+
end
|
|
2322
|
+
end
|