aws-sdk-pipes 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-pipes/client.rb +1603 -0
- data/lib/aws-sdk-pipes/client_api.rb +938 -0
- data/lib/aws-sdk-pipes/customizations.rb +0 -0
- data/lib/aws-sdk-pipes/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-pipes/endpoint_provider.rb +110 -0
- data/lib/aws-sdk-pipes/endpoints.rb +155 -0
- data/lib/aws-sdk-pipes/errors.rb +189 -0
- data/lib/aws-sdk-pipes/plugins/endpoints.rb +88 -0
- data/lib/aws-sdk-pipes/resource.rb +26 -0
- data/lib/aws-sdk-pipes/types.rb +3051 -0
- data/lib/aws-sdk-pipes.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,1603 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
|
+
|
36
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:pipes)
|
37
|
+
|
38
|
+
module Aws::Pipes
|
39
|
+
# An API client for Pipes. To construct a client, you need to configure a `:region` and `:credentials`.
|
40
|
+
#
|
41
|
+
# client = Aws::Pipes::Client.new(
|
42
|
+
# region: region_name,
|
43
|
+
# credentials: credentials,
|
44
|
+
# # ...
|
45
|
+
# )
|
46
|
+
#
|
47
|
+
# For details on configuring region and credentials see
|
48
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
49
|
+
#
|
50
|
+
# See {#initialize} for a full list of supported configuration options.
|
51
|
+
class Client < Seahorse::Client::Base
|
52
|
+
|
53
|
+
include Aws::ClientStubs
|
54
|
+
|
55
|
+
@identifier = :pipes
|
56
|
+
|
57
|
+
set_api(ClientApi::API)
|
58
|
+
|
59
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
60
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
61
|
+
add_plugin(Aws::Plugins::Logging)
|
62
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
63
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
64
|
+
add_plugin(Aws::Plugins::UserAgent)
|
65
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
66
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
67
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
68
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
69
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
70
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
71
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
72
|
+
add_plugin(Aws::Plugins::StubResponses)
|
73
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
74
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
75
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
76
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
77
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
78
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
81
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::Pipes::Plugins::Endpoints)
|
85
|
+
|
86
|
+
# @overload initialize(options)
|
87
|
+
# @param [Hash] options
|
88
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
89
|
+
# Your AWS credentials. This can be an instance of any one of the
|
90
|
+
# following classes:
|
91
|
+
#
|
92
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
93
|
+
# credentials.
|
94
|
+
#
|
95
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
96
|
+
# shared file, such as `~/.aws/config`.
|
97
|
+
#
|
98
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
99
|
+
#
|
100
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
101
|
+
# assume a role after providing credentials via the web.
|
102
|
+
#
|
103
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
104
|
+
# access token generated from `aws login`.
|
105
|
+
#
|
106
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
107
|
+
# process that outputs to stdout.
|
108
|
+
#
|
109
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
110
|
+
# from an EC2 IMDS on an EC2 instance.
|
111
|
+
#
|
112
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
113
|
+
# instances running in ECS.
|
114
|
+
#
|
115
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
116
|
+
# from the Cognito Identity service.
|
117
|
+
#
|
118
|
+
# When `:credentials` are not configured directly, the following
|
119
|
+
# locations will be searched for credentials:
|
120
|
+
#
|
121
|
+
# * `Aws.config[:credentials]`
|
122
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
123
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
124
|
+
# * `~/.aws/credentials`
|
125
|
+
# * `~/.aws/config`
|
126
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
127
|
+
# are very aggressive. Construct and pass an instance of
|
128
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
129
|
+
# enable retries and extended timeouts. Instance profile credential
|
130
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
131
|
+
# to true.
|
132
|
+
#
|
133
|
+
# @option options [required, String] :region
|
134
|
+
# The AWS region to connect to. The configured `:region` is
|
135
|
+
# used to determine the service `:endpoint`. When not passed,
|
136
|
+
# a default `:region` is searched for in the following locations:
|
137
|
+
#
|
138
|
+
# * `Aws.config[:region]`
|
139
|
+
# * `ENV['AWS_REGION']`
|
140
|
+
# * `ENV['AMAZON_REGION']`
|
141
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
142
|
+
# * `~/.aws/credentials`
|
143
|
+
# * `~/.aws/config`
|
144
|
+
#
|
145
|
+
# @option options [String] :access_key_id
|
146
|
+
#
|
147
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
148
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
149
|
+
# the background every 60 secs (default). Defaults to `false`.
|
150
|
+
#
|
151
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
152
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
153
|
+
# until there is sufficent client side capacity to retry the request.
|
154
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
155
|
+
# not retry instead of sleeping.
|
156
|
+
#
|
157
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
158
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
159
|
+
# this client.
|
160
|
+
#
|
161
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
162
|
+
# Allows you to provide an identifier for this client which will be attached to
|
163
|
+
# all generated client side metrics. Defaults to an empty string.
|
164
|
+
#
|
165
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
166
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
167
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
168
|
+
#
|
169
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
170
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
171
|
+
# agent is running on, where client metrics will be published via UDP.
|
172
|
+
#
|
173
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
174
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
175
|
+
# will use the Client Side Monitoring Agent Publisher.
|
176
|
+
#
|
177
|
+
# @option options [Boolean] :convert_params (true)
|
178
|
+
# When `true`, an attempt is made to coerce request parameters into
|
179
|
+
# the required types.
|
180
|
+
#
|
181
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
182
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
183
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
184
|
+
#
|
185
|
+
# @option options [String] :defaults_mode ("legacy")
|
186
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
187
|
+
# accepted modes and the configuration defaults that are included.
|
188
|
+
#
|
189
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
190
|
+
# Set to true to disable SDK automatically adding host prefix
|
191
|
+
# to default service endpoint when available.
|
192
|
+
#
|
193
|
+
# @option options [String] :endpoint
|
194
|
+
# The client endpoint is normally constructed from the `:region`
|
195
|
+
# option. You should only configure an `:endpoint` when connecting
|
196
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
197
|
+
#
|
198
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
199
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
200
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
201
|
+
#
|
202
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
203
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
204
|
+
#
|
205
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
206
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
207
|
+
# Use this option to config the time interval in seconds for making
|
208
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
209
|
+
#
|
210
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
211
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
212
|
+
#
|
213
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
214
|
+
# The log formatter.
|
215
|
+
#
|
216
|
+
# @option options [Symbol] :log_level (:info)
|
217
|
+
# The log level to send messages to the `:logger` at.
|
218
|
+
#
|
219
|
+
# @option options [Logger] :logger
|
220
|
+
# The Logger instance to send log messages to. If this option
|
221
|
+
# is not set, logging will be disabled.
|
222
|
+
#
|
223
|
+
# @option options [Integer] :max_attempts (3)
|
224
|
+
# An integer representing the maximum number attempts that will be made for
|
225
|
+
# a single request, including the initial attempt. For example,
|
226
|
+
# setting this value to 5 will result in a request being retried up to
|
227
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
228
|
+
#
|
229
|
+
# @option options [String] :profile ("default")
|
230
|
+
# Used when loading credentials from the shared credentials file
|
231
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
232
|
+
#
|
233
|
+
# @option options [Proc] :retry_backoff
|
234
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
235
|
+
# This option is only used in the `legacy` retry mode.
|
236
|
+
#
|
237
|
+
# @option options [Float] :retry_base_delay (0.3)
|
238
|
+
# The base delay in seconds used by the default backoff function. This option
|
239
|
+
# is only used in the `legacy` retry mode.
|
240
|
+
#
|
241
|
+
# @option options [Symbol] :retry_jitter (:none)
|
242
|
+
# A delay randomiser function used by the default backoff function.
|
243
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
244
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
245
|
+
# in the `legacy` retry mode.
|
246
|
+
#
|
247
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
248
|
+
#
|
249
|
+
# @option options [Integer] :retry_limit (3)
|
250
|
+
# The maximum number of times to retry failed requests. Only
|
251
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
252
|
+
# are retried. Generally, these are throttling errors, data
|
253
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
254
|
+
# endpoint discovery, and errors from expired credentials.
|
255
|
+
# This option is only used in the `legacy` retry mode.
|
256
|
+
#
|
257
|
+
# @option options [Integer] :retry_max_delay (0)
|
258
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
259
|
+
# used by the default backoff function. This option is only used in the
|
260
|
+
# `legacy` retry mode.
|
261
|
+
#
|
262
|
+
# @option options [String] :retry_mode ("legacy")
|
263
|
+
# Specifies which retry algorithm to use. Values are:
|
264
|
+
#
|
265
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
266
|
+
# no retry mode is provided.
|
267
|
+
#
|
268
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
269
|
+
# This includes support for retry quotas, which limit the number of
|
270
|
+
# unsuccessful retries a client can make.
|
271
|
+
#
|
272
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
273
|
+
# functionality of `standard` mode along with automatic client side
|
274
|
+
# throttling. This is a provisional mode that may change behavior
|
275
|
+
# in the future.
|
276
|
+
#
|
277
|
+
#
|
278
|
+
# @option options [String] :secret_access_key
|
279
|
+
#
|
280
|
+
# @option options [String] :session_token
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :stub_responses (false)
|
283
|
+
# Causes the client to return stubbed responses. By default
|
284
|
+
# fake responses are generated and returned. You can specify
|
285
|
+
# the response data to return or errors to raise by calling
|
286
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
287
|
+
#
|
288
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
289
|
+
# requests are made, and retries are disabled.
|
290
|
+
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
304
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
305
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
306
|
+
# will be used if available.
|
307
|
+
#
|
308
|
+
# @option options [Boolean] :use_fips_endpoint
|
309
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
310
|
+
# When a `fips` region is used, the region is normalized and this config
|
311
|
+
# is set to `true`.
|
312
|
+
#
|
313
|
+
# @option options [Boolean] :validate_params (true)
|
314
|
+
# When `true`, request parameters are validated before
|
315
|
+
# sending the request.
|
316
|
+
#
|
317
|
+
# @option options [Aws::Pipes::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Pipes::EndpointParameters`
|
319
|
+
#
|
320
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
321
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
322
|
+
#
|
323
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
324
|
+
# seconds to wait when opening a HTTP session before raising a
|
325
|
+
# `Timeout::Error`.
|
326
|
+
#
|
327
|
+
# @option options [Float] :http_read_timeout (60) The default
|
328
|
+
# number of seconds to wait for response data. This value can
|
329
|
+
# safely be set per-request on the session.
|
330
|
+
#
|
331
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
332
|
+
# seconds a connection is allowed to sit idle before it is
|
333
|
+
# considered stale. Stale connections are closed and removed
|
334
|
+
# from the pool before making a request.
|
335
|
+
#
|
336
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
337
|
+
# seconds to wait for a 100-continue response before sending the
|
338
|
+
# request body. This option has no effect unless the request has
|
339
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
340
|
+
# disables this behaviour. This value can safely be set per
|
341
|
+
# request on the session.
|
342
|
+
#
|
343
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
344
|
+
# in seconds.
|
345
|
+
#
|
346
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
347
|
+
# HTTP debug output will be sent to the `:logger`.
|
348
|
+
#
|
349
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
350
|
+
# SSL peer certificates are verified when establishing a
|
351
|
+
# connection.
|
352
|
+
#
|
353
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
354
|
+
# certificate authority bundle file that should be used when
|
355
|
+
# verifying peer certificates. If you do not pass
|
356
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
357
|
+
# will be used if available.
|
358
|
+
#
|
359
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
360
|
+
# directory that contains the unbundled SSL certificate
|
361
|
+
# authority files for verifying peer certificates. If you do
|
362
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
363
|
+
# system default will be used if available.
|
364
|
+
#
|
365
|
+
def initialize(*args)
|
366
|
+
super
|
367
|
+
end
|
368
|
+
|
369
|
+
# @!group API Operations
|
370
|
+
|
371
|
+
# Create a pipe. Amazon EventBridge Pipes connect event sources to
|
372
|
+
# targets and reduces the need for specialized knowledge and integration
|
373
|
+
# code.
|
374
|
+
#
|
375
|
+
# @option params [String] :description
|
376
|
+
# A description of the pipe.
|
377
|
+
#
|
378
|
+
# @option params [String] :desired_state
|
379
|
+
# The state the pipe should be in.
|
380
|
+
#
|
381
|
+
# @option params [String] :enrichment
|
382
|
+
# The ARN of the enrichment resource.
|
383
|
+
#
|
384
|
+
# @option params [Types::PipeEnrichmentParameters] :enrichment_parameters
|
385
|
+
# The parameters required to set up enrichment on your pipe.
|
386
|
+
#
|
387
|
+
# @option params [required, String] :name
|
388
|
+
# The name of the pipe.
|
389
|
+
#
|
390
|
+
# @option params [required, String] :role_arn
|
391
|
+
# The ARN of the role that allows the pipe to send data to the target.
|
392
|
+
#
|
393
|
+
# @option params [required, String] :source
|
394
|
+
# The ARN of the source resource.
|
395
|
+
#
|
396
|
+
# @option params [Types::PipeSourceParameters] :source_parameters
|
397
|
+
# The parameters required to set up a source for your pipe.
|
398
|
+
#
|
399
|
+
# @option params [Hash<String,String>] :tags
|
400
|
+
# The list of key-value pairs to associate with the pipe.
|
401
|
+
#
|
402
|
+
# @option params [required, String] :target
|
403
|
+
# The ARN of the target resource.
|
404
|
+
#
|
405
|
+
# @option params [Types::PipeTargetParameters] :target_parameters
|
406
|
+
# The parameters required to set up a target for your pipe.
|
407
|
+
#
|
408
|
+
# @return [Types::CreatePipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
409
|
+
#
|
410
|
+
# * {Types::CreatePipeResponse#arn #arn} => String
|
411
|
+
# * {Types::CreatePipeResponse#creation_time #creation_time} => Time
|
412
|
+
# * {Types::CreatePipeResponse#current_state #current_state} => String
|
413
|
+
# * {Types::CreatePipeResponse#desired_state #desired_state} => String
|
414
|
+
# * {Types::CreatePipeResponse#last_modified_time #last_modified_time} => Time
|
415
|
+
# * {Types::CreatePipeResponse#name #name} => String
|
416
|
+
#
|
417
|
+
# @example Request syntax with placeholder values
|
418
|
+
#
|
419
|
+
# resp = client.create_pipe({
|
420
|
+
# description: "PipeDescription",
|
421
|
+
# desired_state: "RUNNING", # accepts RUNNING, STOPPED
|
422
|
+
# enrichment: "OptionalArn",
|
423
|
+
# enrichment_parameters: {
|
424
|
+
# http_parameters: {
|
425
|
+
# header_parameters: {
|
426
|
+
# "HeaderKey" => "HeaderValue",
|
427
|
+
# },
|
428
|
+
# path_parameter_values: ["PathParameter"],
|
429
|
+
# query_string_parameters: {
|
430
|
+
# "QueryStringKey" => "QueryStringValue",
|
431
|
+
# },
|
432
|
+
# },
|
433
|
+
# input_template: "InputTemplate",
|
434
|
+
# },
|
435
|
+
# name: "PipeName", # required
|
436
|
+
# role_arn: "RoleArn", # required
|
437
|
+
# source: "ArnOrUrl", # required
|
438
|
+
# source_parameters: {
|
439
|
+
# active_mq_broker_parameters: {
|
440
|
+
# batch_size: 1,
|
441
|
+
# credentials: { # required
|
442
|
+
# basic_auth: "SecretManagerArn",
|
443
|
+
# },
|
444
|
+
# maximum_batching_window_in_seconds: 1,
|
445
|
+
# queue_name: "MQBrokerQueueName", # required
|
446
|
+
# },
|
447
|
+
# dynamo_db_stream_parameters: {
|
448
|
+
# batch_size: 1,
|
449
|
+
# dead_letter_config: {
|
450
|
+
# arn: "Arn",
|
451
|
+
# },
|
452
|
+
# maximum_batching_window_in_seconds: 1,
|
453
|
+
# maximum_record_age_in_seconds: 1,
|
454
|
+
# maximum_retry_attempts: 1,
|
455
|
+
# on_partial_batch_item_failure: "AUTOMATIC_BISECT", # accepts AUTOMATIC_BISECT
|
456
|
+
# parallelization_factor: 1,
|
457
|
+
# starting_position: "TRIM_HORIZON", # required, accepts TRIM_HORIZON, LATEST
|
458
|
+
# },
|
459
|
+
# filter_criteria: {
|
460
|
+
# filters: [
|
461
|
+
# {
|
462
|
+
# pattern: "EventPattern",
|
463
|
+
# },
|
464
|
+
# ],
|
465
|
+
# },
|
466
|
+
# kinesis_stream_parameters: {
|
467
|
+
# batch_size: 1,
|
468
|
+
# dead_letter_config: {
|
469
|
+
# arn: "Arn",
|
470
|
+
# },
|
471
|
+
# maximum_batching_window_in_seconds: 1,
|
472
|
+
# maximum_record_age_in_seconds: 1,
|
473
|
+
# maximum_retry_attempts: 1,
|
474
|
+
# on_partial_batch_item_failure: "AUTOMATIC_BISECT", # accepts AUTOMATIC_BISECT
|
475
|
+
# parallelization_factor: 1,
|
476
|
+
# starting_position: "TRIM_HORIZON", # required, accepts TRIM_HORIZON, LATEST, AT_TIMESTAMP
|
477
|
+
# starting_position_timestamp: Time.now,
|
478
|
+
# },
|
479
|
+
# managed_streaming_kafka_parameters: {
|
480
|
+
# batch_size: 1,
|
481
|
+
# consumer_group_id: "URI",
|
482
|
+
# credentials: {
|
483
|
+
# client_certificate_tls_auth: "SecretManagerArn",
|
484
|
+
# sasl_scram_512_auth: "SecretManagerArn",
|
485
|
+
# },
|
486
|
+
# maximum_batching_window_in_seconds: 1,
|
487
|
+
# starting_position: "TRIM_HORIZON", # accepts TRIM_HORIZON, LATEST
|
488
|
+
# topic_name: "KafkaTopicName", # required
|
489
|
+
# },
|
490
|
+
# rabbit_mq_broker_parameters: {
|
491
|
+
# batch_size: 1,
|
492
|
+
# credentials: { # required
|
493
|
+
# basic_auth: "SecretManagerArn",
|
494
|
+
# },
|
495
|
+
# maximum_batching_window_in_seconds: 1,
|
496
|
+
# queue_name: "MQBrokerQueueName", # required
|
497
|
+
# virtual_host: "URI",
|
498
|
+
# },
|
499
|
+
# self_managed_kafka_parameters: {
|
500
|
+
# additional_bootstrap_servers: ["EndpointString"],
|
501
|
+
# batch_size: 1,
|
502
|
+
# consumer_group_id: "URI",
|
503
|
+
# credentials: {
|
504
|
+
# basic_auth: "SecretManagerArn",
|
505
|
+
# client_certificate_tls_auth: "SecretManagerArn",
|
506
|
+
# sasl_scram_256_auth: "SecretManagerArn",
|
507
|
+
# sasl_scram_512_auth: "SecretManagerArn",
|
508
|
+
# },
|
509
|
+
# maximum_batching_window_in_seconds: 1,
|
510
|
+
# server_root_ca_certificate: "SecretManagerArn",
|
511
|
+
# starting_position: "TRIM_HORIZON", # accepts TRIM_HORIZON, LATEST
|
512
|
+
# topic_name: "KafkaTopicName", # required
|
513
|
+
# vpc: {
|
514
|
+
# security_group: ["SecurityGroupId"],
|
515
|
+
# subnets: ["SubnetId"],
|
516
|
+
# },
|
517
|
+
# },
|
518
|
+
# sqs_queue_parameters: {
|
519
|
+
# batch_size: 1,
|
520
|
+
# maximum_batching_window_in_seconds: 1,
|
521
|
+
# },
|
522
|
+
# },
|
523
|
+
# tags: {
|
524
|
+
# "TagKey" => "TagValue",
|
525
|
+
# },
|
526
|
+
# target: "Arn", # required
|
527
|
+
# target_parameters: {
|
528
|
+
# batch_job_parameters: {
|
529
|
+
# array_properties: {
|
530
|
+
# size: 1,
|
531
|
+
# },
|
532
|
+
# container_overrides: {
|
533
|
+
# command: ["String"],
|
534
|
+
# environment: [
|
535
|
+
# {
|
536
|
+
# name: "String",
|
537
|
+
# value: "String",
|
538
|
+
# },
|
539
|
+
# ],
|
540
|
+
# instance_type: "String",
|
541
|
+
# resource_requirements: [
|
542
|
+
# {
|
543
|
+
# type: "GPU", # required, accepts GPU, MEMORY, VCPU
|
544
|
+
# value: "String", # required
|
545
|
+
# },
|
546
|
+
# ],
|
547
|
+
# },
|
548
|
+
# depends_on: [
|
549
|
+
# {
|
550
|
+
# job_id: "String",
|
551
|
+
# type: "N_TO_N", # accepts N_TO_N, SEQUENTIAL
|
552
|
+
# },
|
553
|
+
# ],
|
554
|
+
# job_definition: "String", # required
|
555
|
+
# job_name: "String", # required
|
556
|
+
# parameters: {
|
557
|
+
# "String" => "String",
|
558
|
+
# },
|
559
|
+
# retry_strategy: {
|
560
|
+
# attempts: 1,
|
561
|
+
# },
|
562
|
+
# },
|
563
|
+
# cloud_watch_logs_parameters: {
|
564
|
+
# log_stream_name: "LogStreamName",
|
565
|
+
# timestamp: "JsonPath",
|
566
|
+
# },
|
567
|
+
# ecs_task_parameters: {
|
568
|
+
# capacity_provider_strategy: [
|
569
|
+
# {
|
570
|
+
# base: 1,
|
571
|
+
# capacity_provider: "CapacityProvider", # required
|
572
|
+
# weight: 1,
|
573
|
+
# },
|
574
|
+
# ],
|
575
|
+
# enable_ecs_managed_tags: false,
|
576
|
+
# enable_execute_command: false,
|
577
|
+
# group: "String",
|
578
|
+
# launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
|
579
|
+
# network_configuration: {
|
580
|
+
# awsvpc_configuration: {
|
581
|
+
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
582
|
+
# security_groups: ["SecurityGroup"],
|
583
|
+
# subnets: ["Subnet"], # required
|
584
|
+
# },
|
585
|
+
# },
|
586
|
+
# overrides: {
|
587
|
+
# container_overrides: [
|
588
|
+
# {
|
589
|
+
# command: ["String"],
|
590
|
+
# cpu: 1,
|
591
|
+
# environment: [
|
592
|
+
# {
|
593
|
+
# name: "String",
|
594
|
+
# value: "String",
|
595
|
+
# },
|
596
|
+
# ],
|
597
|
+
# environment_files: [
|
598
|
+
# {
|
599
|
+
# type: "s3", # required, accepts s3
|
600
|
+
# value: "String", # required
|
601
|
+
# },
|
602
|
+
# ],
|
603
|
+
# memory: 1,
|
604
|
+
# memory_reservation: 1,
|
605
|
+
# name: "String",
|
606
|
+
# resource_requirements: [
|
607
|
+
# {
|
608
|
+
# type: "GPU", # required, accepts GPU, InferenceAccelerator
|
609
|
+
# value: "String", # required
|
610
|
+
# },
|
611
|
+
# ],
|
612
|
+
# },
|
613
|
+
# ],
|
614
|
+
# cpu: "String",
|
615
|
+
# ephemeral_storage: {
|
616
|
+
# size_in_gi_b: 1, # required
|
617
|
+
# },
|
618
|
+
# execution_role_arn: "ArnOrJsonPath",
|
619
|
+
# inference_accelerator_overrides: [
|
620
|
+
# {
|
621
|
+
# device_name: "String",
|
622
|
+
# device_type: "String",
|
623
|
+
# },
|
624
|
+
# ],
|
625
|
+
# memory: "String",
|
626
|
+
# task_role_arn: "ArnOrJsonPath",
|
627
|
+
# },
|
628
|
+
# placement_constraints: [
|
629
|
+
# {
|
630
|
+
# expression: "PlacementConstraintExpression",
|
631
|
+
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
632
|
+
# },
|
633
|
+
# ],
|
634
|
+
# placement_strategy: [
|
635
|
+
# {
|
636
|
+
# field: "PlacementStrategyField",
|
637
|
+
# type: "random", # accepts random, spread, binpack
|
638
|
+
# },
|
639
|
+
# ],
|
640
|
+
# platform_version: "String",
|
641
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
|
642
|
+
# reference_id: "ReferenceId",
|
643
|
+
# tags: [
|
644
|
+
# {
|
645
|
+
# key: "TagKey", # required
|
646
|
+
# value: "TagValue", # required
|
647
|
+
# },
|
648
|
+
# ],
|
649
|
+
# task_count: 1,
|
650
|
+
# task_definition_arn: "ArnOrJsonPath", # required
|
651
|
+
# },
|
652
|
+
# event_bridge_event_bus_parameters: {
|
653
|
+
# detail_type: "EventBridgeDetailType",
|
654
|
+
# endpoint_id: "EventBridgeEndpointId",
|
655
|
+
# resources: ["ArnOrJsonPath"],
|
656
|
+
# source: "EventBridgeEventSource",
|
657
|
+
# time: "JsonPath",
|
658
|
+
# },
|
659
|
+
# http_parameters: {
|
660
|
+
# header_parameters: {
|
661
|
+
# "HeaderKey" => "HeaderValue",
|
662
|
+
# },
|
663
|
+
# path_parameter_values: ["PathParameter"],
|
664
|
+
# query_string_parameters: {
|
665
|
+
# "QueryStringKey" => "QueryStringValue",
|
666
|
+
# },
|
667
|
+
# },
|
668
|
+
# input_template: "InputTemplate",
|
669
|
+
# kinesis_stream_parameters: {
|
670
|
+
# partition_key: "KinesisPartitionKey", # required
|
671
|
+
# },
|
672
|
+
# lambda_function_parameters: {
|
673
|
+
# invocation_type: "REQUEST_RESPONSE", # accepts REQUEST_RESPONSE, FIRE_AND_FORGET
|
674
|
+
# },
|
675
|
+
# redshift_data_parameters: {
|
676
|
+
# database: "Database", # required
|
677
|
+
# db_user: "DbUser",
|
678
|
+
# secret_manager_arn: "SecretManagerArnOrJsonPath",
|
679
|
+
# sqls: ["Sql"], # required
|
680
|
+
# statement_name: "StatementName",
|
681
|
+
# with_event: false,
|
682
|
+
# },
|
683
|
+
# sage_maker_pipeline_parameters: {
|
684
|
+
# pipeline_parameter_list: [
|
685
|
+
# {
|
686
|
+
# name: "SageMakerPipelineParameterName", # required
|
687
|
+
# value: "SageMakerPipelineParameterValue", # required
|
688
|
+
# },
|
689
|
+
# ],
|
690
|
+
# },
|
691
|
+
# sqs_queue_parameters: {
|
692
|
+
# message_deduplication_id: "MessageDeduplicationId",
|
693
|
+
# message_group_id: "MessageGroupId",
|
694
|
+
# },
|
695
|
+
# step_function_state_machine_parameters: {
|
696
|
+
# invocation_type: "REQUEST_RESPONSE", # accepts REQUEST_RESPONSE, FIRE_AND_FORGET
|
697
|
+
# },
|
698
|
+
# },
|
699
|
+
# })
|
700
|
+
#
|
701
|
+
# @example Response structure
|
702
|
+
#
|
703
|
+
# resp.arn #=> String
|
704
|
+
# resp.creation_time #=> Time
|
705
|
+
# resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED"
|
706
|
+
# resp.desired_state #=> String, one of "RUNNING", "STOPPED"
|
707
|
+
# resp.last_modified_time #=> Time
|
708
|
+
# resp.name #=> String
|
709
|
+
#
|
710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/CreatePipe AWS API Documentation
|
711
|
+
#
|
712
|
+
# @overload create_pipe(params = {})
|
713
|
+
# @param [Hash] params ({})
|
714
|
+
def create_pipe(params = {}, options = {})
|
715
|
+
req = build_request(:create_pipe, params)
|
716
|
+
req.send_request(options)
|
717
|
+
end
|
718
|
+
|
719
|
+
# Delete an existing pipe. For more information about pipes, see [Amazon
|
720
|
+
# EventBridge Pipes][1] in the Amazon EventBridge User Guide.
|
721
|
+
#
|
722
|
+
#
|
723
|
+
#
|
724
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html
|
725
|
+
#
|
726
|
+
# @option params [required, String] :name
|
727
|
+
# The name of the pipe.
|
728
|
+
#
|
729
|
+
# @return [Types::DeletePipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
730
|
+
#
|
731
|
+
# * {Types::DeletePipeResponse#arn #arn} => String
|
732
|
+
# * {Types::DeletePipeResponse#creation_time #creation_time} => Time
|
733
|
+
# * {Types::DeletePipeResponse#current_state #current_state} => String
|
734
|
+
# * {Types::DeletePipeResponse#desired_state #desired_state} => String
|
735
|
+
# * {Types::DeletePipeResponse#last_modified_time #last_modified_time} => Time
|
736
|
+
# * {Types::DeletePipeResponse#name #name} => String
|
737
|
+
#
|
738
|
+
# @example Request syntax with placeholder values
|
739
|
+
#
|
740
|
+
# resp = client.delete_pipe({
|
741
|
+
# name: "PipeName", # required
|
742
|
+
# })
|
743
|
+
#
|
744
|
+
# @example Response structure
|
745
|
+
#
|
746
|
+
# resp.arn #=> String
|
747
|
+
# resp.creation_time #=> Time
|
748
|
+
# resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED"
|
749
|
+
# resp.desired_state #=> String, one of "RUNNING", "STOPPED", "DELETED"
|
750
|
+
# resp.last_modified_time #=> Time
|
751
|
+
# resp.name #=> String
|
752
|
+
#
|
753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/DeletePipe AWS API Documentation
|
754
|
+
#
|
755
|
+
# @overload delete_pipe(params = {})
|
756
|
+
# @param [Hash] params ({})
|
757
|
+
def delete_pipe(params = {}, options = {})
|
758
|
+
req = build_request(:delete_pipe, params)
|
759
|
+
req.send_request(options)
|
760
|
+
end
|
761
|
+
|
762
|
+
# Get the information about an existing pipe. For more information about
|
763
|
+
# pipes, see [Amazon EventBridge Pipes][1] in the Amazon EventBridge
|
764
|
+
# User Guide.
|
765
|
+
#
|
766
|
+
#
|
767
|
+
#
|
768
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html
|
769
|
+
#
|
770
|
+
# @option params [required, String] :name
|
771
|
+
# The name of the pipe.
|
772
|
+
#
|
773
|
+
# @return [Types::DescribePipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
774
|
+
#
|
775
|
+
# * {Types::DescribePipeResponse#arn #arn} => String
|
776
|
+
# * {Types::DescribePipeResponse#creation_time #creation_time} => Time
|
777
|
+
# * {Types::DescribePipeResponse#current_state #current_state} => String
|
778
|
+
# * {Types::DescribePipeResponse#description #description} => String
|
779
|
+
# * {Types::DescribePipeResponse#desired_state #desired_state} => String
|
780
|
+
# * {Types::DescribePipeResponse#enrichment #enrichment} => String
|
781
|
+
# * {Types::DescribePipeResponse#enrichment_parameters #enrichment_parameters} => Types::PipeEnrichmentParameters
|
782
|
+
# * {Types::DescribePipeResponse#last_modified_time #last_modified_time} => Time
|
783
|
+
# * {Types::DescribePipeResponse#name #name} => String
|
784
|
+
# * {Types::DescribePipeResponse#role_arn #role_arn} => String
|
785
|
+
# * {Types::DescribePipeResponse#source #source} => String
|
786
|
+
# * {Types::DescribePipeResponse#source_parameters #source_parameters} => Types::PipeSourceParameters
|
787
|
+
# * {Types::DescribePipeResponse#state_reason #state_reason} => String
|
788
|
+
# * {Types::DescribePipeResponse#tags #tags} => Hash<String,String>
|
789
|
+
# * {Types::DescribePipeResponse#target #target} => String
|
790
|
+
# * {Types::DescribePipeResponse#target_parameters #target_parameters} => Types::PipeTargetParameters
|
791
|
+
#
|
792
|
+
# @example Request syntax with placeholder values
|
793
|
+
#
|
794
|
+
# resp = client.describe_pipe({
|
795
|
+
# name: "PipeName", # required
|
796
|
+
# })
|
797
|
+
#
|
798
|
+
# @example Response structure
|
799
|
+
#
|
800
|
+
# resp.arn #=> String
|
801
|
+
# resp.creation_time #=> Time
|
802
|
+
# resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED"
|
803
|
+
# resp.description #=> String
|
804
|
+
# resp.desired_state #=> String, one of "RUNNING", "STOPPED", "DELETED"
|
805
|
+
# resp.enrichment #=> String
|
806
|
+
# resp.enrichment_parameters.http_parameters.header_parameters #=> Hash
|
807
|
+
# resp.enrichment_parameters.http_parameters.header_parameters["HeaderKey"] #=> String
|
808
|
+
# resp.enrichment_parameters.http_parameters.path_parameter_values #=> Array
|
809
|
+
# resp.enrichment_parameters.http_parameters.path_parameter_values[0] #=> String
|
810
|
+
# resp.enrichment_parameters.http_parameters.query_string_parameters #=> Hash
|
811
|
+
# resp.enrichment_parameters.http_parameters.query_string_parameters["QueryStringKey"] #=> String
|
812
|
+
# resp.enrichment_parameters.input_template #=> String
|
813
|
+
# resp.last_modified_time #=> Time
|
814
|
+
# resp.name #=> String
|
815
|
+
# resp.role_arn #=> String
|
816
|
+
# resp.source #=> String
|
817
|
+
# resp.source_parameters.active_mq_broker_parameters.batch_size #=> Integer
|
818
|
+
# resp.source_parameters.active_mq_broker_parameters.credentials.basic_auth #=> String
|
819
|
+
# resp.source_parameters.active_mq_broker_parameters.maximum_batching_window_in_seconds #=> Integer
|
820
|
+
# resp.source_parameters.active_mq_broker_parameters.queue_name #=> String
|
821
|
+
# resp.source_parameters.dynamo_db_stream_parameters.batch_size #=> Integer
|
822
|
+
# resp.source_parameters.dynamo_db_stream_parameters.dead_letter_config.arn #=> String
|
823
|
+
# resp.source_parameters.dynamo_db_stream_parameters.maximum_batching_window_in_seconds #=> Integer
|
824
|
+
# resp.source_parameters.dynamo_db_stream_parameters.maximum_record_age_in_seconds #=> Integer
|
825
|
+
# resp.source_parameters.dynamo_db_stream_parameters.maximum_retry_attempts #=> Integer
|
826
|
+
# resp.source_parameters.dynamo_db_stream_parameters.on_partial_batch_item_failure #=> String, one of "AUTOMATIC_BISECT"
|
827
|
+
# resp.source_parameters.dynamo_db_stream_parameters.parallelization_factor #=> Integer
|
828
|
+
# resp.source_parameters.dynamo_db_stream_parameters.starting_position #=> String, one of "TRIM_HORIZON", "LATEST"
|
829
|
+
# resp.source_parameters.filter_criteria.filters #=> Array
|
830
|
+
# resp.source_parameters.filter_criteria.filters[0].pattern #=> String
|
831
|
+
# resp.source_parameters.kinesis_stream_parameters.batch_size #=> Integer
|
832
|
+
# resp.source_parameters.kinesis_stream_parameters.dead_letter_config.arn #=> String
|
833
|
+
# resp.source_parameters.kinesis_stream_parameters.maximum_batching_window_in_seconds #=> Integer
|
834
|
+
# resp.source_parameters.kinesis_stream_parameters.maximum_record_age_in_seconds #=> Integer
|
835
|
+
# resp.source_parameters.kinesis_stream_parameters.maximum_retry_attempts #=> Integer
|
836
|
+
# resp.source_parameters.kinesis_stream_parameters.on_partial_batch_item_failure #=> String, one of "AUTOMATIC_BISECT"
|
837
|
+
# resp.source_parameters.kinesis_stream_parameters.parallelization_factor #=> Integer
|
838
|
+
# resp.source_parameters.kinesis_stream_parameters.starting_position #=> String, one of "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP"
|
839
|
+
# resp.source_parameters.kinesis_stream_parameters.starting_position_timestamp #=> Time
|
840
|
+
# resp.source_parameters.managed_streaming_kafka_parameters.batch_size #=> Integer
|
841
|
+
# resp.source_parameters.managed_streaming_kafka_parameters.consumer_group_id #=> String
|
842
|
+
# resp.source_parameters.managed_streaming_kafka_parameters.credentials.client_certificate_tls_auth #=> String
|
843
|
+
# resp.source_parameters.managed_streaming_kafka_parameters.credentials.sasl_scram_512_auth #=> String
|
844
|
+
# resp.source_parameters.managed_streaming_kafka_parameters.maximum_batching_window_in_seconds #=> Integer
|
845
|
+
# resp.source_parameters.managed_streaming_kafka_parameters.starting_position #=> String, one of "TRIM_HORIZON", "LATEST"
|
846
|
+
# resp.source_parameters.managed_streaming_kafka_parameters.topic_name #=> String
|
847
|
+
# resp.source_parameters.rabbit_mq_broker_parameters.batch_size #=> Integer
|
848
|
+
# resp.source_parameters.rabbit_mq_broker_parameters.credentials.basic_auth #=> String
|
849
|
+
# resp.source_parameters.rabbit_mq_broker_parameters.maximum_batching_window_in_seconds #=> Integer
|
850
|
+
# resp.source_parameters.rabbit_mq_broker_parameters.queue_name #=> String
|
851
|
+
# resp.source_parameters.rabbit_mq_broker_parameters.virtual_host #=> String
|
852
|
+
# resp.source_parameters.self_managed_kafka_parameters.additional_bootstrap_servers #=> Array
|
853
|
+
# resp.source_parameters.self_managed_kafka_parameters.additional_bootstrap_servers[0] #=> String
|
854
|
+
# resp.source_parameters.self_managed_kafka_parameters.batch_size #=> Integer
|
855
|
+
# resp.source_parameters.self_managed_kafka_parameters.consumer_group_id #=> String
|
856
|
+
# resp.source_parameters.self_managed_kafka_parameters.credentials.basic_auth #=> String
|
857
|
+
# resp.source_parameters.self_managed_kafka_parameters.credentials.client_certificate_tls_auth #=> String
|
858
|
+
# resp.source_parameters.self_managed_kafka_parameters.credentials.sasl_scram_256_auth #=> String
|
859
|
+
# resp.source_parameters.self_managed_kafka_parameters.credentials.sasl_scram_512_auth #=> String
|
860
|
+
# resp.source_parameters.self_managed_kafka_parameters.maximum_batching_window_in_seconds #=> Integer
|
861
|
+
# resp.source_parameters.self_managed_kafka_parameters.server_root_ca_certificate #=> String
|
862
|
+
# resp.source_parameters.self_managed_kafka_parameters.starting_position #=> String, one of "TRIM_HORIZON", "LATEST"
|
863
|
+
# resp.source_parameters.self_managed_kafka_parameters.topic_name #=> String
|
864
|
+
# resp.source_parameters.self_managed_kafka_parameters.vpc.security_group #=> Array
|
865
|
+
# resp.source_parameters.self_managed_kafka_parameters.vpc.security_group[0] #=> String
|
866
|
+
# resp.source_parameters.self_managed_kafka_parameters.vpc.subnets #=> Array
|
867
|
+
# resp.source_parameters.self_managed_kafka_parameters.vpc.subnets[0] #=> String
|
868
|
+
# resp.source_parameters.sqs_queue_parameters.batch_size #=> Integer
|
869
|
+
# resp.source_parameters.sqs_queue_parameters.maximum_batching_window_in_seconds #=> Integer
|
870
|
+
# resp.state_reason #=> String
|
871
|
+
# resp.tags #=> Hash
|
872
|
+
# resp.tags["TagKey"] #=> String
|
873
|
+
# resp.target #=> String
|
874
|
+
# resp.target_parameters.batch_job_parameters.array_properties.size #=> Integer
|
875
|
+
# resp.target_parameters.batch_job_parameters.container_overrides.command #=> Array
|
876
|
+
# resp.target_parameters.batch_job_parameters.container_overrides.command[0] #=> String
|
877
|
+
# resp.target_parameters.batch_job_parameters.container_overrides.environment #=> Array
|
878
|
+
# resp.target_parameters.batch_job_parameters.container_overrides.environment[0].name #=> String
|
879
|
+
# resp.target_parameters.batch_job_parameters.container_overrides.environment[0].value #=> String
|
880
|
+
# resp.target_parameters.batch_job_parameters.container_overrides.instance_type #=> String
|
881
|
+
# resp.target_parameters.batch_job_parameters.container_overrides.resource_requirements #=> Array
|
882
|
+
# resp.target_parameters.batch_job_parameters.container_overrides.resource_requirements[0].type #=> String, one of "GPU", "MEMORY", "VCPU"
|
883
|
+
# resp.target_parameters.batch_job_parameters.container_overrides.resource_requirements[0].value #=> String
|
884
|
+
# resp.target_parameters.batch_job_parameters.depends_on #=> Array
|
885
|
+
# resp.target_parameters.batch_job_parameters.depends_on[0].job_id #=> String
|
886
|
+
# resp.target_parameters.batch_job_parameters.depends_on[0].type #=> String, one of "N_TO_N", "SEQUENTIAL"
|
887
|
+
# resp.target_parameters.batch_job_parameters.job_definition #=> String
|
888
|
+
# resp.target_parameters.batch_job_parameters.job_name #=> String
|
889
|
+
# resp.target_parameters.batch_job_parameters.parameters #=> Hash
|
890
|
+
# resp.target_parameters.batch_job_parameters.parameters["String"] #=> String
|
891
|
+
# resp.target_parameters.batch_job_parameters.retry_strategy.attempts #=> Integer
|
892
|
+
# resp.target_parameters.cloud_watch_logs_parameters.log_stream_name #=> String
|
893
|
+
# resp.target_parameters.cloud_watch_logs_parameters.timestamp #=> String
|
894
|
+
# resp.target_parameters.ecs_task_parameters.capacity_provider_strategy #=> Array
|
895
|
+
# resp.target_parameters.ecs_task_parameters.capacity_provider_strategy[0].base #=> Integer
|
896
|
+
# resp.target_parameters.ecs_task_parameters.capacity_provider_strategy[0].capacity_provider #=> String
|
897
|
+
# resp.target_parameters.ecs_task_parameters.capacity_provider_strategy[0].weight #=> Integer
|
898
|
+
# resp.target_parameters.ecs_task_parameters.enable_ecs_managed_tags #=> Boolean
|
899
|
+
# resp.target_parameters.ecs_task_parameters.enable_execute_command #=> Boolean
|
900
|
+
# resp.target_parameters.ecs_task_parameters.group #=> String
|
901
|
+
# resp.target_parameters.ecs_task_parameters.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
902
|
+
# resp.target_parameters.ecs_task_parameters.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
903
|
+
# resp.target_parameters.ecs_task_parameters.network_configuration.awsvpc_configuration.security_groups #=> Array
|
904
|
+
# resp.target_parameters.ecs_task_parameters.network_configuration.awsvpc_configuration.security_groups[0] #=> String
|
905
|
+
# resp.target_parameters.ecs_task_parameters.network_configuration.awsvpc_configuration.subnets #=> Array
|
906
|
+
# resp.target_parameters.ecs_task_parameters.network_configuration.awsvpc_configuration.subnets[0] #=> String
|
907
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides #=> Array
|
908
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].command #=> Array
|
909
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].command[0] #=> String
|
910
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].cpu #=> Integer
|
911
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment #=> Array
|
912
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment[0].name #=> String
|
913
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment[0].value #=> String
|
914
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment_files #=> Array
|
915
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment_files[0].type #=> String, one of "s3"
|
916
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment_files[0].value #=> String
|
917
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].memory #=> Integer
|
918
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].memory_reservation #=> Integer
|
919
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].name #=> String
|
920
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].resource_requirements #=> Array
|
921
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
|
922
|
+
# resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].resource_requirements[0].value #=> String
|
923
|
+
# resp.target_parameters.ecs_task_parameters.overrides.cpu #=> String
|
924
|
+
# resp.target_parameters.ecs_task_parameters.overrides.ephemeral_storage.size_in_gi_b #=> Integer
|
925
|
+
# resp.target_parameters.ecs_task_parameters.overrides.execution_role_arn #=> String
|
926
|
+
# resp.target_parameters.ecs_task_parameters.overrides.inference_accelerator_overrides #=> Array
|
927
|
+
# resp.target_parameters.ecs_task_parameters.overrides.inference_accelerator_overrides[0].device_name #=> String
|
928
|
+
# resp.target_parameters.ecs_task_parameters.overrides.inference_accelerator_overrides[0].device_type #=> String
|
929
|
+
# resp.target_parameters.ecs_task_parameters.overrides.memory #=> String
|
930
|
+
# resp.target_parameters.ecs_task_parameters.overrides.task_role_arn #=> String
|
931
|
+
# resp.target_parameters.ecs_task_parameters.placement_constraints #=> Array
|
932
|
+
# resp.target_parameters.ecs_task_parameters.placement_constraints[0].expression #=> String
|
933
|
+
# resp.target_parameters.ecs_task_parameters.placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
|
934
|
+
# resp.target_parameters.ecs_task_parameters.placement_strategy #=> Array
|
935
|
+
# resp.target_parameters.ecs_task_parameters.placement_strategy[0].field #=> String
|
936
|
+
# resp.target_parameters.ecs_task_parameters.placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
|
937
|
+
# resp.target_parameters.ecs_task_parameters.platform_version #=> String
|
938
|
+
# resp.target_parameters.ecs_task_parameters.propagate_tags #=> String, one of "TASK_DEFINITION"
|
939
|
+
# resp.target_parameters.ecs_task_parameters.reference_id #=> String
|
940
|
+
# resp.target_parameters.ecs_task_parameters.tags #=> Array
|
941
|
+
# resp.target_parameters.ecs_task_parameters.tags[0].key #=> String
|
942
|
+
# resp.target_parameters.ecs_task_parameters.tags[0].value #=> String
|
943
|
+
# resp.target_parameters.ecs_task_parameters.task_count #=> Integer
|
944
|
+
# resp.target_parameters.ecs_task_parameters.task_definition_arn #=> String
|
945
|
+
# resp.target_parameters.event_bridge_event_bus_parameters.detail_type #=> String
|
946
|
+
# resp.target_parameters.event_bridge_event_bus_parameters.endpoint_id #=> String
|
947
|
+
# resp.target_parameters.event_bridge_event_bus_parameters.resources #=> Array
|
948
|
+
# resp.target_parameters.event_bridge_event_bus_parameters.resources[0] #=> String
|
949
|
+
# resp.target_parameters.event_bridge_event_bus_parameters.source #=> String
|
950
|
+
# resp.target_parameters.event_bridge_event_bus_parameters.time #=> String
|
951
|
+
# resp.target_parameters.http_parameters.header_parameters #=> Hash
|
952
|
+
# resp.target_parameters.http_parameters.header_parameters["HeaderKey"] #=> String
|
953
|
+
# resp.target_parameters.http_parameters.path_parameter_values #=> Array
|
954
|
+
# resp.target_parameters.http_parameters.path_parameter_values[0] #=> String
|
955
|
+
# resp.target_parameters.http_parameters.query_string_parameters #=> Hash
|
956
|
+
# resp.target_parameters.http_parameters.query_string_parameters["QueryStringKey"] #=> String
|
957
|
+
# resp.target_parameters.input_template #=> String
|
958
|
+
# resp.target_parameters.kinesis_stream_parameters.partition_key #=> String
|
959
|
+
# resp.target_parameters.lambda_function_parameters.invocation_type #=> String, one of "REQUEST_RESPONSE", "FIRE_AND_FORGET"
|
960
|
+
# resp.target_parameters.redshift_data_parameters.database #=> String
|
961
|
+
# resp.target_parameters.redshift_data_parameters.db_user #=> String
|
962
|
+
# resp.target_parameters.redshift_data_parameters.secret_manager_arn #=> String
|
963
|
+
# resp.target_parameters.redshift_data_parameters.sqls #=> Array
|
964
|
+
# resp.target_parameters.redshift_data_parameters.sqls[0] #=> String
|
965
|
+
# resp.target_parameters.redshift_data_parameters.statement_name #=> String
|
966
|
+
# resp.target_parameters.redshift_data_parameters.with_event #=> Boolean
|
967
|
+
# resp.target_parameters.sage_maker_pipeline_parameters.pipeline_parameter_list #=> Array
|
968
|
+
# resp.target_parameters.sage_maker_pipeline_parameters.pipeline_parameter_list[0].name #=> String
|
969
|
+
# resp.target_parameters.sage_maker_pipeline_parameters.pipeline_parameter_list[0].value #=> String
|
970
|
+
# resp.target_parameters.sqs_queue_parameters.message_deduplication_id #=> String
|
971
|
+
# resp.target_parameters.sqs_queue_parameters.message_group_id #=> String
|
972
|
+
# resp.target_parameters.step_function_state_machine_parameters.invocation_type #=> String, one of "REQUEST_RESPONSE", "FIRE_AND_FORGET"
|
973
|
+
#
|
974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/DescribePipe AWS API Documentation
|
975
|
+
#
|
976
|
+
# @overload describe_pipe(params = {})
|
977
|
+
# @param [Hash] params ({})
|
978
|
+
def describe_pipe(params = {}, options = {})
|
979
|
+
req = build_request(:describe_pipe, params)
|
980
|
+
req.send_request(options)
|
981
|
+
end
|
982
|
+
|
983
|
+
# Get the pipes associated with this account. For more information about
|
984
|
+
# pipes, see [Amazon EventBridge Pipes][1] in the Amazon EventBridge
|
985
|
+
# User Guide.
|
986
|
+
#
|
987
|
+
#
|
988
|
+
#
|
989
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html
|
990
|
+
#
|
991
|
+
# @option params [String] :current_state
|
992
|
+
# The state the pipe is in.
|
993
|
+
#
|
994
|
+
# @option params [String] :desired_state
|
995
|
+
# The state the pipe should be in.
|
996
|
+
#
|
997
|
+
# @option params [Integer] :limit
|
998
|
+
# The maximum number of pipes to include in the response.
|
999
|
+
#
|
1000
|
+
# @option params [String] :name_prefix
|
1001
|
+
# A value that will return a subset of the pipes associated with this
|
1002
|
+
# account. For example, `"NamePrefix": "ABC"` will return all endpoints
|
1003
|
+
# with "ABC" in the name.
|
1004
|
+
#
|
1005
|
+
# @option params [String] :next_token
|
1006
|
+
# If `nextToken` is returned, there are more results available. The
|
1007
|
+
# value of `nextToken` is a unique pagination token for each page. Make
|
1008
|
+
# the call again using the returned token to retrieve the next page.
|
1009
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1010
|
+
# after 24 hours. Using an expired pagination token will return an HTTP
|
1011
|
+
# 400 InvalidToken error.
|
1012
|
+
#
|
1013
|
+
# @option params [String] :source_prefix
|
1014
|
+
# The prefix matching the pipe source.
|
1015
|
+
#
|
1016
|
+
# @option params [String] :target_prefix
|
1017
|
+
# The prefix matching the pipe target.
|
1018
|
+
#
|
1019
|
+
# @return [Types::ListPipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1020
|
+
#
|
1021
|
+
# * {Types::ListPipesResponse#next_token #next_token} => String
|
1022
|
+
# * {Types::ListPipesResponse#pipes #pipes} => Array<Types::Pipe>
|
1023
|
+
#
|
1024
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1025
|
+
#
|
1026
|
+
# @example Request syntax with placeholder values
|
1027
|
+
#
|
1028
|
+
# resp = client.list_pipes({
|
1029
|
+
# current_state: "RUNNING", # accepts RUNNING, STOPPED, CREATING, UPDATING, DELETING, STARTING, STOPPING, CREATE_FAILED, UPDATE_FAILED, START_FAILED, STOP_FAILED
|
1030
|
+
# desired_state: "RUNNING", # accepts RUNNING, STOPPED
|
1031
|
+
# limit: 1,
|
1032
|
+
# name_prefix: "PipeName",
|
1033
|
+
# next_token: "NextToken",
|
1034
|
+
# source_prefix: "ResourceArn",
|
1035
|
+
# target_prefix: "ResourceArn",
|
1036
|
+
# })
|
1037
|
+
#
|
1038
|
+
# @example Response structure
|
1039
|
+
#
|
1040
|
+
# resp.next_token #=> String
|
1041
|
+
# resp.pipes #=> Array
|
1042
|
+
# resp.pipes[0].arn #=> String
|
1043
|
+
# resp.pipes[0].creation_time #=> Time
|
1044
|
+
# resp.pipes[0].current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED"
|
1045
|
+
# resp.pipes[0].desired_state #=> String, one of "RUNNING", "STOPPED"
|
1046
|
+
# resp.pipes[0].enrichment #=> String
|
1047
|
+
# resp.pipes[0].last_modified_time #=> Time
|
1048
|
+
# resp.pipes[0].name #=> String
|
1049
|
+
# resp.pipes[0].source #=> String
|
1050
|
+
# resp.pipes[0].state_reason #=> String
|
1051
|
+
# resp.pipes[0].target #=> String
|
1052
|
+
#
|
1053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ListPipes AWS API Documentation
|
1054
|
+
#
|
1055
|
+
# @overload list_pipes(params = {})
|
1056
|
+
# @param [Hash] params ({})
|
1057
|
+
def list_pipes(params = {}, options = {})
|
1058
|
+
req = build_request(:list_pipes, params)
|
1059
|
+
req.send_request(options)
|
1060
|
+
end
|
1061
|
+
|
1062
|
+
# Displays the tags associated with a pipe.
|
1063
|
+
#
|
1064
|
+
# @option params [required, String] :resource_arn
|
1065
|
+
# The ARN of the pipe for which you want to view tags.
|
1066
|
+
#
|
1067
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1068
|
+
#
|
1069
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
1070
|
+
#
|
1071
|
+
# @example Request syntax with placeholder values
|
1072
|
+
#
|
1073
|
+
# resp = client.list_tags_for_resource({
|
1074
|
+
# resource_arn: "PipeArn", # required
|
1075
|
+
# })
|
1076
|
+
#
|
1077
|
+
# @example Response structure
|
1078
|
+
#
|
1079
|
+
# resp.tags #=> Hash
|
1080
|
+
# resp.tags["TagKey"] #=> String
|
1081
|
+
#
|
1082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ListTagsForResource AWS API Documentation
|
1083
|
+
#
|
1084
|
+
# @overload list_tags_for_resource(params = {})
|
1085
|
+
# @param [Hash] params ({})
|
1086
|
+
def list_tags_for_resource(params = {}, options = {})
|
1087
|
+
req = build_request(:list_tags_for_resource, params)
|
1088
|
+
req.send_request(options)
|
1089
|
+
end
|
1090
|
+
|
1091
|
+
# Start an existing pipe.
|
1092
|
+
#
|
1093
|
+
# @option params [required, String] :name
|
1094
|
+
# The name of the pipe.
|
1095
|
+
#
|
1096
|
+
# @return [Types::StartPipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1097
|
+
#
|
1098
|
+
# * {Types::StartPipeResponse#arn #arn} => String
|
1099
|
+
# * {Types::StartPipeResponse#creation_time #creation_time} => Time
|
1100
|
+
# * {Types::StartPipeResponse#current_state #current_state} => String
|
1101
|
+
# * {Types::StartPipeResponse#desired_state #desired_state} => String
|
1102
|
+
# * {Types::StartPipeResponse#last_modified_time #last_modified_time} => Time
|
1103
|
+
# * {Types::StartPipeResponse#name #name} => String
|
1104
|
+
#
|
1105
|
+
# @example Request syntax with placeholder values
|
1106
|
+
#
|
1107
|
+
# resp = client.start_pipe({
|
1108
|
+
# name: "PipeName", # required
|
1109
|
+
# })
|
1110
|
+
#
|
1111
|
+
# @example Response structure
|
1112
|
+
#
|
1113
|
+
# resp.arn #=> String
|
1114
|
+
# resp.creation_time #=> Time
|
1115
|
+
# resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED"
|
1116
|
+
# resp.desired_state #=> String, one of "RUNNING", "STOPPED"
|
1117
|
+
# resp.last_modified_time #=> Time
|
1118
|
+
# resp.name #=> String
|
1119
|
+
#
|
1120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/StartPipe AWS API Documentation
|
1121
|
+
#
|
1122
|
+
# @overload start_pipe(params = {})
|
1123
|
+
# @param [Hash] params ({})
|
1124
|
+
def start_pipe(params = {}, options = {})
|
1125
|
+
req = build_request(:start_pipe, params)
|
1126
|
+
req.send_request(options)
|
1127
|
+
end
|
1128
|
+
|
1129
|
+
# Stop an existing pipe.
|
1130
|
+
#
|
1131
|
+
# @option params [required, String] :name
|
1132
|
+
# The name of the pipe.
|
1133
|
+
#
|
1134
|
+
# @return [Types::StopPipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1135
|
+
#
|
1136
|
+
# * {Types::StopPipeResponse#arn #arn} => String
|
1137
|
+
# * {Types::StopPipeResponse#creation_time #creation_time} => Time
|
1138
|
+
# * {Types::StopPipeResponse#current_state #current_state} => String
|
1139
|
+
# * {Types::StopPipeResponse#desired_state #desired_state} => String
|
1140
|
+
# * {Types::StopPipeResponse#last_modified_time #last_modified_time} => Time
|
1141
|
+
# * {Types::StopPipeResponse#name #name} => String
|
1142
|
+
#
|
1143
|
+
# @example Request syntax with placeholder values
|
1144
|
+
#
|
1145
|
+
# resp = client.stop_pipe({
|
1146
|
+
# name: "PipeName", # required
|
1147
|
+
# })
|
1148
|
+
#
|
1149
|
+
# @example Response structure
|
1150
|
+
#
|
1151
|
+
# resp.arn #=> String
|
1152
|
+
# resp.creation_time #=> Time
|
1153
|
+
# resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED"
|
1154
|
+
# resp.desired_state #=> String, one of "RUNNING", "STOPPED"
|
1155
|
+
# resp.last_modified_time #=> Time
|
1156
|
+
# resp.name #=> String
|
1157
|
+
#
|
1158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/StopPipe AWS API Documentation
|
1159
|
+
#
|
1160
|
+
# @overload stop_pipe(params = {})
|
1161
|
+
# @param [Hash] params ({})
|
1162
|
+
def stop_pipe(params = {}, options = {})
|
1163
|
+
req = build_request(:stop_pipe, params)
|
1164
|
+
req.send_request(options)
|
1165
|
+
end
|
1166
|
+
|
1167
|
+
# Assigns one or more tags (key-value pairs) to the specified pipe. Tags
|
1168
|
+
# can help you organize and categorize your resources. You can also use
|
1169
|
+
# them to scope user permissions by granting a user permission to access
|
1170
|
+
# or change only resources with certain tag values.
|
1171
|
+
#
|
1172
|
+
# Tags don't have any semantic meaning to Amazon Web Services and are
|
1173
|
+
# interpreted strictly as strings of characters.
|
1174
|
+
#
|
1175
|
+
# You can use the `TagResource` action with a pipe that already has
|
1176
|
+
# tags. If you specify a new tag key, this tag is appended to the list
|
1177
|
+
# of tags associated with the pipe. If you specify a tag key that is
|
1178
|
+
# already associated with the pipe, the new tag value that you specify
|
1179
|
+
# replaces the previous value for that tag.
|
1180
|
+
#
|
1181
|
+
# You can associate as many as 50 tags with a pipe.
|
1182
|
+
#
|
1183
|
+
# @option params [required, String] :resource_arn
|
1184
|
+
# The ARN of the pipe.
|
1185
|
+
#
|
1186
|
+
# @option params [required, Hash<String,String>] :tags
|
1187
|
+
# The list of key-value pairs associated with the pipe.
|
1188
|
+
#
|
1189
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1190
|
+
#
|
1191
|
+
# @example Request syntax with placeholder values
|
1192
|
+
#
|
1193
|
+
# resp = client.tag_resource({
|
1194
|
+
# resource_arn: "PipeArn", # required
|
1195
|
+
# tags: { # required
|
1196
|
+
# "TagKey" => "TagValue",
|
1197
|
+
# },
|
1198
|
+
# })
|
1199
|
+
#
|
1200
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/TagResource AWS API Documentation
|
1201
|
+
#
|
1202
|
+
# @overload tag_resource(params = {})
|
1203
|
+
# @param [Hash] params ({})
|
1204
|
+
def tag_resource(params = {}, options = {})
|
1205
|
+
req = build_request(:tag_resource, params)
|
1206
|
+
req.send_request(options)
|
1207
|
+
end
|
1208
|
+
|
1209
|
+
# Removes one or more tags from the specified pipes.
|
1210
|
+
#
|
1211
|
+
# @option params [required, String] :resource_arn
|
1212
|
+
# The ARN of the pipe.
|
1213
|
+
#
|
1214
|
+
# @option params [required, Array<String>] :tag_keys
|
1215
|
+
# The list of tag keys to remove from the pipe.
|
1216
|
+
#
|
1217
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1218
|
+
#
|
1219
|
+
# @example Request syntax with placeholder values
|
1220
|
+
#
|
1221
|
+
# resp = client.untag_resource({
|
1222
|
+
# resource_arn: "PipeArn", # required
|
1223
|
+
# tag_keys: ["TagKey"], # required
|
1224
|
+
# })
|
1225
|
+
#
|
1226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UntagResource AWS API Documentation
|
1227
|
+
#
|
1228
|
+
# @overload untag_resource(params = {})
|
1229
|
+
# @param [Hash] params ({})
|
1230
|
+
def untag_resource(params = {}, options = {})
|
1231
|
+
req = build_request(:untag_resource, params)
|
1232
|
+
req.send_request(options)
|
1233
|
+
end
|
1234
|
+
|
1235
|
+
# Update an existing pipe. When you call `UpdatePipe`, only the fields
|
1236
|
+
# that are included in the request are changed, the rest are unchanged.
|
1237
|
+
# The exception to this is if you modify any Amazon Web Services-service
|
1238
|
+
# specific fields in the `SourceParameters`, `EnrichmentParameters`, or
|
1239
|
+
# `TargetParameters` objects. The fields in these objects are updated
|
1240
|
+
# atomically as one and override existing values. This is by design and
|
1241
|
+
# means that if you don't specify an optional field in one of these
|
1242
|
+
# Parameters objects, that field will be set to its system-default value
|
1243
|
+
# after the update.
|
1244
|
+
#
|
1245
|
+
# <p>For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html"> Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
|
1246
|
+
#
|
1247
|
+
# @option params [String] :description
|
1248
|
+
# A description of the pipe.
|
1249
|
+
#
|
1250
|
+
# @option params [String] :desired_state
|
1251
|
+
# The state the pipe should be in.
|
1252
|
+
#
|
1253
|
+
# @option params [String] :enrichment
|
1254
|
+
# The ARN of the enrichment resource.
|
1255
|
+
#
|
1256
|
+
# @option params [Types::PipeEnrichmentParameters] :enrichment_parameters
|
1257
|
+
# The parameters required to set up enrichment on your pipe.
|
1258
|
+
#
|
1259
|
+
# @option params [required, String] :name
|
1260
|
+
# The name of the pipe.
|
1261
|
+
#
|
1262
|
+
# @option params [required, String] :role_arn
|
1263
|
+
# The ARN of the role that allows the pipe to send data to the target.
|
1264
|
+
#
|
1265
|
+
# @option params [Types::UpdatePipeSourceParameters] :source_parameters
|
1266
|
+
# The parameters required to set up a source for your pipe.
|
1267
|
+
#
|
1268
|
+
# @option params [String] :target
|
1269
|
+
# The ARN of the target resource.
|
1270
|
+
#
|
1271
|
+
# @option params [Types::PipeTargetParameters] :target_parameters
|
1272
|
+
# The parameters required to set up a target for your pipe.
|
1273
|
+
#
|
1274
|
+
# @return [Types::UpdatePipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1275
|
+
#
|
1276
|
+
# * {Types::UpdatePipeResponse#arn #arn} => String
|
1277
|
+
# * {Types::UpdatePipeResponse#creation_time #creation_time} => Time
|
1278
|
+
# * {Types::UpdatePipeResponse#current_state #current_state} => String
|
1279
|
+
# * {Types::UpdatePipeResponse#desired_state #desired_state} => String
|
1280
|
+
# * {Types::UpdatePipeResponse#last_modified_time #last_modified_time} => Time
|
1281
|
+
# * {Types::UpdatePipeResponse#name #name} => String
|
1282
|
+
#
|
1283
|
+
# @example Request syntax with placeholder values
|
1284
|
+
#
|
1285
|
+
# resp = client.update_pipe({
|
1286
|
+
# description: "PipeDescription",
|
1287
|
+
# desired_state: "RUNNING", # accepts RUNNING, STOPPED
|
1288
|
+
# enrichment: "OptionalArn",
|
1289
|
+
# enrichment_parameters: {
|
1290
|
+
# http_parameters: {
|
1291
|
+
# header_parameters: {
|
1292
|
+
# "HeaderKey" => "HeaderValue",
|
1293
|
+
# },
|
1294
|
+
# path_parameter_values: ["PathParameter"],
|
1295
|
+
# query_string_parameters: {
|
1296
|
+
# "QueryStringKey" => "QueryStringValue",
|
1297
|
+
# },
|
1298
|
+
# },
|
1299
|
+
# input_template: "InputTemplate",
|
1300
|
+
# },
|
1301
|
+
# name: "PipeName", # required
|
1302
|
+
# role_arn: "RoleArn", # required
|
1303
|
+
# source_parameters: {
|
1304
|
+
# active_mq_broker_parameters: {
|
1305
|
+
# batch_size: 1,
|
1306
|
+
# credentials: { # required
|
1307
|
+
# basic_auth: "SecretManagerArn",
|
1308
|
+
# },
|
1309
|
+
# maximum_batching_window_in_seconds: 1,
|
1310
|
+
# },
|
1311
|
+
# dynamo_db_stream_parameters: {
|
1312
|
+
# batch_size: 1,
|
1313
|
+
# dead_letter_config: {
|
1314
|
+
# arn: "Arn",
|
1315
|
+
# },
|
1316
|
+
# maximum_batching_window_in_seconds: 1,
|
1317
|
+
# maximum_record_age_in_seconds: 1,
|
1318
|
+
# maximum_retry_attempts: 1,
|
1319
|
+
# on_partial_batch_item_failure: "AUTOMATIC_BISECT", # accepts AUTOMATIC_BISECT
|
1320
|
+
# parallelization_factor: 1,
|
1321
|
+
# },
|
1322
|
+
# filter_criteria: {
|
1323
|
+
# filters: [
|
1324
|
+
# {
|
1325
|
+
# pattern: "EventPattern",
|
1326
|
+
# },
|
1327
|
+
# ],
|
1328
|
+
# },
|
1329
|
+
# kinesis_stream_parameters: {
|
1330
|
+
# batch_size: 1,
|
1331
|
+
# dead_letter_config: {
|
1332
|
+
# arn: "Arn",
|
1333
|
+
# },
|
1334
|
+
# maximum_batching_window_in_seconds: 1,
|
1335
|
+
# maximum_record_age_in_seconds: 1,
|
1336
|
+
# maximum_retry_attempts: 1,
|
1337
|
+
# on_partial_batch_item_failure: "AUTOMATIC_BISECT", # accepts AUTOMATIC_BISECT
|
1338
|
+
# parallelization_factor: 1,
|
1339
|
+
# },
|
1340
|
+
# managed_streaming_kafka_parameters: {
|
1341
|
+
# batch_size: 1,
|
1342
|
+
# credentials: {
|
1343
|
+
# client_certificate_tls_auth: "SecretManagerArn",
|
1344
|
+
# sasl_scram_512_auth: "SecretManagerArn",
|
1345
|
+
# },
|
1346
|
+
# maximum_batching_window_in_seconds: 1,
|
1347
|
+
# },
|
1348
|
+
# rabbit_mq_broker_parameters: {
|
1349
|
+
# batch_size: 1,
|
1350
|
+
# credentials: { # required
|
1351
|
+
# basic_auth: "SecretManagerArn",
|
1352
|
+
# },
|
1353
|
+
# maximum_batching_window_in_seconds: 1,
|
1354
|
+
# },
|
1355
|
+
# self_managed_kafka_parameters: {
|
1356
|
+
# batch_size: 1,
|
1357
|
+
# credentials: {
|
1358
|
+
# basic_auth: "SecretManagerArn",
|
1359
|
+
# client_certificate_tls_auth: "SecretManagerArn",
|
1360
|
+
# sasl_scram_256_auth: "SecretManagerArn",
|
1361
|
+
# sasl_scram_512_auth: "SecretManagerArn",
|
1362
|
+
# },
|
1363
|
+
# maximum_batching_window_in_seconds: 1,
|
1364
|
+
# server_root_ca_certificate: "SecretManagerArn",
|
1365
|
+
# vpc: {
|
1366
|
+
# security_group: ["SecurityGroupId"],
|
1367
|
+
# subnets: ["SubnetId"],
|
1368
|
+
# },
|
1369
|
+
# },
|
1370
|
+
# sqs_queue_parameters: {
|
1371
|
+
# batch_size: 1,
|
1372
|
+
# maximum_batching_window_in_seconds: 1,
|
1373
|
+
# },
|
1374
|
+
# },
|
1375
|
+
# target: "Arn",
|
1376
|
+
# target_parameters: {
|
1377
|
+
# batch_job_parameters: {
|
1378
|
+
# array_properties: {
|
1379
|
+
# size: 1,
|
1380
|
+
# },
|
1381
|
+
# container_overrides: {
|
1382
|
+
# command: ["String"],
|
1383
|
+
# environment: [
|
1384
|
+
# {
|
1385
|
+
# name: "String",
|
1386
|
+
# value: "String",
|
1387
|
+
# },
|
1388
|
+
# ],
|
1389
|
+
# instance_type: "String",
|
1390
|
+
# resource_requirements: [
|
1391
|
+
# {
|
1392
|
+
# type: "GPU", # required, accepts GPU, MEMORY, VCPU
|
1393
|
+
# value: "String", # required
|
1394
|
+
# },
|
1395
|
+
# ],
|
1396
|
+
# },
|
1397
|
+
# depends_on: [
|
1398
|
+
# {
|
1399
|
+
# job_id: "String",
|
1400
|
+
# type: "N_TO_N", # accepts N_TO_N, SEQUENTIAL
|
1401
|
+
# },
|
1402
|
+
# ],
|
1403
|
+
# job_definition: "String", # required
|
1404
|
+
# job_name: "String", # required
|
1405
|
+
# parameters: {
|
1406
|
+
# "String" => "String",
|
1407
|
+
# },
|
1408
|
+
# retry_strategy: {
|
1409
|
+
# attempts: 1,
|
1410
|
+
# },
|
1411
|
+
# },
|
1412
|
+
# cloud_watch_logs_parameters: {
|
1413
|
+
# log_stream_name: "LogStreamName",
|
1414
|
+
# timestamp: "JsonPath",
|
1415
|
+
# },
|
1416
|
+
# ecs_task_parameters: {
|
1417
|
+
# capacity_provider_strategy: [
|
1418
|
+
# {
|
1419
|
+
# base: 1,
|
1420
|
+
# capacity_provider: "CapacityProvider", # required
|
1421
|
+
# weight: 1,
|
1422
|
+
# },
|
1423
|
+
# ],
|
1424
|
+
# enable_ecs_managed_tags: false,
|
1425
|
+
# enable_execute_command: false,
|
1426
|
+
# group: "String",
|
1427
|
+
# launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
|
1428
|
+
# network_configuration: {
|
1429
|
+
# awsvpc_configuration: {
|
1430
|
+
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
1431
|
+
# security_groups: ["SecurityGroup"],
|
1432
|
+
# subnets: ["Subnet"], # required
|
1433
|
+
# },
|
1434
|
+
# },
|
1435
|
+
# overrides: {
|
1436
|
+
# container_overrides: [
|
1437
|
+
# {
|
1438
|
+
# command: ["String"],
|
1439
|
+
# cpu: 1,
|
1440
|
+
# environment: [
|
1441
|
+
# {
|
1442
|
+
# name: "String",
|
1443
|
+
# value: "String",
|
1444
|
+
# },
|
1445
|
+
# ],
|
1446
|
+
# environment_files: [
|
1447
|
+
# {
|
1448
|
+
# type: "s3", # required, accepts s3
|
1449
|
+
# value: "String", # required
|
1450
|
+
# },
|
1451
|
+
# ],
|
1452
|
+
# memory: 1,
|
1453
|
+
# memory_reservation: 1,
|
1454
|
+
# name: "String",
|
1455
|
+
# resource_requirements: [
|
1456
|
+
# {
|
1457
|
+
# type: "GPU", # required, accepts GPU, InferenceAccelerator
|
1458
|
+
# value: "String", # required
|
1459
|
+
# },
|
1460
|
+
# ],
|
1461
|
+
# },
|
1462
|
+
# ],
|
1463
|
+
# cpu: "String",
|
1464
|
+
# ephemeral_storage: {
|
1465
|
+
# size_in_gi_b: 1, # required
|
1466
|
+
# },
|
1467
|
+
# execution_role_arn: "ArnOrJsonPath",
|
1468
|
+
# inference_accelerator_overrides: [
|
1469
|
+
# {
|
1470
|
+
# device_name: "String",
|
1471
|
+
# device_type: "String",
|
1472
|
+
# },
|
1473
|
+
# ],
|
1474
|
+
# memory: "String",
|
1475
|
+
# task_role_arn: "ArnOrJsonPath",
|
1476
|
+
# },
|
1477
|
+
# placement_constraints: [
|
1478
|
+
# {
|
1479
|
+
# expression: "PlacementConstraintExpression",
|
1480
|
+
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
1481
|
+
# },
|
1482
|
+
# ],
|
1483
|
+
# placement_strategy: [
|
1484
|
+
# {
|
1485
|
+
# field: "PlacementStrategyField",
|
1486
|
+
# type: "random", # accepts random, spread, binpack
|
1487
|
+
# },
|
1488
|
+
# ],
|
1489
|
+
# platform_version: "String",
|
1490
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
|
1491
|
+
# reference_id: "ReferenceId",
|
1492
|
+
# tags: [
|
1493
|
+
# {
|
1494
|
+
# key: "TagKey", # required
|
1495
|
+
# value: "TagValue", # required
|
1496
|
+
# },
|
1497
|
+
# ],
|
1498
|
+
# task_count: 1,
|
1499
|
+
# task_definition_arn: "ArnOrJsonPath", # required
|
1500
|
+
# },
|
1501
|
+
# event_bridge_event_bus_parameters: {
|
1502
|
+
# detail_type: "EventBridgeDetailType",
|
1503
|
+
# endpoint_id: "EventBridgeEndpointId",
|
1504
|
+
# resources: ["ArnOrJsonPath"],
|
1505
|
+
# source: "EventBridgeEventSource",
|
1506
|
+
# time: "JsonPath",
|
1507
|
+
# },
|
1508
|
+
# http_parameters: {
|
1509
|
+
# header_parameters: {
|
1510
|
+
# "HeaderKey" => "HeaderValue",
|
1511
|
+
# },
|
1512
|
+
# path_parameter_values: ["PathParameter"],
|
1513
|
+
# query_string_parameters: {
|
1514
|
+
# "QueryStringKey" => "QueryStringValue",
|
1515
|
+
# },
|
1516
|
+
# },
|
1517
|
+
# input_template: "InputTemplate",
|
1518
|
+
# kinesis_stream_parameters: {
|
1519
|
+
# partition_key: "KinesisPartitionKey", # required
|
1520
|
+
# },
|
1521
|
+
# lambda_function_parameters: {
|
1522
|
+
# invocation_type: "REQUEST_RESPONSE", # accepts REQUEST_RESPONSE, FIRE_AND_FORGET
|
1523
|
+
# },
|
1524
|
+
# redshift_data_parameters: {
|
1525
|
+
# database: "Database", # required
|
1526
|
+
# db_user: "DbUser",
|
1527
|
+
# secret_manager_arn: "SecretManagerArnOrJsonPath",
|
1528
|
+
# sqls: ["Sql"], # required
|
1529
|
+
# statement_name: "StatementName",
|
1530
|
+
# with_event: false,
|
1531
|
+
# },
|
1532
|
+
# sage_maker_pipeline_parameters: {
|
1533
|
+
# pipeline_parameter_list: [
|
1534
|
+
# {
|
1535
|
+
# name: "SageMakerPipelineParameterName", # required
|
1536
|
+
# value: "SageMakerPipelineParameterValue", # required
|
1537
|
+
# },
|
1538
|
+
# ],
|
1539
|
+
# },
|
1540
|
+
# sqs_queue_parameters: {
|
1541
|
+
# message_deduplication_id: "MessageDeduplicationId",
|
1542
|
+
# message_group_id: "MessageGroupId",
|
1543
|
+
# },
|
1544
|
+
# step_function_state_machine_parameters: {
|
1545
|
+
# invocation_type: "REQUEST_RESPONSE", # accepts REQUEST_RESPONSE, FIRE_AND_FORGET
|
1546
|
+
# },
|
1547
|
+
# },
|
1548
|
+
# })
|
1549
|
+
#
|
1550
|
+
# @example Response structure
|
1551
|
+
#
|
1552
|
+
# resp.arn #=> String
|
1553
|
+
# resp.creation_time #=> Time
|
1554
|
+
# resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED"
|
1555
|
+
# resp.desired_state #=> String, one of "RUNNING", "STOPPED"
|
1556
|
+
# resp.last_modified_time #=> Time
|
1557
|
+
# resp.name #=> String
|
1558
|
+
#
|
1559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipe AWS API Documentation
|
1560
|
+
#
|
1561
|
+
# @overload update_pipe(params = {})
|
1562
|
+
# @param [Hash] params ({})
|
1563
|
+
def update_pipe(params = {}, options = {})
|
1564
|
+
req = build_request(:update_pipe, params)
|
1565
|
+
req.send_request(options)
|
1566
|
+
end
|
1567
|
+
|
1568
|
+
# @!endgroup
|
1569
|
+
|
1570
|
+
# @param params ({})
|
1571
|
+
# @api private
|
1572
|
+
def build_request(operation_name, params = {})
|
1573
|
+
handlers = @handlers.for(operation_name)
|
1574
|
+
context = Seahorse::Client::RequestContext.new(
|
1575
|
+
operation_name: operation_name,
|
1576
|
+
operation: config.api.operation(operation_name),
|
1577
|
+
client: self,
|
1578
|
+
params: params,
|
1579
|
+
config: config)
|
1580
|
+
context[:gem_name] = 'aws-sdk-pipes'
|
1581
|
+
context[:gem_version] = '1.0.0'
|
1582
|
+
Seahorse::Client::Request.new(handlers, context)
|
1583
|
+
end
|
1584
|
+
|
1585
|
+
# @api private
|
1586
|
+
# @deprecated
|
1587
|
+
def waiter_names
|
1588
|
+
[]
|
1589
|
+
end
|
1590
|
+
|
1591
|
+
class << self
|
1592
|
+
|
1593
|
+
# @api private
|
1594
|
+
attr_reader :identifier
|
1595
|
+
|
1596
|
+
# @api private
|
1597
|
+
def errors_module
|
1598
|
+
Errors
|
1599
|
+
end
|
1600
|
+
|
1601
|
+
end
|
1602
|
+
end
|
1603
|
+
end
|