aws-sdk-gluedatabrew 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/lib/aws-sdk-gluedatabrew.rb +53 -0
- data/lib/aws-sdk-gluedatabrew/client.rb +2352 -0
- data/lib/aws-sdk-gluedatabrew/client_api.rb +1244 -0
- data/lib/aws-sdk-gluedatabrew/customizations.rb +0 -0
- data/lib/aws-sdk-gluedatabrew/errors.rb +134 -0
- data/lib/aws-sdk-gluedatabrew/resource.rb +26 -0
- data/lib/aws-sdk-gluedatabrew/types.rb +3418 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: c2501dce32cda2e8c4af4cd9c1cf797123b82f79ce5df1b95789ebc222bc24f4
|
4
|
+
data.tar.gz: ccec97164fde234002004b51ae66585257c79fc3298666ac4dda54c0ff1fb90f
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 8c4c57215bb2967fb67932654e345fc76628dce79682de49e34d15345dbdb67dc684df8b4a3dc3ee939fcec40d88301167004b0691d54a29a9b4abdb8f47ddfa
|
7
|
+
data.tar.gz: 302b091442237e63ac0aeb3cc808ce1067625bb971c5fafe36a7c1b30eddd73ff9e48f9cb9442b9f75210a8c3e16586a81c4c5a8461912c0047d63c9cea60af8
|
@@ -0,0 +1,53 @@
|
|
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/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
|
11
|
+
require 'aws-sdk-core'
|
12
|
+
require 'aws-sigv4'
|
13
|
+
|
14
|
+
require_relative 'aws-sdk-gluedatabrew/types'
|
15
|
+
require_relative 'aws-sdk-gluedatabrew/client_api'
|
16
|
+
require_relative 'aws-sdk-gluedatabrew/client'
|
17
|
+
require_relative 'aws-sdk-gluedatabrew/errors'
|
18
|
+
require_relative 'aws-sdk-gluedatabrew/resource'
|
19
|
+
require_relative 'aws-sdk-gluedatabrew/customizations'
|
20
|
+
|
21
|
+
# This module provides support for AWS Glue DataBrew. This module is available in the
|
22
|
+
# `aws-sdk-gluedatabrew` gem.
|
23
|
+
#
|
24
|
+
# # Client
|
25
|
+
#
|
26
|
+
# The {Client} class provides one method for each API operation. Operation
|
27
|
+
# methods each accept a hash of request parameters and return a response
|
28
|
+
# structure.
|
29
|
+
#
|
30
|
+
# glue_data_brew = Aws::GlueDataBrew::Client.new
|
31
|
+
# resp = glue_data_brew.batch_delete_recipe_version(params)
|
32
|
+
#
|
33
|
+
# See {Client} for more information.
|
34
|
+
#
|
35
|
+
# # Errors
|
36
|
+
#
|
37
|
+
# Errors returned from AWS Glue DataBrew are defined in the
|
38
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
39
|
+
#
|
40
|
+
# begin
|
41
|
+
# # do stuff
|
42
|
+
# rescue Aws::GlueDataBrew::Errors::ServiceError
|
43
|
+
# # rescues all AWS Glue DataBrew API errors
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# See {Errors} for more information.
|
47
|
+
#
|
48
|
+
# @!group service
|
49
|
+
module Aws::GlueDataBrew
|
50
|
+
|
51
|
+
GEM_VERSION = '1.0.0'
|
52
|
+
|
53
|
+
end
|
@@ -0,0 +1,2352 @@
|
|
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/master/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/signature_v4.rb'
|
31
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
|
+
|
33
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:gluedatabrew)
|
34
|
+
|
35
|
+
module Aws::GlueDataBrew
|
36
|
+
# An API client for GlueDataBrew. To construct a client, you need to configure a `:region` and `:credentials`.
|
37
|
+
#
|
38
|
+
# client = Aws::GlueDataBrew::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
43
|
+
#
|
44
|
+
# For details on configuring region and credentials see
|
45
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
46
|
+
#
|
47
|
+
# See {#initialize} for a full list of supported configuration options.
|
48
|
+
class Client < Seahorse::Client::Base
|
49
|
+
|
50
|
+
include Aws::ClientStubs
|
51
|
+
|
52
|
+
@identifier = :gluedatabrew
|
53
|
+
|
54
|
+
set_api(ClientApi::API)
|
55
|
+
|
56
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
57
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
58
|
+
add_plugin(Aws::Plugins::Logging)
|
59
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
60
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
61
|
+
add_plugin(Aws::Plugins::UserAgent)
|
62
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
63
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
64
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
65
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
66
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
67
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
68
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
69
|
+
add_plugin(Aws::Plugins::StubResponses)
|
70
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
71
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
72
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
73
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
77
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
|
+
|
79
|
+
# @overload initialize(options)
|
80
|
+
# @param [Hash] options
|
81
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
82
|
+
# Your AWS credentials. This can be an instance of any one of the
|
83
|
+
# following classes:
|
84
|
+
#
|
85
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
|
+
# credentials.
|
87
|
+
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
102
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
103
|
+
# from an EC2 IMDS on an EC2 instance.
|
104
|
+
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
107
|
+
#
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
110
|
+
#
|
111
|
+
# When `:credentials` are not configured directly, the following
|
112
|
+
# locations will be searched for credentials:
|
113
|
+
#
|
114
|
+
# * `Aws.config[:credentials]`
|
115
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
116
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
117
|
+
# * `~/.aws/credentials`
|
118
|
+
# * `~/.aws/config`
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
123
|
+
#
|
124
|
+
# @option options [required, String] :region
|
125
|
+
# The AWS region to connect to. The configured `:region` is
|
126
|
+
# used to determine the service `:endpoint`. When not passed,
|
127
|
+
# a default `:region` is searched for in the following locations:
|
128
|
+
#
|
129
|
+
# * `Aws.config[:region]`
|
130
|
+
# * `ENV['AWS_REGION']`
|
131
|
+
# * `ENV['AMAZON_REGION']`
|
132
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
133
|
+
# * `~/.aws/credentials`
|
134
|
+
# * `~/.aws/config`
|
135
|
+
#
|
136
|
+
# @option options [String] :access_key_id
|
137
|
+
#
|
138
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
139
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
140
|
+
# the background every 60 secs (default). Defaults to `false`.
|
141
|
+
#
|
142
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
143
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
144
|
+
# until there is sufficent client side capacity to retry the request.
|
145
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
146
|
+
# not retry instead of sleeping.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
149
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
150
|
+
# this client.
|
151
|
+
#
|
152
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
153
|
+
# Allows you to provide an identifier for this client which will be attached to
|
154
|
+
# all generated client side metrics. Defaults to an empty string.
|
155
|
+
#
|
156
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
157
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
158
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
159
|
+
#
|
160
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
161
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
162
|
+
# agent is running on, where client metrics will be published via UDP.
|
163
|
+
#
|
164
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
165
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
166
|
+
# will use the Client Side Monitoring Agent Publisher.
|
167
|
+
#
|
168
|
+
# @option options [Boolean] :convert_params (true)
|
169
|
+
# When `true`, an attempt is made to coerce request parameters into
|
170
|
+
# the required types.
|
171
|
+
#
|
172
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
173
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
175
|
+
#
|
176
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
|
+
# Set to true to disable SDK automatically adding host prefix
|
178
|
+
# to default service endpoint when available.
|
179
|
+
#
|
180
|
+
# @option options [String] :endpoint
|
181
|
+
# The client endpoint is normally constructed from the `:region`
|
182
|
+
# option. You should only configure an `:endpoint` when connecting
|
183
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
184
|
+
#
|
185
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
186
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
187
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
188
|
+
#
|
189
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
190
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
191
|
+
#
|
192
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
193
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
194
|
+
# Use this option to config the time interval in seconds for making
|
195
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
196
|
+
#
|
197
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
198
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
199
|
+
#
|
200
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
201
|
+
# The log formatter.
|
202
|
+
#
|
203
|
+
# @option options [Symbol] :log_level (:info)
|
204
|
+
# The log level to send messages to the `:logger` at.
|
205
|
+
#
|
206
|
+
# @option options [Logger] :logger
|
207
|
+
# The Logger instance to send log messages to. If this option
|
208
|
+
# is not set, logging will be disabled.
|
209
|
+
#
|
210
|
+
# @option options [Integer] :max_attempts (3)
|
211
|
+
# An integer representing the maximum number attempts that will be made for
|
212
|
+
# a single request, including the initial attempt. For example,
|
213
|
+
# setting this value to 5 will result in a request being retried up to
|
214
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
215
|
+
#
|
216
|
+
# @option options [String] :profile ("default")
|
217
|
+
# Used when loading credentials from the shared credentials file
|
218
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
219
|
+
#
|
220
|
+
# @option options [Proc] :retry_backoff
|
221
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
222
|
+
# This option is only used in the `legacy` retry mode.
|
223
|
+
#
|
224
|
+
# @option options [Float] :retry_base_delay (0.3)
|
225
|
+
# The base delay in seconds used by the default backoff function. This option
|
226
|
+
# is only used in the `legacy` retry mode.
|
227
|
+
#
|
228
|
+
# @option options [Symbol] :retry_jitter (:none)
|
229
|
+
# A delay randomiser function used by the default backoff function.
|
230
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
231
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
232
|
+
# in the `legacy` retry mode.
|
233
|
+
#
|
234
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
235
|
+
#
|
236
|
+
# @option options [Integer] :retry_limit (3)
|
237
|
+
# The maximum number of times to retry failed requests. Only
|
238
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
239
|
+
# are retried. Generally, these are throttling errors, data
|
240
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
241
|
+
# endpoint discovery, and errors from expired credentials.
|
242
|
+
# This option is only used in the `legacy` retry mode.
|
243
|
+
#
|
244
|
+
# @option options [Integer] :retry_max_delay (0)
|
245
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
246
|
+
# used by the default backoff function. This option is only used in the
|
247
|
+
# `legacy` retry mode.
|
248
|
+
#
|
249
|
+
# @option options [String] :retry_mode ("legacy")
|
250
|
+
# Specifies which retry algorithm to use. Values are:
|
251
|
+
#
|
252
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
253
|
+
# no retry mode is provided.
|
254
|
+
#
|
255
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
256
|
+
# This includes support for retry quotas, which limit the number of
|
257
|
+
# unsuccessful retries a client can make.
|
258
|
+
#
|
259
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
260
|
+
# functionality of `standard` mode along with automatic client side
|
261
|
+
# throttling. This is a provisional mode that may change behavior
|
262
|
+
# in the future.
|
263
|
+
#
|
264
|
+
#
|
265
|
+
# @option options [String] :secret_access_key
|
266
|
+
#
|
267
|
+
# @option options [String] :session_token
|
268
|
+
#
|
269
|
+
# @option options [Boolean] :stub_responses (false)
|
270
|
+
# Causes the client to return stubbed responses. By default
|
271
|
+
# fake responses are generated and returned. You can specify
|
272
|
+
# the response data to return or errors to raise by calling
|
273
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
274
|
+
#
|
275
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
|
+
# requests are made, and retries are disabled.
|
277
|
+
#
|
278
|
+
# @option options [Boolean] :validate_params (true)
|
279
|
+
# When `true`, request parameters are validated before
|
280
|
+
# sending the request.
|
281
|
+
#
|
282
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
283
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
284
|
+
#
|
285
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
286
|
+
# seconds to wait when opening a HTTP session before raising a
|
287
|
+
# `Timeout::Error`.
|
288
|
+
#
|
289
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
290
|
+
# number of seconds to wait for response data. This value can
|
291
|
+
# safely be set per-request on the session.
|
292
|
+
#
|
293
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
294
|
+
# seconds a connection is allowed to sit idle before it is
|
295
|
+
# considered stale. Stale connections are closed and removed
|
296
|
+
# from the pool before making a request.
|
297
|
+
#
|
298
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
299
|
+
# seconds to wait for a 100-continue response before sending the
|
300
|
+
# request body. This option has no effect unless the request has
|
301
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
302
|
+
# disables this behaviour. This value can safely be set per
|
303
|
+
# request on the session.
|
304
|
+
#
|
305
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
306
|
+
# HTTP debug output will be sent to the `:logger`.
|
307
|
+
#
|
308
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
309
|
+
# SSL peer certificates are verified when establishing a
|
310
|
+
# connection.
|
311
|
+
#
|
312
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
313
|
+
# certificate authority bundle file that should be used when
|
314
|
+
# verifying peer certificates. If you do not pass
|
315
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
316
|
+
# will be used if available.
|
317
|
+
#
|
318
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
319
|
+
# directory that contains the unbundled SSL certificate
|
320
|
+
# authority files for verifying peer certificates. If you do
|
321
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
322
|
+
# system default will be used if available.
|
323
|
+
#
|
324
|
+
def initialize(*args)
|
325
|
+
super
|
326
|
+
end
|
327
|
+
|
328
|
+
# @!group API Operations
|
329
|
+
|
330
|
+
# Deletes one or more versions of a recipe at a time.
|
331
|
+
#
|
332
|
+
# @option params [required, String] :name
|
333
|
+
# The name of the recipe to be modified.
|
334
|
+
#
|
335
|
+
# @option params [required, Array<String>] :recipe_versions
|
336
|
+
# An array of version identifiers to be deleted.
|
337
|
+
#
|
338
|
+
# @return [Types::BatchDeleteRecipeVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
339
|
+
#
|
340
|
+
# * {Types::BatchDeleteRecipeVersionResponse#name #name} => String
|
341
|
+
# * {Types::BatchDeleteRecipeVersionResponse#errors #errors} => Array<Types::RecipeVersionErrorDetail>
|
342
|
+
#
|
343
|
+
# @example Request syntax with placeholder values
|
344
|
+
#
|
345
|
+
# resp = client.batch_delete_recipe_version({
|
346
|
+
# name: "RecipeName", # required
|
347
|
+
# recipe_versions: ["RecipeVersion"], # required
|
348
|
+
# })
|
349
|
+
#
|
350
|
+
# @example Response structure
|
351
|
+
#
|
352
|
+
# resp.name #=> String
|
353
|
+
# resp.errors #=> Array
|
354
|
+
# resp.errors[0].error_code #=> String
|
355
|
+
# resp.errors[0].error_message #=> String
|
356
|
+
# resp.errors[0].recipe_version #=> String
|
357
|
+
#
|
358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/BatchDeleteRecipeVersion AWS API Documentation
|
359
|
+
#
|
360
|
+
# @overload batch_delete_recipe_version(params = {})
|
361
|
+
# @param [Hash] params ({})
|
362
|
+
def batch_delete_recipe_version(params = {}, options = {})
|
363
|
+
req = build_request(:batch_delete_recipe_version, params)
|
364
|
+
req.send_request(options)
|
365
|
+
end
|
366
|
+
|
367
|
+
# Creates a new AWS Glue DataBrew dataset for this AWS account.
|
368
|
+
#
|
369
|
+
# @option params [required, String] :name
|
370
|
+
# The name of the dataset to be created.
|
371
|
+
#
|
372
|
+
# @option params [Types::FormatOptions] :format_options
|
373
|
+
# Options that define how Microsoft Excel input is to be interpreted by
|
374
|
+
# DataBrew.
|
375
|
+
#
|
376
|
+
# @option params [required, Types::Input] :input
|
377
|
+
# Information on how AWS Glue DataBrew can find data, in either the AWS
|
378
|
+
# Glue Data Catalog or Amazon S3.
|
379
|
+
#
|
380
|
+
# @option params [Hash<String,String>] :tags
|
381
|
+
# Metadata tags to apply to this dataset.
|
382
|
+
#
|
383
|
+
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
384
|
+
#
|
385
|
+
# * {Types::CreateDatasetResponse#name #name} => String
|
386
|
+
#
|
387
|
+
# @example Request syntax with placeholder values
|
388
|
+
#
|
389
|
+
# resp = client.create_dataset({
|
390
|
+
# name: "DatasetName", # required
|
391
|
+
# format_options: {
|
392
|
+
# json: {
|
393
|
+
# multi_line: false,
|
394
|
+
# },
|
395
|
+
# excel: {
|
396
|
+
# sheet_names: ["SheetName"],
|
397
|
+
# sheet_indexes: [1],
|
398
|
+
# },
|
399
|
+
# },
|
400
|
+
# input: { # required
|
401
|
+
# s3_input_definition: {
|
402
|
+
# bucket: "Bucket", # required
|
403
|
+
# key: "Key",
|
404
|
+
# },
|
405
|
+
# data_catalog_input_definition: {
|
406
|
+
# catalog_id: "CatalogId",
|
407
|
+
# database_name: "DatabaseName", # required
|
408
|
+
# table_name: "TableName", # required
|
409
|
+
# temp_directory: {
|
410
|
+
# bucket: "Bucket", # required
|
411
|
+
# key: "Key",
|
412
|
+
# },
|
413
|
+
# },
|
414
|
+
# },
|
415
|
+
# tags: {
|
416
|
+
# "TagKey" => "TagValue",
|
417
|
+
# },
|
418
|
+
# })
|
419
|
+
#
|
420
|
+
# @example Response structure
|
421
|
+
#
|
422
|
+
# resp.name #=> String
|
423
|
+
#
|
424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateDataset AWS API Documentation
|
425
|
+
#
|
426
|
+
# @overload create_dataset(params = {})
|
427
|
+
# @param [Hash] params ({})
|
428
|
+
def create_dataset(params = {}, options = {})
|
429
|
+
req = build_request(:create_dataset, params)
|
430
|
+
req.send_request(options)
|
431
|
+
end
|
432
|
+
|
433
|
+
# Creates a new job to profile an AWS Glue DataBrew dataset that exists
|
434
|
+
# in the current AWS account.
|
435
|
+
#
|
436
|
+
# @option params [required, String] :dataset_name
|
437
|
+
# The name of the dataset that this job is to act upon.
|
438
|
+
#
|
439
|
+
# @option params [String] :encryption_key_arn
|
440
|
+
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
441
|
+
# protect the job.
|
442
|
+
#
|
443
|
+
# @option params [String] :encryption_mode
|
444
|
+
# The encryption mode for the job, which can be one of the following:
|
445
|
+
#
|
446
|
+
# * `SSE-KMS` - para>`SSE-KMS` - server-side encryption with AWS
|
447
|
+
# KMS-managed keys.
|
448
|
+
#
|
449
|
+
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
450
|
+
#
|
451
|
+
# @option params [required, String] :name
|
452
|
+
# The name of the job to be created.
|
453
|
+
#
|
454
|
+
# @option params [String] :log_subscription
|
455
|
+
# A value that enables or disables Amazon CloudWatch logging for the
|
456
|
+
# current AWS account. If logging is enabled, CloudWatch writes one log
|
457
|
+
# stream for each job run.
|
458
|
+
#
|
459
|
+
# @option params [Integer] :max_capacity
|
460
|
+
# The maximum number of nodes that DataBrew can use when the job
|
461
|
+
# processes data.
|
462
|
+
#
|
463
|
+
# @option params [Integer] :max_retries
|
464
|
+
# The maximum number of times to retry the job after a job run fails.
|
465
|
+
#
|
466
|
+
# @option params [required, Types::S3Location] :output_location
|
467
|
+
# An Amazon S3 location (bucket name an object key) where DataBrew can
|
468
|
+
# read input data, or write output from a job.
|
469
|
+
#
|
470
|
+
# @option params [required, String] :role_arn
|
471
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
472
|
+
# Management (IAM) role to be assumed for this request.
|
473
|
+
#
|
474
|
+
# @option params [Hash<String,String>] :tags
|
475
|
+
# Metadata tags to apply to this job.
|
476
|
+
#
|
477
|
+
# @option params [Integer] :timeout
|
478
|
+
# The job's timeout in minutes. A job that attempts to run longer than
|
479
|
+
# this timeout period ends with a status of `TIMEOUT`.
|
480
|
+
#
|
481
|
+
# @return [Types::CreateProfileJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
482
|
+
#
|
483
|
+
# * {Types::CreateProfileJobResponse#name #name} => String
|
484
|
+
#
|
485
|
+
# @example Request syntax with placeholder values
|
486
|
+
#
|
487
|
+
# resp = client.create_profile_job({
|
488
|
+
# dataset_name: "DatasetName", # required
|
489
|
+
# encryption_key_arn: "EncryptionKeyArn",
|
490
|
+
# encryption_mode: "SSE-KMS", # accepts SSE-KMS, SSE-S3
|
491
|
+
# name: "JobName", # required
|
492
|
+
# log_subscription: "ENABLE", # accepts ENABLE, DISABLE
|
493
|
+
# max_capacity: 1,
|
494
|
+
# max_retries: 1,
|
495
|
+
# output_location: { # required
|
496
|
+
# bucket: "Bucket", # required
|
497
|
+
# key: "Key",
|
498
|
+
# },
|
499
|
+
# role_arn: "Arn", # required
|
500
|
+
# tags: {
|
501
|
+
# "TagKey" => "TagValue",
|
502
|
+
# },
|
503
|
+
# timeout: 1,
|
504
|
+
# })
|
505
|
+
#
|
506
|
+
# @example Response structure
|
507
|
+
#
|
508
|
+
# resp.name #=> String
|
509
|
+
#
|
510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateProfileJob AWS API Documentation
|
511
|
+
#
|
512
|
+
# @overload create_profile_job(params = {})
|
513
|
+
# @param [Hash] params ({})
|
514
|
+
def create_profile_job(params = {}, options = {})
|
515
|
+
req = build_request(:create_profile_job, params)
|
516
|
+
req.send_request(options)
|
517
|
+
end
|
518
|
+
|
519
|
+
# Creates a new AWS Glue DataBrew project in the current AWS account.
|
520
|
+
#
|
521
|
+
# @option params [required, String] :dataset_name
|
522
|
+
# The name of the dataset to associate this project with.
|
523
|
+
#
|
524
|
+
# @option params [required, String] :name
|
525
|
+
# A unique name for the new project.
|
526
|
+
#
|
527
|
+
# @option params [required, String] :recipe_name
|
528
|
+
# The name of an existing recipe to associate with the project.
|
529
|
+
#
|
530
|
+
# @option params [Types::Sample] :sample
|
531
|
+
# Represents the sample size and sampling type for AWS Glue DataBrew to
|
532
|
+
# use for interactive data analysis.
|
533
|
+
#
|
534
|
+
# @option params [required, String] :role_arn
|
535
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
536
|
+
# Management (IAM) role to be assumed for this request.
|
537
|
+
#
|
538
|
+
# @option params [Hash<String,String>] :tags
|
539
|
+
# Metadata tags to apply to this project.
|
540
|
+
#
|
541
|
+
# @return [Types::CreateProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
542
|
+
#
|
543
|
+
# * {Types::CreateProjectResponse#name #name} => String
|
544
|
+
#
|
545
|
+
# @example Request syntax with placeholder values
|
546
|
+
#
|
547
|
+
# resp = client.create_project({
|
548
|
+
# dataset_name: "DatasetName", # required
|
549
|
+
# name: "ProjectName", # required
|
550
|
+
# recipe_name: "RecipeName", # required
|
551
|
+
# sample: {
|
552
|
+
# size: 1,
|
553
|
+
# type: "FIRST_N", # required, accepts FIRST_N, LAST_N, RANDOM
|
554
|
+
# },
|
555
|
+
# role_arn: "Arn", # required
|
556
|
+
# tags: {
|
557
|
+
# "TagKey" => "TagValue",
|
558
|
+
# },
|
559
|
+
# })
|
560
|
+
#
|
561
|
+
# @example Response structure
|
562
|
+
#
|
563
|
+
# resp.name #=> String
|
564
|
+
#
|
565
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateProject AWS API Documentation
|
566
|
+
#
|
567
|
+
# @overload create_project(params = {})
|
568
|
+
# @param [Hash] params ({})
|
569
|
+
def create_project(params = {}, options = {})
|
570
|
+
req = build_request(:create_project, params)
|
571
|
+
req.send_request(options)
|
572
|
+
end
|
573
|
+
|
574
|
+
# Creates a new AWS Glue DataBrew recipe for the current AWS account.
|
575
|
+
#
|
576
|
+
# @option params [String] :description
|
577
|
+
# A description for the recipe.
|
578
|
+
#
|
579
|
+
# @option params [required, String] :name
|
580
|
+
# A unique name for the recipe.
|
581
|
+
#
|
582
|
+
# @option params [required, Array<Types::RecipeStep>] :steps
|
583
|
+
# An array containing the steps to be performed by the recipe. Each
|
584
|
+
# recipe step consists of one recipe action and (optionally) an array of
|
585
|
+
# condition expressions.
|
586
|
+
#
|
587
|
+
# @option params [Hash<String,String>] :tags
|
588
|
+
# Metadata tags to apply to this recipe.
|
589
|
+
#
|
590
|
+
# @return [Types::CreateRecipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
591
|
+
#
|
592
|
+
# * {Types::CreateRecipeResponse#name #name} => String
|
593
|
+
#
|
594
|
+
# @example Request syntax with placeholder values
|
595
|
+
#
|
596
|
+
# resp = client.create_recipe({
|
597
|
+
# description: "RecipeDescription",
|
598
|
+
# name: "RecipeName", # required
|
599
|
+
# steps: [ # required
|
600
|
+
# {
|
601
|
+
# action: { # required
|
602
|
+
# operation: "Operation", # required
|
603
|
+
# parameters: {
|
604
|
+
# "ParameterName" => "ParameterValue",
|
605
|
+
# },
|
606
|
+
# },
|
607
|
+
# condition_expressions: [
|
608
|
+
# {
|
609
|
+
# condition: "Condition", # required
|
610
|
+
# value: "ConditionValue",
|
611
|
+
# target_column: "TargetColumn", # required
|
612
|
+
# },
|
613
|
+
# ],
|
614
|
+
# },
|
615
|
+
# ],
|
616
|
+
# tags: {
|
617
|
+
# "TagKey" => "TagValue",
|
618
|
+
# },
|
619
|
+
# })
|
620
|
+
#
|
621
|
+
# @example Response structure
|
622
|
+
#
|
623
|
+
# resp.name #=> String
|
624
|
+
#
|
625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateRecipe AWS API Documentation
|
626
|
+
#
|
627
|
+
# @overload create_recipe(params = {})
|
628
|
+
# @param [Hash] params ({})
|
629
|
+
def create_recipe(params = {}, options = {})
|
630
|
+
req = build_request(:create_recipe, params)
|
631
|
+
req.send_request(options)
|
632
|
+
end
|
633
|
+
|
634
|
+
# Creates a new job for an existing AWS Glue DataBrew recipe in the
|
635
|
+
# current AWS account. You can create a standalone job using either a
|
636
|
+
# project, or a combination of a recipe and a dataset.
|
637
|
+
#
|
638
|
+
# @option params [String] :dataset_name
|
639
|
+
# The name of the dataset that this job processes.
|
640
|
+
#
|
641
|
+
# @option params [String] :encryption_key_arn
|
642
|
+
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
643
|
+
# protect the job.
|
644
|
+
#
|
645
|
+
# @option params [String] :encryption_mode
|
646
|
+
# The encryption mode for the job, which can be one of the following:
|
647
|
+
#
|
648
|
+
# * `SSE-KMS` - Server-side encryption with AWS KMS-managed keys.
|
649
|
+
#
|
650
|
+
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
651
|
+
#
|
652
|
+
# @option params [required, String] :name
|
653
|
+
# A unique name for the job.
|
654
|
+
#
|
655
|
+
# @option params [String] :log_subscription
|
656
|
+
# A value that enables or disables Amazon CloudWatch logging for the
|
657
|
+
# current AWS account. If logging is enabled, CloudWatch writes one log
|
658
|
+
# stream for each job run.
|
659
|
+
#
|
660
|
+
# @option params [Integer] :max_capacity
|
661
|
+
# The maximum number of nodes that DataBrew can consume when the job
|
662
|
+
# processes data.
|
663
|
+
#
|
664
|
+
# @option params [Integer] :max_retries
|
665
|
+
# The maximum number of times to retry the job after a job run fails.
|
666
|
+
#
|
667
|
+
# @option params [required, Array<Types::Output>] :outputs
|
668
|
+
# One or more artifacts that represent the output from running the job.
|
669
|
+
#
|
670
|
+
# @option params [String] :project_name
|
671
|
+
# Either the name of an existing project, or a combination of a recipe
|
672
|
+
# and a dataset to associate with the recipe.
|
673
|
+
#
|
674
|
+
# @option params [Types::RecipeReference] :recipe_reference
|
675
|
+
# Represents all of the attributes of an AWS Glue DataBrew recipe.
|
676
|
+
#
|
677
|
+
# @option params [required, String] :role_arn
|
678
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
679
|
+
# Management (IAM) role to be assumed for this request.
|
680
|
+
#
|
681
|
+
# @option params [Hash<String,String>] :tags
|
682
|
+
# Metadata tags to apply to this job dataset.
|
683
|
+
#
|
684
|
+
# @option params [Integer] :timeout
|
685
|
+
# The job's timeout in minutes. A job that attempts to run longer than
|
686
|
+
# this timeout period ends with a status of `TIMEOUT`.
|
687
|
+
#
|
688
|
+
# @return [Types::CreateRecipeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
689
|
+
#
|
690
|
+
# * {Types::CreateRecipeJobResponse#name #name} => String
|
691
|
+
#
|
692
|
+
# @example Request syntax with placeholder values
|
693
|
+
#
|
694
|
+
# resp = client.create_recipe_job({
|
695
|
+
# dataset_name: "DatasetName",
|
696
|
+
# encryption_key_arn: "EncryptionKeyArn",
|
697
|
+
# encryption_mode: "SSE-KMS", # accepts SSE-KMS, SSE-S3
|
698
|
+
# name: "JobName", # required
|
699
|
+
# log_subscription: "ENABLE", # accepts ENABLE, DISABLE
|
700
|
+
# max_capacity: 1,
|
701
|
+
# max_retries: 1,
|
702
|
+
# outputs: [ # required
|
703
|
+
# {
|
704
|
+
# compression_format: "GZIP", # accepts GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB
|
705
|
+
# format: "CSV", # accepts CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML
|
706
|
+
# partition_columns: ["ColumnName"],
|
707
|
+
# location: { # required
|
708
|
+
# bucket: "Bucket", # required
|
709
|
+
# key: "Key",
|
710
|
+
# },
|
711
|
+
# overwrite: false,
|
712
|
+
# },
|
713
|
+
# ],
|
714
|
+
# project_name: "ProjectName",
|
715
|
+
# recipe_reference: {
|
716
|
+
# name: "RecipeName", # required
|
717
|
+
# recipe_version: "RecipeVersion",
|
718
|
+
# },
|
719
|
+
# role_arn: "Arn", # required
|
720
|
+
# tags: {
|
721
|
+
# "TagKey" => "TagValue",
|
722
|
+
# },
|
723
|
+
# timeout: 1,
|
724
|
+
# })
|
725
|
+
#
|
726
|
+
# @example Response structure
|
727
|
+
#
|
728
|
+
# resp.name #=> String
|
729
|
+
#
|
730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateRecipeJob AWS API Documentation
|
731
|
+
#
|
732
|
+
# @overload create_recipe_job(params = {})
|
733
|
+
# @param [Hash] params ({})
|
734
|
+
def create_recipe_job(params = {}, options = {})
|
735
|
+
req = build_request(:create_recipe_job, params)
|
736
|
+
req.send_request(options)
|
737
|
+
end
|
738
|
+
|
739
|
+
# Creates a new schedule for one or more AWS Glue DataBrew jobs. Jobs
|
740
|
+
# can be run at a specific date and time, or at regular intervals.
|
741
|
+
#
|
742
|
+
# @option params [Array<String>] :job_names
|
743
|
+
# The name or names of one or more jobs to be run.
|
744
|
+
#
|
745
|
+
# @option params [required, String] :cron_expression
|
746
|
+
# The date or dates and time or times, in `cron` format, when the jobs
|
747
|
+
# are to be run.
|
748
|
+
#
|
749
|
+
# @option params [Hash<String,String>] :tags
|
750
|
+
# Metadata tags to apply to this schedule.
|
751
|
+
#
|
752
|
+
# @option params [required, String] :name
|
753
|
+
# A unique name for the schedule.
|
754
|
+
#
|
755
|
+
# @return [Types::CreateScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
756
|
+
#
|
757
|
+
# * {Types::CreateScheduleResponse#name #name} => String
|
758
|
+
#
|
759
|
+
# @example Request syntax with placeholder values
|
760
|
+
#
|
761
|
+
# resp = client.create_schedule({
|
762
|
+
# job_names: ["JobName"],
|
763
|
+
# cron_expression: "CronExpression", # required
|
764
|
+
# tags: {
|
765
|
+
# "TagKey" => "TagValue",
|
766
|
+
# },
|
767
|
+
# name: "ScheduleName", # required
|
768
|
+
# })
|
769
|
+
#
|
770
|
+
# @example Response structure
|
771
|
+
#
|
772
|
+
# resp.name #=> String
|
773
|
+
#
|
774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateSchedule AWS API Documentation
|
775
|
+
#
|
776
|
+
# @overload create_schedule(params = {})
|
777
|
+
# @param [Hash] params ({})
|
778
|
+
def create_schedule(params = {}, options = {})
|
779
|
+
req = build_request(:create_schedule, params)
|
780
|
+
req.send_request(options)
|
781
|
+
end
|
782
|
+
|
783
|
+
# Deletes a dataset from AWS Glue DataBrew.
|
784
|
+
#
|
785
|
+
# @option params [required, String] :name
|
786
|
+
# The name of the dataset to be deleted.
|
787
|
+
#
|
788
|
+
# @return [Types::DeleteDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
789
|
+
#
|
790
|
+
# * {Types::DeleteDatasetResponse#name #name} => String
|
791
|
+
#
|
792
|
+
# @example Request syntax with placeholder values
|
793
|
+
#
|
794
|
+
# resp = client.delete_dataset({
|
795
|
+
# name: "DatasetName", # required
|
796
|
+
# })
|
797
|
+
#
|
798
|
+
# @example Response structure
|
799
|
+
#
|
800
|
+
# resp.name #=> String
|
801
|
+
#
|
802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteDataset AWS API Documentation
|
803
|
+
#
|
804
|
+
# @overload delete_dataset(params = {})
|
805
|
+
# @param [Hash] params ({})
|
806
|
+
def delete_dataset(params = {}, options = {})
|
807
|
+
req = build_request(:delete_dataset, params)
|
808
|
+
req.send_request(options)
|
809
|
+
end
|
810
|
+
|
811
|
+
# Deletes the specified AWS Glue DataBrew job from the current AWS
|
812
|
+
# account. The job can be for a recipe or for a profile.
|
813
|
+
#
|
814
|
+
# @option params [required, String] :name
|
815
|
+
# The name of the job to be deleted.
|
816
|
+
#
|
817
|
+
# @return [Types::DeleteJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
818
|
+
#
|
819
|
+
# * {Types::DeleteJobResponse#name #name} => String
|
820
|
+
#
|
821
|
+
# @example Request syntax with placeholder values
|
822
|
+
#
|
823
|
+
# resp = client.delete_job({
|
824
|
+
# name: "JobName", # required
|
825
|
+
# })
|
826
|
+
#
|
827
|
+
# @example Response structure
|
828
|
+
#
|
829
|
+
# resp.name #=> String
|
830
|
+
#
|
831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteJob AWS API Documentation
|
832
|
+
#
|
833
|
+
# @overload delete_job(params = {})
|
834
|
+
# @param [Hash] params ({})
|
835
|
+
def delete_job(params = {}, options = {})
|
836
|
+
req = build_request(:delete_job, params)
|
837
|
+
req.send_request(options)
|
838
|
+
end
|
839
|
+
|
840
|
+
# Deletes an existing AWS Glue DataBrew project from the current AWS
|
841
|
+
# account.
|
842
|
+
#
|
843
|
+
# @option params [required, String] :name
|
844
|
+
# The name of the project to be deleted.
|
845
|
+
#
|
846
|
+
# @return [Types::DeleteProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
847
|
+
#
|
848
|
+
# * {Types::DeleteProjectResponse#name #name} => String
|
849
|
+
#
|
850
|
+
# @example Request syntax with placeholder values
|
851
|
+
#
|
852
|
+
# resp = client.delete_project({
|
853
|
+
# name: "ProjectName", # required
|
854
|
+
# })
|
855
|
+
#
|
856
|
+
# @example Response structure
|
857
|
+
#
|
858
|
+
# resp.name #=> String
|
859
|
+
#
|
860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteProject AWS API Documentation
|
861
|
+
#
|
862
|
+
# @overload delete_project(params = {})
|
863
|
+
# @param [Hash] params ({})
|
864
|
+
def delete_project(params = {}, options = {})
|
865
|
+
req = build_request(:delete_project, params)
|
866
|
+
req.send_request(options)
|
867
|
+
end
|
868
|
+
|
869
|
+
# Deletes a single version of an AWS Glue DataBrew recipe.
|
870
|
+
#
|
871
|
+
# @option params [required, String] :name
|
872
|
+
# The name of the recipe to be deleted.
|
873
|
+
#
|
874
|
+
# @option params [required, String] :recipe_version
|
875
|
+
# The version of the recipe to be deleted.
|
876
|
+
#
|
877
|
+
# @return [Types::DeleteRecipeVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
878
|
+
#
|
879
|
+
# * {Types::DeleteRecipeVersionResponse#name #name} => String
|
880
|
+
# * {Types::DeleteRecipeVersionResponse#recipe_version #recipe_version} => String
|
881
|
+
#
|
882
|
+
# @example Request syntax with placeholder values
|
883
|
+
#
|
884
|
+
# resp = client.delete_recipe_version({
|
885
|
+
# name: "RecipeName", # required
|
886
|
+
# recipe_version: "RecipeVersion", # required
|
887
|
+
# })
|
888
|
+
#
|
889
|
+
# @example Response structure
|
890
|
+
#
|
891
|
+
# resp.name #=> String
|
892
|
+
# resp.recipe_version #=> String
|
893
|
+
#
|
894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteRecipeVersion AWS API Documentation
|
895
|
+
#
|
896
|
+
# @overload delete_recipe_version(params = {})
|
897
|
+
# @param [Hash] params ({})
|
898
|
+
def delete_recipe_version(params = {}, options = {})
|
899
|
+
req = build_request(:delete_recipe_version, params)
|
900
|
+
req.send_request(options)
|
901
|
+
end
|
902
|
+
|
903
|
+
# Deletes the specified AWS Glue DataBrew schedule from the current AWS
|
904
|
+
# account.
|
905
|
+
#
|
906
|
+
# @option params [required, String] :name
|
907
|
+
# The name of the schedule to be deleted.
|
908
|
+
#
|
909
|
+
# @return [Types::DeleteScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
910
|
+
#
|
911
|
+
# * {Types::DeleteScheduleResponse#name #name} => String
|
912
|
+
#
|
913
|
+
# @example Request syntax with placeholder values
|
914
|
+
#
|
915
|
+
# resp = client.delete_schedule({
|
916
|
+
# name: "ScheduleName", # required
|
917
|
+
# })
|
918
|
+
#
|
919
|
+
# @example Response structure
|
920
|
+
#
|
921
|
+
# resp.name #=> String
|
922
|
+
#
|
923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteSchedule AWS API Documentation
|
924
|
+
#
|
925
|
+
# @overload delete_schedule(params = {})
|
926
|
+
# @param [Hash] params ({})
|
927
|
+
def delete_schedule(params = {}, options = {})
|
928
|
+
req = build_request(:delete_schedule, params)
|
929
|
+
req.send_request(options)
|
930
|
+
end
|
931
|
+
|
932
|
+
# Returns the definition of a specific AWS Glue DataBrew dataset that is
|
933
|
+
# in the current AWS account.
|
934
|
+
#
|
935
|
+
# @option params [required, String] :name
|
936
|
+
# The name of the dataset to be described.
|
937
|
+
#
|
938
|
+
# @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
939
|
+
#
|
940
|
+
# * {Types::DescribeDatasetResponse#created_by #created_by} => String
|
941
|
+
# * {Types::DescribeDatasetResponse#create_date #create_date} => Time
|
942
|
+
# * {Types::DescribeDatasetResponse#name #name} => String
|
943
|
+
# * {Types::DescribeDatasetResponse#format_options #format_options} => Types::FormatOptions
|
944
|
+
# * {Types::DescribeDatasetResponse#input #input} => Types::Input
|
945
|
+
# * {Types::DescribeDatasetResponse#last_modified_date #last_modified_date} => Time
|
946
|
+
# * {Types::DescribeDatasetResponse#last_modified_by #last_modified_by} => String
|
947
|
+
# * {Types::DescribeDatasetResponse#source #source} => String
|
948
|
+
# * {Types::DescribeDatasetResponse#tags #tags} => Hash<String,String>
|
949
|
+
# * {Types::DescribeDatasetResponse#resource_arn #resource_arn} => String
|
950
|
+
#
|
951
|
+
# @example Request syntax with placeholder values
|
952
|
+
#
|
953
|
+
# resp = client.describe_dataset({
|
954
|
+
# name: "DatasetName", # required
|
955
|
+
# })
|
956
|
+
#
|
957
|
+
# @example Response structure
|
958
|
+
#
|
959
|
+
# resp.created_by #=> String
|
960
|
+
# resp.create_date #=> Time
|
961
|
+
# resp.name #=> String
|
962
|
+
# resp.format_options.json.multi_line #=> Boolean
|
963
|
+
# resp.format_options.excel.sheet_names #=> Array
|
964
|
+
# resp.format_options.excel.sheet_names[0] #=> String
|
965
|
+
# resp.format_options.excel.sheet_indexes #=> Array
|
966
|
+
# resp.format_options.excel.sheet_indexes[0] #=> Integer
|
967
|
+
# resp.input.s3_input_definition.bucket #=> String
|
968
|
+
# resp.input.s3_input_definition.key #=> String
|
969
|
+
# resp.input.data_catalog_input_definition.catalog_id #=> String
|
970
|
+
# resp.input.data_catalog_input_definition.database_name #=> String
|
971
|
+
# resp.input.data_catalog_input_definition.table_name #=> String
|
972
|
+
# resp.input.data_catalog_input_definition.temp_directory.bucket #=> String
|
973
|
+
# resp.input.data_catalog_input_definition.temp_directory.key #=> String
|
974
|
+
# resp.last_modified_date #=> Time
|
975
|
+
# resp.last_modified_by #=> String
|
976
|
+
# resp.source #=> String, one of "S3", "DATA-CATALOG"
|
977
|
+
# resp.tags #=> Hash
|
978
|
+
# resp.tags["TagKey"] #=> String
|
979
|
+
# resp.resource_arn #=> String
|
980
|
+
#
|
981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeDataset AWS API Documentation
|
982
|
+
#
|
983
|
+
# @overload describe_dataset(params = {})
|
984
|
+
# @param [Hash] params ({})
|
985
|
+
def describe_dataset(params = {}, options = {})
|
986
|
+
req = build_request(:describe_dataset, params)
|
987
|
+
req.send_request(options)
|
988
|
+
end
|
989
|
+
|
990
|
+
# Returns the definition of a specific AWS Glue DataBrew job that is in
|
991
|
+
# the current AWS account.
|
992
|
+
#
|
993
|
+
# @option params [required, String] :name
|
994
|
+
# The name of the job to be described.
|
995
|
+
#
|
996
|
+
# @return [Types::DescribeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
997
|
+
#
|
998
|
+
# * {Types::DescribeJobResponse#create_date #create_date} => Time
|
999
|
+
# * {Types::DescribeJobResponse#created_by #created_by} => String
|
1000
|
+
# * {Types::DescribeJobResponse#dataset_name #dataset_name} => String
|
1001
|
+
# * {Types::DescribeJobResponse#encryption_key_arn #encryption_key_arn} => String
|
1002
|
+
# * {Types::DescribeJobResponse#encryption_mode #encryption_mode} => String
|
1003
|
+
# * {Types::DescribeJobResponse#name #name} => String
|
1004
|
+
# * {Types::DescribeJobResponse#type #type} => String
|
1005
|
+
# * {Types::DescribeJobResponse#last_modified_by #last_modified_by} => String
|
1006
|
+
# * {Types::DescribeJobResponse#last_modified_date #last_modified_date} => Time
|
1007
|
+
# * {Types::DescribeJobResponse#log_subscription #log_subscription} => String
|
1008
|
+
# * {Types::DescribeJobResponse#max_capacity #max_capacity} => Integer
|
1009
|
+
# * {Types::DescribeJobResponse#max_retries #max_retries} => Integer
|
1010
|
+
# * {Types::DescribeJobResponse#outputs #outputs} => Array<Types::Output>
|
1011
|
+
# * {Types::DescribeJobResponse#project_name #project_name} => String
|
1012
|
+
# * {Types::DescribeJobResponse#recipe_reference #recipe_reference} => Types::RecipeReference
|
1013
|
+
# * {Types::DescribeJobResponse#resource_arn #resource_arn} => String
|
1014
|
+
# * {Types::DescribeJobResponse#role_arn #role_arn} => String
|
1015
|
+
# * {Types::DescribeJobResponse#tags #tags} => Hash<String,String>
|
1016
|
+
# * {Types::DescribeJobResponse#timeout #timeout} => Integer
|
1017
|
+
#
|
1018
|
+
# @example Request syntax with placeholder values
|
1019
|
+
#
|
1020
|
+
# resp = client.describe_job({
|
1021
|
+
# name: "JobName", # required
|
1022
|
+
# })
|
1023
|
+
#
|
1024
|
+
# @example Response structure
|
1025
|
+
#
|
1026
|
+
# resp.create_date #=> Time
|
1027
|
+
# resp.created_by #=> String
|
1028
|
+
# resp.dataset_name #=> String
|
1029
|
+
# resp.encryption_key_arn #=> String
|
1030
|
+
# resp.encryption_mode #=> String, one of "SSE-KMS", "SSE-S3"
|
1031
|
+
# resp.name #=> String
|
1032
|
+
# resp.type #=> String, one of "PROFILE", "RECIPE"
|
1033
|
+
# resp.last_modified_by #=> String
|
1034
|
+
# resp.last_modified_date #=> Time
|
1035
|
+
# resp.log_subscription #=> String, one of "ENABLE", "DISABLE"
|
1036
|
+
# resp.max_capacity #=> Integer
|
1037
|
+
# resp.max_retries #=> Integer
|
1038
|
+
# resp.outputs #=> Array
|
1039
|
+
# resp.outputs[0].compression_format #=> String, one of "GZIP", "LZ4", "SNAPPY", "BZIP2", "DEFLATE", "LZO", "BROTLI", "ZSTD", "ZLIB"
|
1040
|
+
# resp.outputs[0].format #=> String, one of "CSV", "JSON", "PARQUET", "GLUEPARQUET", "AVRO", "ORC", "XML"
|
1041
|
+
# resp.outputs[0].partition_columns #=> Array
|
1042
|
+
# resp.outputs[0].partition_columns[0] #=> String
|
1043
|
+
# resp.outputs[0].location.bucket #=> String
|
1044
|
+
# resp.outputs[0].location.key #=> String
|
1045
|
+
# resp.outputs[0].overwrite #=> Boolean
|
1046
|
+
# resp.project_name #=> String
|
1047
|
+
# resp.recipe_reference.name #=> String
|
1048
|
+
# resp.recipe_reference.recipe_version #=> String
|
1049
|
+
# resp.resource_arn #=> String
|
1050
|
+
# resp.role_arn #=> String
|
1051
|
+
# resp.tags #=> Hash
|
1052
|
+
# resp.tags["TagKey"] #=> String
|
1053
|
+
# resp.timeout #=> Integer
|
1054
|
+
#
|
1055
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeJob AWS API Documentation
|
1056
|
+
#
|
1057
|
+
# @overload describe_job(params = {})
|
1058
|
+
# @param [Hash] params ({})
|
1059
|
+
def describe_job(params = {}, options = {})
|
1060
|
+
req = build_request(:describe_job, params)
|
1061
|
+
req.send_request(options)
|
1062
|
+
end
|
1063
|
+
|
1064
|
+
# Returns the definition of a specific AWS Glue DataBrew project that is
|
1065
|
+
# in the current AWS account.
|
1066
|
+
#
|
1067
|
+
# @option params [required, String] :name
|
1068
|
+
# The name of the project to be described.
|
1069
|
+
#
|
1070
|
+
# @return [Types::DescribeProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1071
|
+
#
|
1072
|
+
# * {Types::DescribeProjectResponse#create_date #create_date} => Time
|
1073
|
+
# * {Types::DescribeProjectResponse#created_by #created_by} => String
|
1074
|
+
# * {Types::DescribeProjectResponse#dataset_name #dataset_name} => String
|
1075
|
+
# * {Types::DescribeProjectResponse#last_modified_date #last_modified_date} => Time
|
1076
|
+
# * {Types::DescribeProjectResponse#last_modified_by #last_modified_by} => String
|
1077
|
+
# * {Types::DescribeProjectResponse#name #name} => String
|
1078
|
+
# * {Types::DescribeProjectResponse#recipe_name #recipe_name} => String
|
1079
|
+
# * {Types::DescribeProjectResponse#resource_arn #resource_arn} => String
|
1080
|
+
# * {Types::DescribeProjectResponse#sample #sample} => Types::Sample
|
1081
|
+
# * {Types::DescribeProjectResponse#role_arn #role_arn} => String
|
1082
|
+
# * {Types::DescribeProjectResponse#tags #tags} => Hash<String,String>
|
1083
|
+
# * {Types::DescribeProjectResponse#session_status #session_status} => String
|
1084
|
+
# * {Types::DescribeProjectResponse#opened_by #opened_by} => String
|
1085
|
+
# * {Types::DescribeProjectResponse#open_date #open_date} => Time
|
1086
|
+
#
|
1087
|
+
# @example Request syntax with placeholder values
|
1088
|
+
#
|
1089
|
+
# resp = client.describe_project({
|
1090
|
+
# name: "ProjectName", # required
|
1091
|
+
# })
|
1092
|
+
#
|
1093
|
+
# @example Response structure
|
1094
|
+
#
|
1095
|
+
# resp.create_date #=> Time
|
1096
|
+
# resp.created_by #=> String
|
1097
|
+
# resp.dataset_name #=> String
|
1098
|
+
# resp.last_modified_date #=> Time
|
1099
|
+
# resp.last_modified_by #=> String
|
1100
|
+
# resp.name #=> String
|
1101
|
+
# resp.recipe_name #=> String
|
1102
|
+
# resp.resource_arn #=> String
|
1103
|
+
# resp.sample.size #=> Integer
|
1104
|
+
# resp.sample.type #=> String, one of "FIRST_N", "LAST_N", "RANDOM"
|
1105
|
+
# resp.role_arn #=> String
|
1106
|
+
# resp.tags #=> Hash
|
1107
|
+
# resp.tags["TagKey"] #=> String
|
1108
|
+
# resp.session_status #=> String, one of "ASSIGNED", "FAILED", "INITIALIZING", "PROVISIONING", "READY", "RECYCLING", "ROTATING", "TERMINATED", "TERMINATING", "UPDATING"
|
1109
|
+
# resp.opened_by #=> String
|
1110
|
+
# resp.open_date #=> Time
|
1111
|
+
#
|
1112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeProject AWS API Documentation
|
1113
|
+
#
|
1114
|
+
# @overload describe_project(params = {})
|
1115
|
+
# @param [Hash] params ({})
|
1116
|
+
def describe_project(params = {}, options = {})
|
1117
|
+
req = build_request(:describe_project, params)
|
1118
|
+
req.send_request(options)
|
1119
|
+
end
|
1120
|
+
|
1121
|
+
# Returns the definition of a specific AWS Glue DataBrew recipe that is
|
1122
|
+
# in the current AWS account.
|
1123
|
+
#
|
1124
|
+
# @option params [required, String] :name
|
1125
|
+
# The name of the recipe to be described.
|
1126
|
+
#
|
1127
|
+
# @option params [String] :recipe_version
|
1128
|
+
# The recipe version identifier. If this parameter isn't specified,
|
1129
|
+
# then the latest published version is returned.
|
1130
|
+
#
|
1131
|
+
# @return [Types::DescribeRecipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1132
|
+
#
|
1133
|
+
# * {Types::DescribeRecipeResponse#created_by #created_by} => String
|
1134
|
+
# * {Types::DescribeRecipeResponse#create_date #create_date} => Time
|
1135
|
+
# * {Types::DescribeRecipeResponse#last_modified_by #last_modified_by} => String
|
1136
|
+
# * {Types::DescribeRecipeResponse#last_modified_date #last_modified_date} => Time
|
1137
|
+
# * {Types::DescribeRecipeResponse#project_name #project_name} => String
|
1138
|
+
# * {Types::DescribeRecipeResponse#published_by #published_by} => String
|
1139
|
+
# * {Types::DescribeRecipeResponse#published_date #published_date} => Time
|
1140
|
+
# * {Types::DescribeRecipeResponse#description #description} => String
|
1141
|
+
# * {Types::DescribeRecipeResponse#name #name} => String
|
1142
|
+
# * {Types::DescribeRecipeResponse#steps #steps} => Array<Types::RecipeStep>
|
1143
|
+
# * {Types::DescribeRecipeResponse#tags #tags} => Hash<String,String>
|
1144
|
+
# * {Types::DescribeRecipeResponse#resource_arn #resource_arn} => String
|
1145
|
+
# * {Types::DescribeRecipeResponse#recipe_version #recipe_version} => String
|
1146
|
+
#
|
1147
|
+
# @example Request syntax with placeholder values
|
1148
|
+
#
|
1149
|
+
# resp = client.describe_recipe({
|
1150
|
+
# name: "RecipeName", # required
|
1151
|
+
# recipe_version: "RecipeVersion",
|
1152
|
+
# })
|
1153
|
+
#
|
1154
|
+
# @example Response structure
|
1155
|
+
#
|
1156
|
+
# resp.created_by #=> String
|
1157
|
+
# resp.create_date #=> Time
|
1158
|
+
# resp.last_modified_by #=> String
|
1159
|
+
# resp.last_modified_date #=> Time
|
1160
|
+
# resp.project_name #=> String
|
1161
|
+
# resp.published_by #=> String
|
1162
|
+
# resp.published_date #=> Time
|
1163
|
+
# resp.description #=> String
|
1164
|
+
# resp.name #=> String
|
1165
|
+
# resp.steps #=> Array
|
1166
|
+
# resp.steps[0].action.operation #=> String
|
1167
|
+
# resp.steps[0].action.parameters #=> Hash
|
1168
|
+
# resp.steps[0].action.parameters["ParameterName"] #=> String
|
1169
|
+
# resp.steps[0].condition_expressions #=> Array
|
1170
|
+
# resp.steps[0].condition_expressions[0].condition #=> String
|
1171
|
+
# resp.steps[0].condition_expressions[0].value #=> String
|
1172
|
+
# resp.steps[0].condition_expressions[0].target_column #=> String
|
1173
|
+
# resp.tags #=> Hash
|
1174
|
+
# resp.tags["TagKey"] #=> String
|
1175
|
+
# resp.resource_arn #=> String
|
1176
|
+
# resp.recipe_version #=> String
|
1177
|
+
#
|
1178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeRecipe AWS API Documentation
|
1179
|
+
#
|
1180
|
+
# @overload describe_recipe(params = {})
|
1181
|
+
# @param [Hash] params ({})
|
1182
|
+
def describe_recipe(params = {}, options = {})
|
1183
|
+
req = build_request(:describe_recipe, params)
|
1184
|
+
req.send_request(options)
|
1185
|
+
end
|
1186
|
+
|
1187
|
+
# Returns the definition of a specific AWS Glue DataBrew schedule that
|
1188
|
+
# is in the current AWS account.
|
1189
|
+
#
|
1190
|
+
# @option params [required, String] :name
|
1191
|
+
# The name of the schedule to be described.
|
1192
|
+
#
|
1193
|
+
# @return [Types::DescribeScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1194
|
+
#
|
1195
|
+
# * {Types::DescribeScheduleResponse#create_date #create_date} => Time
|
1196
|
+
# * {Types::DescribeScheduleResponse#created_by #created_by} => String
|
1197
|
+
# * {Types::DescribeScheduleResponse#job_names #job_names} => Array<String>
|
1198
|
+
# * {Types::DescribeScheduleResponse#last_modified_by #last_modified_by} => String
|
1199
|
+
# * {Types::DescribeScheduleResponse#last_modified_date #last_modified_date} => Time
|
1200
|
+
# * {Types::DescribeScheduleResponse#resource_arn #resource_arn} => String
|
1201
|
+
# * {Types::DescribeScheduleResponse#cron_expression #cron_expression} => String
|
1202
|
+
# * {Types::DescribeScheduleResponse#tags #tags} => Hash<String,String>
|
1203
|
+
# * {Types::DescribeScheduleResponse#name #name} => String
|
1204
|
+
#
|
1205
|
+
# @example Request syntax with placeholder values
|
1206
|
+
#
|
1207
|
+
# resp = client.describe_schedule({
|
1208
|
+
# name: "ScheduleName", # required
|
1209
|
+
# })
|
1210
|
+
#
|
1211
|
+
# @example Response structure
|
1212
|
+
#
|
1213
|
+
# resp.create_date #=> Time
|
1214
|
+
# resp.created_by #=> String
|
1215
|
+
# resp.job_names #=> Array
|
1216
|
+
# resp.job_names[0] #=> String
|
1217
|
+
# resp.last_modified_by #=> String
|
1218
|
+
# resp.last_modified_date #=> Time
|
1219
|
+
# resp.resource_arn #=> String
|
1220
|
+
# resp.cron_expression #=> String
|
1221
|
+
# resp.tags #=> Hash
|
1222
|
+
# resp.tags["TagKey"] #=> String
|
1223
|
+
# resp.name #=> String
|
1224
|
+
#
|
1225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeSchedule AWS API Documentation
|
1226
|
+
#
|
1227
|
+
# @overload describe_schedule(params = {})
|
1228
|
+
# @param [Hash] params ({})
|
1229
|
+
def describe_schedule(params = {}, options = {})
|
1230
|
+
req = build_request(:describe_schedule, params)
|
1231
|
+
req.send_request(options)
|
1232
|
+
end
|
1233
|
+
|
1234
|
+
# Lists all of the AWS Glue DataBrew datasets for the current AWS
|
1235
|
+
# account.
|
1236
|
+
#
|
1237
|
+
# @option params [Integer] :max_results
|
1238
|
+
# The maximum number of results to return in this request.
|
1239
|
+
#
|
1240
|
+
# @option params [String] :next_token
|
1241
|
+
# A token generated by DataBrew that specifies where to continue
|
1242
|
+
# pagination if a previous request was truncated. To get the next set of
|
1243
|
+
# pages, pass in the NextToken value from the response object of the
|
1244
|
+
# previous page call.
|
1245
|
+
#
|
1246
|
+
# @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1247
|
+
#
|
1248
|
+
# * {Types::ListDatasetsResponse#datasets #datasets} => Array<Types::Dataset>
|
1249
|
+
# * {Types::ListDatasetsResponse#next_token #next_token} => String
|
1250
|
+
#
|
1251
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1252
|
+
#
|
1253
|
+
# @example Request syntax with placeholder values
|
1254
|
+
#
|
1255
|
+
# resp = client.list_datasets({
|
1256
|
+
# max_results: 1,
|
1257
|
+
# next_token: "NextToken",
|
1258
|
+
# })
|
1259
|
+
#
|
1260
|
+
# @example Response structure
|
1261
|
+
#
|
1262
|
+
# resp.datasets #=> Array
|
1263
|
+
# resp.datasets[0].account_id #=> String
|
1264
|
+
# resp.datasets[0].created_by #=> String
|
1265
|
+
# resp.datasets[0].create_date #=> Time
|
1266
|
+
# resp.datasets[0].name #=> String
|
1267
|
+
# resp.datasets[0].format_options.json.multi_line #=> Boolean
|
1268
|
+
# resp.datasets[0].format_options.excel.sheet_names #=> Array
|
1269
|
+
# resp.datasets[0].format_options.excel.sheet_names[0] #=> String
|
1270
|
+
# resp.datasets[0].format_options.excel.sheet_indexes #=> Array
|
1271
|
+
# resp.datasets[0].format_options.excel.sheet_indexes[0] #=> Integer
|
1272
|
+
# resp.datasets[0].input.s3_input_definition.bucket #=> String
|
1273
|
+
# resp.datasets[0].input.s3_input_definition.key #=> String
|
1274
|
+
# resp.datasets[0].input.data_catalog_input_definition.catalog_id #=> String
|
1275
|
+
# resp.datasets[0].input.data_catalog_input_definition.database_name #=> String
|
1276
|
+
# resp.datasets[0].input.data_catalog_input_definition.table_name #=> String
|
1277
|
+
# resp.datasets[0].input.data_catalog_input_definition.temp_directory.bucket #=> String
|
1278
|
+
# resp.datasets[0].input.data_catalog_input_definition.temp_directory.key #=> String
|
1279
|
+
# resp.datasets[0].last_modified_date #=> Time
|
1280
|
+
# resp.datasets[0].last_modified_by #=> String
|
1281
|
+
# resp.datasets[0].source #=> String, one of "S3", "DATA-CATALOG"
|
1282
|
+
# resp.datasets[0].tags #=> Hash
|
1283
|
+
# resp.datasets[0].tags["TagKey"] #=> String
|
1284
|
+
# resp.datasets[0].resource_arn #=> String
|
1285
|
+
# resp.next_token #=> String
|
1286
|
+
#
|
1287
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListDatasets AWS API Documentation
|
1288
|
+
#
|
1289
|
+
# @overload list_datasets(params = {})
|
1290
|
+
# @param [Hash] params ({})
|
1291
|
+
def list_datasets(params = {}, options = {})
|
1292
|
+
req = build_request(:list_datasets, params)
|
1293
|
+
req.send_request(options)
|
1294
|
+
end
|
1295
|
+
|
1296
|
+
# Lists all of the previous runs of a particular AWS Glue DataBrew job
|
1297
|
+
# in the current AWS account.
|
1298
|
+
#
|
1299
|
+
# @option params [required, String] :name
|
1300
|
+
# The name of the job.
|
1301
|
+
#
|
1302
|
+
# @option params [Integer] :max_results
|
1303
|
+
# The maximum number of results to return in this request.
|
1304
|
+
#
|
1305
|
+
# @option params [String] :next_token
|
1306
|
+
# A token generated by AWS Glue DataBrew that specifies where to
|
1307
|
+
# continue pagination if a previous request was truncated. To get the
|
1308
|
+
# next set of pages, pass in the NextToken value from the response
|
1309
|
+
# object of the previous page call.
|
1310
|
+
#
|
1311
|
+
# @return [Types::ListJobRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1312
|
+
#
|
1313
|
+
# * {Types::ListJobRunsResponse#job_runs #job_runs} => Array<Types::JobRun>
|
1314
|
+
# * {Types::ListJobRunsResponse#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_job_runs({
|
1321
|
+
# name: "JobName", # required
|
1322
|
+
# max_results: 1,
|
1323
|
+
# next_token: "NextToken",
|
1324
|
+
# })
|
1325
|
+
#
|
1326
|
+
# @example Response structure
|
1327
|
+
#
|
1328
|
+
# resp.job_runs #=> Array
|
1329
|
+
# resp.job_runs[0].attempt #=> Integer
|
1330
|
+
# resp.job_runs[0].completed_on #=> Time
|
1331
|
+
# resp.job_runs[0].dataset_name #=> String
|
1332
|
+
# resp.job_runs[0].error_message #=> String
|
1333
|
+
# resp.job_runs[0].execution_time #=> Integer
|
1334
|
+
# resp.job_runs[0].job_name #=> String
|
1335
|
+
# resp.job_runs[0].run_id #=> String
|
1336
|
+
# resp.job_runs[0].state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED", "TIMEOUT"
|
1337
|
+
# resp.job_runs[0].log_subscription #=> String, one of "ENABLE", "DISABLE"
|
1338
|
+
# resp.job_runs[0].log_group_name #=> String
|
1339
|
+
# resp.job_runs[0].outputs #=> Array
|
1340
|
+
# resp.job_runs[0].outputs[0].compression_format #=> String, one of "GZIP", "LZ4", "SNAPPY", "BZIP2", "DEFLATE", "LZO", "BROTLI", "ZSTD", "ZLIB"
|
1341
|
+
# resp.job_runs[0].outputs[0].format #=> String, one of "CSV", "JSON", "PARQUET", "GLUEPARQUET", "AVRO", "ORC", "XML"
|
1342
|
+
# resp.job_runs[0].outputs[0].partition_columns #=> Array
|
1343
|
+
# resp.job_runs[0].outputs[0].partition_columns[0] #=> String
|
1344
|
+
# resp.job_runs[0].outputs[0].location.bucket #=> String
|
1345
|
+
# resp.job_runs[0].outputs[0].location.key #=> String
|
1346
|
+
# resp.job_runs[0].outputs[0].overwrite #=> Boolean
|
1347
|
+
# resp.job_runs[0].recipe_reference.name #=> String
|
1348
|
+
# resp.job_runs[0].recipe_reference.recipe_version #=> String
|
1349
|
+
# resp.job_runs[0].started_by #=> String
|
1350
|
+
# resp.job_runs[0].started_on #=> Time
|
1351
|
+
# resp.next_token #=> String
|
1352
|
+
#
|
1353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobRuns AWS API Documentation
|
1354
|
+
#
|
1355
|
+
# @overload list_job_runs(params = {})
|
1356
|
+
# @param [Hash] params ({})
|
1357
|
+
def list_job_runs(params = {}, options = {})
|
1358
|
+
req = build_request(:list_job_runs, params)
|
1359
|
+
req.send_request(options)
|
1360
|
+
end
|
1361
|
+
|
1362
|
+
# Lists the AWS Glue DataBrew jobs in the current AWS account.
|
1363
|
+
#
|
1364
|
+
# @option params [String] :dataset_name
|
1365
|
+
# The name of a dataset. Using this parameter indicates to return only
|
1366
|
+
# those jobs that act on the specified dataset.
|
1367
|
+
#
|
1368
|
+
# @option params [Integer] :max_results
|
1369
|
+
# The maximum number of results to return in this request.
|
1370
|
+
#
|
1371
|
+
# @option params [String] :next_token
|
1372
|
+
# A token generated by DataBrew that specifies where to continue
|
1373
|
+
# pagination if a previous request was truncated. To get the next set of
|
1374
|
+
# pages, pass in the NextToken value from the response object of the
|
1375
|
+
# previous page call.
|
1376
|
+
#
|
1377
|
+
# @option params [String] :project_name
|
1378
|
+
# The name of a project. Using this parameter indicates to return only
|
1379
|
+
# those jobs that are associated with the specified project.
|
1380
|
+
#
|
1381
|
+
# @return [Types::ListJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1382
|
+
#
|
1383
|
+
# * {Types::ListJobsResponse#jobs #jobs} => Array<Types::Job>
|
1384
|
+
# * {Types::ListJobsResponse#next_token #next_token} => String
|
1385
|
+
#
|
1386
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1387
|
+
#
|
1388
|
+
# @example Request syntax with placeholder values
|
1389
|
+
#
|
1390
|
+
# resp = client.list_jobs({
|
1391
|
+
# dataset_name: "DatasetName",
|
1392
|
+
# max_results: 1,
|
1393
|
+
# next_token: "NextToken",
|
1394
|
+
# project_name: "ProjectName",
|
1395
|
+
# })
|
1396
|
+
#
|
1397
|
+
# @example Response structure
|
1398
|
+
#
|
1399
|
+
# resp.jobs #=> Array
|
1400
|
+
# resp.jobs[0].account_id #=> String
|
1401
|
+
# resp.jobs[0].created_by #=> String
|
1402
|
+
# resp.jobs[0].create_date #=> Time
|
1403
|
+
# resp.jobs[0].dataset_name #=> String
|
1404
|
+
# resp.jobs[0].encryption_key_arn #=> String
|
1405
|
+
# resp.jobs[0].encryption_mode #=> String, one of "SSE-KMS", "SSE-S3"
|
1406
|
+
# resp.jobs[0].name #=> String
|
1407
|
+
# resp.jobs[0].type #=> String, one of "PROFILE", "RECIPE"
|
1408
|
+
# resp.jobs[0].last_modified_by #=> String
|
1409
|
+
# resp.jobs[0].last_modified_date #=> Time
|
1410
|
+
# resp.jobs[0].log_subscription #=> String, one of "ENABLE", "DISABLE"
|
1411
|
+
# resp.jobs[0].max_capacity #=> Integer
|
1412
|
+
# resp.jobs[0].max_retries #=> Integer
|
1413
|
+
# resp.jobs[0].outputs #=> Array
|
1414
|
+
# resp.jobs[0].outputs[0].compression_format #=> String, one of "GZIP", "LZ4", "SNAPPY", "BZIP2", "DEFLATE", "LZO", "BROTLI", "ZSTD", "ZLIB"
|
1415
|
+
# resp.jobs[0].outputs[0].format #=> String, one of "CSV", "JSON", "PARQUET", "GLUEPARQUET", "AVRO", "ORC", "XML"
|
1416
|
+
# resp.jobs[0].outputs[0].partition_columns #=> Array
|
1417
|
+
# resp.jobs[0].outputs[0].partition_columns[0] #=> String
|
1418
|
+
# resp.jobs[0].outputs[0].location.bucket #=> String
|
1419
|
+
# resp.jobs[0].outputs[0].location.key #=> String
|
1420
|
+
# resp.jobs[0].outputs[0].overwrite #=> Boolean
|
1421
|
+
# resp.jobs[0].project_name #=> String
|
1422
|
+
# resp.jobs[0].recipe_reference.name #=> String
|
1423
|
+
# resp.jobs[0].recipe_reference.recipe_version #=> String
|
1424
|
+
# resp.jobs[0].resource_arn #=> String
|
1425
|
+
# resp.jobs[0].role_arn #=> String
|
1426
|
+
# resp.jobs[0].timeout #=> Integer
|
1427
|
+
# resp.jobs[0].tags #=> Hash
|
1428
|
+
# resp.jobs[0].tags["TagKey"] #=> String
|
1429
|
+
# resp.next_token #=> String
|
1430
|
+
#
|
1431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobs AWS API Documentation
|
1432
|
+
#
|
1433
|
+
# @overload list_jobs(params = {})
|
1434
|
+
# @param [Hash] params ({})
|
1435
|
+
def list_jobs(params = {}, options = {})
|
1436
|
+
req = build_request(:list_jobs, params)
|
1437
|
+
req.send_request(options)
|
1438
|
+
end
|
1439
|
+
|
1440
|
+
# Lists all of the DataBrew projects in the current AWS account.
|
1441
|
+
#
|
1442
|
+
# @option params [String] :next_token
|
1443
|
+
# A pagination token that can be used in a subsequent request.
|
1444
|
+
#
|
1445
|
+
# @option params [Integer] :max_results
|
1446
|
+
# The maximum number of results to return in this request.
|
1447
|
+
#
|
1448
|
+
# @return [Types::ListProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1449
|
+
#
|
1450
|
+
# * {Types::ListProjectsResponse#projects #projects} => Array<Types::Project>
|
1451
|
+
# * {Types::ListProjectsResponse#next_token #next_token} => String
|
1452
|
+
#
|
1453
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1454
|
+
#
|
1455
|
+
# @example Request syntax with placeholder values
|
1456
|
+
#
|
1457
|
+
# resp = client.list_projects({
|
1458
|
+
# next_token: "NextToken",
|
1459
|
+
# max_results: 1,
|
1460
|
+
# })
|
1461
|
+
#
|
1462
|
+
# @example Response structure
|
1463
|
+
#
|
1464
|
+
# resp.projects #=> Array
|
1465
|
+
# resp.projects[0].account_id #=> String
|
1466
|
+
# resp.projects[0].create_date #=> Time
|
1467
|
+
# resp.projects[0].created_by #=> String
|
1468
|
+
# resp.projects[0].dataset_name #=> String
|
1469
|
+
# resp.projects[0].last_modified_date #=> Time
|
1470
|
+
# resp.projects[0].last_modified_by #=> String
|
1471
|
+
# resp.projects[0].name #=> String
|
1472
|
+
# resp.projects[0].recipe_name #=> String
|
1473
|
+
# resp.projects[0].resource_arn #=> String
|
1474
|
+
# resp.projects[0].sample.size #=> Integer
|
1475
|
+
# resp.projects[0].sample.type #=> String, one of "FIRST_N", "LAST_N", "RANDOM"
|
1476
|
+
# resp.projects[0].tags #=> Hash
|
1477
|
+
# resp.projects[0].tags["TagKey"] #=> String
|
1478
|
+
# resp.projects[0].role_arn #=> String
|
1479
|
+
# resp.projects[0].opened_by #=> String
|
1480
|
+
# resp.projects[0].open_date #=> Time
|
1481
|
+
# resp.next_token #=> String
|
1482
|
+
#
|
1483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListProjects AWS API Documentation
|
1484
|
+
#
|
1485
|
+
# @overload list_projects(params = {})
|
1486
|
+
# @param [Hash] params ({})
|
1487
|
+
def list_projects(params = {}, options = {})
|
1488
|
+
req = build_request(:list_projects, params)
|
1489
|
+
req.send_request(options)
|
1490
|
+
end
|
1491
|
+
|
1492
|
+
# Lists all of the versions of a particular AWS Glue DataBrew recipe in
|
1493
|
+
# the current AWS account.
|
1494
|
+
#
|
1495
|
+
# @option params [Integer] :max_results
|
1496
|
+
# The maximum number of results to return in this request.
|
1497
|
+
#
|
1498
|
+
# @option params [String] :next_token
|
1499
|
+
# A pagination token that can be used in a subsequent request.
|
1500
|
+
#
|
1501
|
+
# @option params [required, String] :name
|
1502
|
+
# The name of the recipe for which to return version information.
|
1503
|
+
#
|
1504
|
+
# @return [Types::ListRecipeVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1505
|
+
#
|
1506
|
+
# * {Types::ListRecipeVersionsResponse#next_token #next_token} => String
|
1507
|
+
# * {Types::ListRecipeVersionsResponse#recipes #recipes} => Array<Types::Recipe>
|
1508
|
+
#
|
1509
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1510
|
+
#
|
1511
|
+
# @example Request syntax with placeholder values
|
1512
|
+
#
|
1513
|
+
# resp = client.list_recipe_versions({
|
1514
|
+
# max_results: 1,
|
1515
|
+
# next_token: "NextToken",
|
1516
|
+
# name: "RecipeName", # required
|
1517
|
+
# })
|
1518
|
+
#
|
1519
|
+
# @example Response structure
|
1520
|
+
#
|
1521
|
+
# resp.next_token #=> String
|
1522
|
+
# resp.recipes #=> Array
|
1523
|
+
# resp.recipes[0].created_by #=> String
|
1524
|
+
# resp.recipes[0].create_date #=> Time
|
1525
|
+
# resp.recipes[0].last_modified_by #=> String
|
1526
|
+
# resp.recipes[0].last_modified_date #=> Time
|
1527
|
+
# resp.recipes[0].project_name #=> String
|
1528
|
+
# resp.recipes[0].published_by #=> String
|
1529
|
+
# resp.recipes[0].published_date #=> Time
|
1530
|
+
# resp.recipes[0].description #=> String
|
1531
|
+
# resp.recipes[0].name #=> String
|
1532
|
+
# resp.recipes[0].resource_arn #=> String
|
1533
|
+
# resp.recipes[0].steps #=> Array
|
1534
|
+
# resp.recipes[0].steps[0].action.operation #=> String
|
1535
|
+
# resp.recipes[0].steps[0].action.parameters #=> Hash
|
1536
|
+
# resp.recipes[0].steps[0].action.parameters["ParameterName"] #=> String
|
1537
|
+
# resp.recipes[0].steps[0].condition_expressions #=> Array
|
1538
|
+
# resp.recipes[0].steps[0].condition_expressions[0].condition #=> String
|
1539
|
+
# resp.recipes[0].steps[0].condition_expressions[0].value #=> String
|
1540
|
+
# resp.recipes[0].steps[0].condition_expressions[0].target_column #=> String
|
1541
|
+
# resp.recipes[0].tags #=> Hash
|
1542
|
+
# resp.recipes[0].tags["TagKey"] #=> String
|
1543
|
+
# resp.recipes[0].recipe_version #=> String
|
1544
|
+
#
|
1545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRecipeVersions AWS API Documentation
|
1546
|
+
#
|
1547
|
+
# @overload list_recipe_versions(params = {})
|
1548
|
+
# @param [Hash] params ({})
|
1549
|
+
def list_recipe_versions(params = {}, options = {})
|
1550
|
+
req = build_request(:list_recipe_versions, params)
|
1551
|
+
req.send_request(options)
|
1552
|
+
end
|
1553
|
+
|
1554
|
+
# Lists all of the AWS Glue DataBrew recipes in the current AWS account.
|
1555
|
+
#
|
1556
|
+
# @option params [Integer] :max_results
|
1557
|
+
# The maximum number of results to return in this request.
|
1558
|
+
#
|
1559
|
+
# @option params [String] :next_token
|
1560
|
+
# A pagination token that can be used in a subsequent request.
|
1561
|
+
#
|
1562
|
+
# @option params [String] :recipe_version
|
1563
|
+
# A version identifier. Using this parameter indicates to return only
|
1564
|
+
# those recipes that have this version identifier.
|
1565
|
+
#
|
1566
|
+
# @return [Types::ListRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1567
|
+
#
|
1568
|
+
# * {Types::ListRecipesResponse#recipes #recipes} => Array<Types::Recipe>
|
1569
|
+
# * {Types::ListRecipesResponse#next_token #next_token} => String
|
1570
|
+
#
|
1571
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1572
|
+
#
|
1573
|
+
# @example Request syntax with placeholder values
|
1574
|
+
#
|
1575
|
+
# resp = client.list_recipes({
|
1576
|
+
# max_results: 1,
|
1577
|
+
# next_token: "NextToken",
|
1578
|
+
# recipe_version: "RecipeVersion",
|
1579
|
+
# })
|
1580
|
+
#
|
1581
|
+
# @example Response structure
|
1582
|
+
#
|
1583
|
+
# resp.recipes #=> Array
|
1584
|
+
# resp.recipes[0].created_by #=> String
|
1585
|
+
# resp.recipes[0].create_date #=> Time
|
1586
|
+
# resp.recipes[0].last_modified_by #=> String
|
1587
|
+
# resp.recipes[0].last_modified_date #=> Time
|
1588
|
+
# resp.recipes[0].project_name #=> String
|
1589
|
+
# resp.recipes[0].published_by #=> String
|
1590
|
+
# resp.recipes[0].published_date #=> Time
|
1591
|
+
# resp.recipes[0].description #=> String
|
1592
|
+
# resp.recipes[0].name #=> String
|
1593
|
+
# resp.recipes[0].resource_arn #=> String
|
1594
|
+
# resp.recipes[0].steps #=> Array
|
1595
|
+
# resp.recipes[0].steps[0].action.operation #=> String
|
1596
|
+
# resp.recipes[0].steps[0].action.parameters #=> Hash
|
1597
|
+
# resp.recipes[0].steps[0].action.parameters["ParameterName"] #=> String
|
1598
|
+
# resp.recipes[0].steps[0].condition_expressions #=> Array
|
1599
|
+
# resp.recipes[0].steps[0].condition_expressions[0].condition #=> String
|
1600
|
+
# resp.recipes[0].steps[0].condition_expressions[0].value #=> String
|
1601
|
+
# resp.recipes[0].steps[0].condition_expressions[0].target_column #=> String
|
1602
|
+
# resp.recipes[0].tags #=> Hash
|
1603
|
+
# resp.recipes[0].tags["TagKey"] #=> String
|
1604
|
+
# resp.recipes[0].recipe_version #=> String
|
1605
|
+
# resp.next_token #=> String
|
1606
|
+
#
|
1607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRecipes AWS API Documentation
|
1608
|
+
#
|
1609
|
+
# @overload list_recipes(params = {})
|
1610
|
+
# @param [Hash] params ({})
|
1611
|
+
def list_recipes(params = {}, options = {})
|
1612
|
+
req = build_request(:list_recipes, params)
|
1613
|
+
req.send_request(options)
|
1614
|
+
end
|
1615
|
+
|
1616
|
+
# Lists the AWS Glue DataBrew schedules in the current AWS account.
|
1617
|
+
#
|
1618
|
+
# @option params [String] :job_name
|
1619
|
+
# The name of the job that these schedules apply to.
|
1620
|
+
#
|
1621
|
+
# @option params [Integer] :max_results
|
1622
|
+
# The maximum number of results to return in this request.
|
1623
|
+
#
|
1624
|
+
# @option params [String] :next_token
|
1625
|
+
# A pagination token that can be used in a subsequent request.
|
1626
|
+
#
|
1627
|
+
# @return [Types::ListSchedulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1628
|
+
#
|
1629
|
+
# * {Types::ListSchedulesResponse#schedules #schedules} => Array<Types::Schedule>
|
1630
|
+
# * {Types::ListSchedulesResponse#next_token #next_token} => String
|
1631
|
+
#
|
1632
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1633
|
+
#
|
1634
|
+
# @example Request syntax with placeholder values
|
1635
|
+
#
|
1636
|
+
# resp = client.list_schedules({
|
1637
|
+
# job_name: "JobName",
|
1638
|
+
# max_results: 1,
|
1639
|
+
# next_token: "NextToken",
|
1640
|
+
# })
|
1641
|
+
#
|
1642
|
+
# @example Response structure
|
1643
|
+
#
|
1644
|
+
# resp.schedules #=> Array
|
1645
|
+
# resp.schedules[0].account_id #=> String
|
1646
|
+
# resp.schedules[0].created_by #=> String
|
1647
|
+
# resp.schedules[0].create_date #=> Time
|
1648
|
+
# resp.schedules[0].job_names #=> Array
|
1649
|
+
# resp.schedules[0].job_names[0] #=> String
|
1650
|
+
# resp.schedules[0].last_modified_by #=> String
|
1651
|
+
# resp.schedules[0].last_modified_date #=> Time
|
1652
|
+
# resp.schedules[0].resource_arn #=> String
|
1653
|
+
# resp.schedules[0].cron_expression #=> String
|
1654
|
+
# resp.schedules[0].tags #=> Hash
|
1655
|
+
# resp.schedules[0].tags["TagKey"] #=> String
|
1656
|
+
# resp.schedules[0].name #=> String
|
1657
|
+
# resp.next_token #=> String
|
1658
|
+
#
|
1659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListSchedules AWS API Documentation
|
1660
|
+
#
|
1661
|
+
# @overload list_schedules(params = {})
|
1662
|
+
# @param [Hash] params ({})
|
1663
|
+
def list_schedules(params = {}, options = {})
|
1664
|
+
req = build_request(:list_schedules, params)
|
1665
|
+
req.send_request(options)
|
1666
|
+
end
|
1667
|
+
|
1668
|
+
# Lists all the tags for an AWS Glue DataBrew resource.
|
1669
|
+
#
|
1670
|
+
# @option params [required, String] :resource_arn
|
1671
|
+
# The Amazon Resource Name (ARN) string that uniquely identifies the
|
1672
|
+
# DataBrew resource.
|
1673
|
+
#
|
1674
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1675
|
+
#
|
1676
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
1677
|
+
#
|
1678
|
+
# @example Request syntax with placeholder values
|
1679
|
+
#
|
1680
|
+
# resp = client.list_tags_for_resource({
|
1681
|
+
# resource_arn: "Arn", # required
|
1682
|
+
# })
|
1683
|
+
#
|
1684
|
+
# @example Response structure
|
1685
|
+
#
|
1686
|
+
# resp.tags #=> Hash
|
1687
|
+
# resp.tags["TagKey"] #=> String
|
1688
|
+
#
|
1689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListTagsForResource AWS API Documentation
|
1690
|
+
#
|
1691
|
+
# @overload list_tags_for_resource(params = {})
|
1692
|
+
# @param [Hash] params ({})
|
1693
|
+
def list_tags_for_resource(params = {}, options = {})
|
1694
|
+
req = build_request(:list_tags_for_resource, params)
|
1695
|
+
req.send_request(options)
|
1696
|
+
end
|
1697
|
+
|
1698
|
+
# Publishes a new major version of an AWS Glue DataBrew recipe that
|
1699
|
+
# exists in the current AWS account.
|
1700
|
+
#
|
1701
|
+
# @option params [String] :description
|
1702
|
+
# A description of the recipe to be published, for this version of the
|
1703
|
+
# recipe.
|
1704
|
+
#
|
1705
|
+
# @option params [required, String] :name
|
1706
|
+
# The name of the recipe to be published.
|
1707
|
+
#
|
1708
|
+
# @return [Types::PublishRecipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1709
|
+
#
|
1710
|
+
# * {Types::PublishRecipeResponse#name #name} => String
|
1711
|
+
#
|
1712
|
+
# @example Request syntax with placeholder values
|
1713
|
+
#
|
1714
|
+
# resp = client.publish_recipe({
|
1715
|
+
# description: "RecipeDescription",
|
1716
|
+
# name: "RecipeName", # required
|
1717
|
+
# })
|
1718
|
+
#
|
1719
|
+
# @example Response structure
|
1720
|
+
#
|
1721
|
+
# resp.name #=> String
|
1722
|
+
#
|
1723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/PublishRecipe AWS API Documentation
|
1724
|
+
#
|
1725
|
+
# @overload publish_recipe(params = {})
|
1726
|
+
# @param [Hash] params ({})
|
1727
|
+
def publish_recipe(params = {}, options = {})
|
1728
|
+
req = build_request(:publish_recipe, params)
|
1729
|
+
req.send_request(options)
|
1730
|
+
end
|
1731
|
+
|
1732
|
+
# Performs a recipe step within an interactive AWS Glue DataBrew session
|
1733
|
+
# that's currently open.
|
1734
|
+
#
|
1735
|
+
# @option params [Boolean] :preview
|
1736
|
+
# Returns the result of the recipe step, without applying it. The result
|
1737
|
+
# isn't added to the view frame stack.
|
1738
|
+
#
|
1739
|
+
# @option params [required, String] :name
|
1740
|
+
# The name of the project to apply the action to.
|
1741
|
+
#
|
1742
|
+
# @option params [Types::RecipeStep] :recipe_step
|
1743
|
+
# Represents a single step to be performed in an AWS Glue DataBrew
|
1744
|
+
# recipe.
|
1745
|
+
#
|
1746
|
+
# @option params [Integer] :step_index
|
1747
|
+
# The index from which to preview a step. This index is used to preview
|
1748
|
+
# the result of steps that have already been applied, so that the
|
1749
|
+
# resulting view frame is from earlier in the view frame stack.
|
1750
|
+
#
|
1751
|
+
# @option params [String] :client_session_id
|
1752
|
+
# A unique identifier for an interactive session that's currently open
|
1753
|
+
# and ready for work. The action will be performed on this session.
|
1754
|
+
#
|
1755
|
+
# @option params [Types::ViewFrame] :view_frame
|
1756
|
+
# Represents the data being being transformed during an AWS Glue
|
1757
|
+
# DataBrew project session.
|
1758
|
+
#
|
1759
|
+
# @return [Types::SendProjectSessionActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1760
|
+
#
|
1761
|
+
# * {Types::SendProjectSessionActionResponse#result #result} => String
|
1762
|
+
# * {Types::SendProjectSessionActionResponse#name #name} => String
|
1763
|
+
# * {Types::SendProjectSessionActionResponse#action_id #action_id} => Integer
|
1764
|
+
#
|
1765
|
+
# @example Request syntax with placeholder values
|
1766
|
+
#
|
1767
|
+
# resp = client.send_project_session_action({
|
1768
|
+
# preview: false,
|
1769
|
+
# name: "ProjectName", # required
|
1770
|
+
# recipe_step: {
|
1771
|
+
# action: { # required
|
1772
|
+
# operation: "Operation", # required
|
1773
|
+
# parameters: {
|
1774
|
+
# "ParameterName" => "ParameterValue",
|
1775
|
+
# },
|
1776
|
+
# },
|
1777
|
+
# condition_expressions: [
|
1778
|
+
# {
|
1779
|
+
# condition: "Condition", # required
|
1780
|
+
# value: "ConditionValue",
|
1781
|
+
# target_column: "TargetColumn", # required
|
1782
|
+
# },
|
1783
|
+
# ],
|
1784
|
+
# },
|
1785
|
+
# step_index: 1,
|
1786
|
+
# client_session_id: "ClientSessionId",
|
1787
|
+
# view_frame: {
|
1788
|
+
# start_column_index: 1, # required
|
1789
|
+
# column_range: 1,
|
1790
|
+
# hidden_columns: ["ColumnName"],
|
1791
|
+
# },
|
1792
|
+
# })
|
1793
|
+
#
|
1794
|
+
# @example Response structure
|
1795
|
+
#
|
1796
|
+
# resp.result #=> String
|
1797
|
+
# resp.name #=> String
|
1798
|
+
# resp.action_id #=> Integer
|
1799
|
+
#
|
1800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/SendProjectSessionAction AWS API Documentation
|
1801
|
+
#
|
1802
|
+
# @overload send_project_session_action(params = {})
|
1803
|
+
# @param [Hash] params ({})
|
1804
|
+
def send_project_session_action(params = {}, options = {})
|
1805
|
+
req = build_request(:send_project_session_action, params)
|
1806
|
+
req.send_request(options)
|
1807
|
+
end
|
1808
|
+
|
1809
|
+
# Runs an AWS Glue DataBrew job that exists in the current AWS account.
|
1810
|
+
#
|
1811
|
+
# @option params [required, String] :name
|
1812
|
+
# The name of the job to be run.
|
1813
|
+
#
|
1814
|
+
# @return [Types::StartJobRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1815
|
+
#
|
1816
|
+
# * {Types::StartJobRunResponse#run_id #run_id} => String
|
1817
|
+
#
|
1818
|
+
# @example Request syntax with placeholder values
|
1819
|
+
#
|
1820
|
+
# resp = client.start_job_run({
|
1821
|
+
# name: "JobName", # required
|
1822
|
+
# })
|
1823
|
+
#
|
1824
|
+
# @example Response structure
|
1825
|
+
#
|
1826
|
+
# resp.run_id #=> String
|
1827
|
+
#
|
1828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/StartJobRun AWS API Documentation
|
1829
|
+
#
|
1830
|
+
# @overload start_job_run(params = {})
|
1831
|
+
# @param [Hash] params ({})
|
1832
|
+
def start_job_run(params = {}, options = {})
|
1833
|
+
req = build_request(:start_job_run, params)
|
1834
|
+
req.send_request(options)
|
1835
|
+
end
|
1836
|
+
|
1837
|
+
# Creates an interactive session, enabling you to manipulate an AWS Glue
|
1838
|
+
# DataBrew project.
|
1839
|
+
#
|
1840
|
+
# @option params [required, String] :name
|
1841
|
+
# The name of the project to act upon.
|
1842
|
+
#
|
1843
|
+
# @option params [Boolean] :assume_control
|
1844
|
+
# A value that, if true, enables you to take control of a session, even
|
1845
|
+
# if a different client is currently accessing the project.
|
1846
|
+
#
|
1847
|
+
# @return [Types::StartProjectSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1848
|
+
#
|
1849
|
+
# * {Types::StartProjectSessionResponse#name #name} => String
|
1850
|
+
# * {Types::StartProjectSessionResponse#client_session_id #client_session_id} => String
|
1851
|
+
#
|
1852
|
+
# @example Request syntax with placeholder values
|
1853
|
+
#
|
1854
|
+
# resp = client.start_project_session({
|
1855
|
+
# name: "ProjectName", # required
|
1856
|
+
# assume_control: false,
|
1857
|
+
# })
|
1858
|
+
#
|
1859
|
+
# @example Response structure
|
1860
|
+
#
|
1861
|
+
# resp.name #=> String
|
1862
|
+
# resp.client_session_id #=> String
|
1863
|
+
#
|
1864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/StartProjectSession AWS API Documentation
|
1865
|
+
#
|
1866
|
+
# @overload start_project_session(params = {})
|
1867
|
+
# @param [Hash] params ({})
|
1868
|
+
def start_project_session(params = {}, options = {})
|
1869
|
+
req = build_request(:start_project_session, params)
|
1870
|
+
req.send_request(options)
|
1871
|
+
end
|
1872
|
+
|
1873
|
+
# Stops the specified job from running in the current AWS account.
|
1874
|
+
#
|
1875
|
+
# @option params [required, String] :name
|
1876
|
+
# The name of the job to be stopped.
|
1877
|
+
#
|
1878
|
+
# @option params [required, String] :run_id
|
1879
|
+
# The ID of the job run to be stopped.
|
1880
|
+
#
|
1881
|
+
# @return [Types::StopJobRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1882
|
+
#
|
1883
|
+
# * {Types::StopJobRunResponse#run_id #run_id} => String
|
1884
|
+
#
|
1885
|
+
# @example Request syntax with placeholder values
|
1886
|
+
#
|
1887
|
+
# resp = client.stop_job_run({
|
1888
|
+
# name: "JobName", # required
|
1889
|
+
# run_id: "JobRunId", # required
|
1890
|
+
# })
|
1891
|
+
#
|
1892
|
+
# @example Response structure
|
1893
|
+
#
|
1894
|
+
# resp.run_id #=> String
|
1895
|
+
#
|
1896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/StopJobRun AWS API Documentation
|
1897
|
+
#
|
1898
|
+
# @overload stop_job_run(params = {})
|
1899
|
+
# @param [Hash] params ({})
|
1900
|
+
def stop_job_run(params = {}, options = {})
|
1901
|
+
req = build_request(:stop_job_run, params)
|
1902
|
+
req.send_request(options)
|
1903
|
+
end
|
1904
|
+
|
1905
|
+
# Adds metadata tags to an AWS Glue DataBrew resource, such as a
|
1906
|
+
# dataset, job, project, or recipe.
|
1907
|
+
#
|
1908
|
+
# @option params [required, String] :resource_arn
|
1909
|
+
# The DataBrew resource to which tags should be added. The value for
|
1910
|
+
# this parameter is an Amazon Resource Name (ARN). For DataBrew, you can
|
1911
|
+
# tag a dataset, a job, a project, or a recipe.
|
1912
|
+
#
|
1913
|
+
# @option params [required, Hash<String,String>] :tags
|
1914
|
+
# One or more tags to be assigned to the resource.
|
1915
|
+
#
|
1916
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1917
|
+
#
|
1918
|
+
# @example Request syntax with placeholder values
|
1919
|
+
#
|
1920
|
+
# resp = client.tag_resource({
|
1921
|
+
# resource_arn: "Arn", # required
|
1922
|
+
# tags: { # required
|
1923
|
+
# "TagKey" => "TagValue",
|
1924
|
+
# },
|
1925
|
+
# })
|
1926
|
+
#
|
1927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/TagResource AWS API Documentation
|
1928
|
+
#
|
1929
|
+
# @overload tag_resource(params = {})
|
1930
|
+
# @param [Hash] params ({})
|
1931
|
+
def tag_resource(params = {}, options = {})
|
1932
|
+
req = build_request(:tag_resource, params)
|
1933
|
+
req.send_request(options)
|
1934
|
+
end
|
1935
|
+
|
1936
|
+
# Removes metadata tags from an AWS Glue DataBrew resource.
|
1937
|
+
#
|
1938
|
+
# @option params [required, String] :resource_arn
|
1939
|
+
# An DataBrew resource from which you want to remove a tag or tags. The
|
1940
|
+
# value for this parameter is an Amazon Resource Name (ARN).
|
1941
|
+
#
|
1942
|
+
# @option params [required, Array<String>] :tag_keys
|
1943
|
+
# The tag keys (names) of one or more tags to be removed.
|
1944
|
+
#
|
1945
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1946
|
+
#
|
1947
|
+
# @example Request syntax with placeholder values
|
1948
|
+
#
|
1949
|
+
# resp = client.untag_resource({
|
1950
|
+
# resource_arn: "Arn", # required
|
1951
|
+
# tag_keys: ["TagKey"], # required
|
1952
|
+
# })
|
1953
|
+
#
|
1954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UntagResource AWS API Documentation
|
1955
|
+
#
|
1956
|
+
# @overload untag_resource(params = {})
|
1957
|
+
# @param [Hash] params ({})
|
1958
|
+
def untag_resource(params = {}, options = {})
|
1959
|
+
req = build_request(:untag_resource, params)
|
1960
|
+
req.send_request(options)
|
1961
|
+
end
|
1962
|
+
|
1963
|
+
# Modifies the definition of an existing AWS Glue DataBrew dataset in
|
1964
|
+
# the current AWS account.
|
1965
|
+
#
|
1966
|
+
# @option params [required, String] :name
|
1967
|
+
# The name of the dataset to be updated.
|
1968
|
+
#
|
1969
|
+
# @option params [Types::FormatOptions] :format_options
|
1970
|
+
# Options that define how Microsoft Excel input is to be interpreted by
|
1971
|
+
# DataBrew.
|
1972
|
+
#
|
1973
|
+
# @option params [required, Types::Input] :input
|
1974
|
+
# Information on how AWS Glue DataBrew can find data, in either the AWS
|
1975
|
+
# Glue Data Catalog or Amazon S3.
|
1976
|
+
#
|
1977
|
+
# @return [Types::UpdateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1978
|
+
#
|
1979
|
+
# * {Types::UpdateDatasetResponse#name #name} => String
|
1980
|
+
#
|
1981
|
+
# @example Request syntax with placeholder values
|
1982
|
+
#
|
1983
|
+
# resp = client.update_dataset({
|
1984
|
+
# name: "DatasetName", # required
|
1985
|
+
# format_options: {
|
1986
|
+
# json: {
|
1987
|
+
# multi_line: false,
|
1988
|
+
# },
|
1989
|
+
# excel: {
|
1990
|
+
# sheet_names: ["SheetName"],
|
1991
|
+
# sheet_indexes: [1],
|
1992
|
+
# },
|
1993
|
+
# },
|
1994
|
+
# input: { # required
|
1995
|
+
# s3_input_definition: {
|
1996
|
+
# bucket: "Bucket", # required
|
1997
|
+
# key: "Key",
|
1998
|
+
# },
|
1999
|
+
# data_catalog_input_definition: {
|
2000
|
+
# catalog_id: "CatalogId",
|
2001
|
+
# database_name: "DatabaseName", # required
|
2002
|
+
# table_name: "TableName", # required
|
2003
|
+
# temp_directory: {
|
2004
|
+
# bucket: "Bucket", # required
|
2005
|
+
# key: "Key",
|
2006
|
+
# },
|
2007
|
+
# },
|
2008
|
+
# },
|
2009
|
+
# })
|
2010
|
+
#
|
2011
|
+
# @example Response structure
|
2012
|
+
#
|
2013
|
+
# resp.name #=> String
|
2014
|
+
#
|
2015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateDataset AWS API Documentation
|
2016
|
+
#
|
2017
|
+
# @overload update_dataset(params = {})
|
2018
|
+
# @param [Hash] params ({})
|
2019
|
+
def update_dataset(params = {}, options = {})
|
2020
|
+
req = build_request(:update_dataset, params)
|
2021
|
+
req.send_request(options)
|
2022
|
+
end
|
2023
|
+
|
2024
|
+
# Modifies the definition of an existing AWS Glue DataBrew job in the
|
2025
|
+
# current AWS account.
|
2026
|
+
#
|
2027
|
+
# @option params [String] :encryption_key_arn
|
2028
|
+
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
2029
|
+
# protect the job.
|
2030
|
+
#
|
2031
|
+
# @option params [String] :encryption_mode
|
2032
|
+
# The encryption mode for the job, which can be one of the following:
|
2033
|
+
#
|
2034
|
+
# * `SSE-KMS` - Server-side encryption with AWS KMS-managed keys.
|
2035
|
+
#
|
2036
|
+
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
2037
|
+
#
|
2038
|
+
# @option params [required, String] :name
|
2039
|
+
# The name of the job to be updated.
|
2040
|
+
#
|
2041
|
+
# @option params [String] :log_subscription
|
2042
|
+
# A value that enables or disables Amazon CloudWatch logging for the
|
2043
|
+
# current AWS account. If logging is enabled, CloudWatch writes one log
|
2044
|
+
# stream for each job run.
|
2045
|
+
#
|
2046
|
+
# @option params [Integer] :max_capacity
|
2047
|
+
# The maximum number of nodes that DataBrew can use when the job
|
2048
|
+
# processes data.
|
2049
|
+
#
|
2050
|
+
# @option params [Integer] :max_retries
|
2051
|
+
# The maximum number of times to retry the job after a job run fails.
|
2052
|
+
#
|
2053
|
+
# @option params [required, Types::S3Location] :output_location
|
2054
|
+
# An Amazon S3 location (bucket name an object key) where DataBrew can
|
2055
|
+
# read input data, or write output from a job.
|
2056
|
+
#
|
2057
|
+
# @option params [required, String] :role_arn
|
2058
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
2059
|
+
# Management (IAM) role to be assumed for this request.
|
2060
|
+
#
|
2061
|
+
# @option params [Integer] :timeout
|
2062
|
+
# The job's timeout in minutes. A job that attempts to run longer than
|
2063
|
+
# this timeout period ends with a status of `TIMEOUT`.
|
2064
|
+
#
|
2065
|
+
# @return [Types::UpdateProfileJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2066
|
+
#
|
2067
|
+
# * {Types::UpdateProfileJobResponse#name #name} => String
|
2068
|
+
#
|
2069
|
+
# @example Request syntax with placeholder values
|
2070
|
+
#
|
2071
|
+
# resp = client.update_profile_job({
|
2072
|
+
# encryption_key_arn: "EncryptionKeyArn",
|
2073
|
+
# encryption_mode: "SSE-KMS", # accepts SSE-KMS, SSE-S3
|
2074
|
+
# name: "JobName", # required
|
2075
|
+
# log_subscription: "ENABLE", # accepts ENABLE, DISABLE
|
2076
|
+
# max_capacity: 1,
|
2077
|
+
# max_retries: 1,
|
2078
|
+
# output_location: { # required
|
2079
|
+
# bucket: "Bucket", # required
|
2080
|
+
# key: "Key",
|
2081
|
+
# },
|
2082
|
+
# role_arn: "Arn", # required
|
2083
|
+
# timeout: 1,
|
2084
|
+
# })
|
2085
|
+
#
|
2086
|
+
# @example Response structure
|
2087
|
+
#
|
2088
|
+
# resp.name #=> String
|
2089
|
+
#
|
2090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateProfileJob AWS API Documentation
|
2091
|
+
#
|
2092
|
+
# @overload update_profile_job(params = {})
|
2093
|
+
# @param [Hash] params ({})
|
2094
|
+
def update_profile_job(params = {}, options = {})
|
2095
|
+
req = build_request(:update_profile_job, params)
|
2096
|
+
req.send_request(options)
|
2097
|
+
end
|
2098
|
+
|
2099
|
+
# Modifies the definition of an existing AWS Glue DataBrew project in
|
2100
|
+
# the current AWS account.
|
2101
|
+
#
|
2102
|
+
# @option params [Types::Sample] :sample
|
2103
|
+
# Represents the sample size and sampling type for AWS Glue DataBrew to
|
2104
|
+
# use for interactive data analysis.
|
2105
|
+
#
|
2106
|
+
# @option params [required, String] :role_arn
|
2107
|
+
# The Amazon Resource Name (ARN) of the IAM role to be assumed for this
|
2108
|
+
# request.
|
2109
|
+
#
|
2110
|
+
# @option params [required, String] :name
|
2111
|
+
# The name of the project to be updated.
|
2112
|
+
#
|
2113
|
+
# @return [Types::UpdateProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2114
|
+
#
|
2115
|
+
# * {Types::UpdateProjectResponse#last_modified_date #last_modified_date} => Time
|
2116
|
+
# * {Types::UpdateProjectResponse#name #name} => String
|
2117
|
+
#
|
2118
|
+
# @example Request syntax with placeholder values
|
2119
|
+
#
|
2120
|
+
# resp = client.update_project({
|
2121
|
+
# sample: {
|
2122
|
+
# size: 1,
|
2123
|
+
# type: "FIRST_N", # required, accepts FIRST_N, LAST_N, RANDOM
|
2124
|
+
# },
|
2125
|
+
# role_arn: "Arn", # required
|
2126
|
+
# name: "ProjectName", # required
|
2127
|
+
# })
|
2128
|
+
#
|
2129
|
+
# @example Response structure
|
2130
|
+
#
|
2131
|
+
# resp.last_modified_date #=> Time
|
2132
|
+
# resp.name #=> String
|
2133
|
+
#
|
2134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateProject AWS API Documentation
|
2135
|
+
#
|
2136
|
+
# @overload update_project(params = {})
|
2137
|
+
# @param [Hash] params ({})
|
2138
|
+
def update_project(params = {}, options = {})
|
2139
|
+
req = build_request(:update_project, params)
|
2140
|
+
req.send_request(options)
|
2141
|
+
end
|
2142
|
+
|
2143
|
+
# Modifies the definition of the latest working version of an AWS Glue
|
2144
|
+
# DataBrew recipe in the current AWS account.
|
2145
|
+
#
|
2146
|
+
# @option params [String] :description
|
2147
|
+
# A description of the recipe.
|
2148
|
+
#
|
2149
|
+
# @option params [required, String] :name
|
2150
|
+
# The name of the recipe to be updated.
|
2151
|
+
#
|
2152
|
+
# @option params [Array<Types::RecipeStep>] :steps
|
2153
|
+
# One or more steps to be performed by the recipe. Each step consists of
|
2154
|
+
# an action, and the conditions under which the action should succeed.
|
2155
|
+
#
|
2156
|
+
# @return [Types::UpdateRecipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2157
|
+
#
|
2158
|
+
# * {Types::UpdateRecipeResponse#name #name} => String
|
2159
|
+
#
|
2160
|
+
# @example Request syntax with placeholder values
|
2161
|
+
#
|
2162
|
+
# resp = client.update_recipe({
|
2163
|
+
# description: "RecipeDescription",
|
2164
|
+
# name: "RecipeName", # required
|
2165
|
+
# steps: [
|
2166
|
+
# {
|
2167
|
+
# action: { # required
|
2168
|
+
# operation: "Operation", # required
|
2169
|
+
# parameters: {
|
2170
|
+
# "ParameterName" => "ParameterValue",
|
2171
|
+
# },
|
2172
|
+
# },
|
2173
|
+
# condition_expressions: [
|
2174
|
+
# {
|
2175
|
+
# condition: "Condition", # required
|
2176
|
+
# value: "ConditionValue",
|
2177
|
+
# target_column: "TargetColumn", # required
|
2178
|
+
# },
|
2179
|
+
# ],
|
2180
|
+
# },
|
2181
|
+
# ],
|
2182
|
+
# })
|
2183
|
+
#
|
2184
|
+
# @example Response structure
|
2185
|
+
#
|
2186
|
+
# resp.name #=> String
|
2187
|
+
#
|
2188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateRecipe AWS API Documentation
|
2189
|
+
#
|
2190
|
+
# @overload update_recipe(params = {})
|
2191
|
+
# @param [Hash] params ({})
|
2192
|
+
def update_recipe(params = {}, options = {})
|
2193
|
+
req = build_request(:update_recipe, params)
|
2194
|
+
req.send_request(options)
|
2195
|
+
end
|
2196
|
+
|
2197
|
+
# Modifies the definition of an existing AWS Glue DataBrew recipe job in
|
2198
|
+
# the current AWS account.
|
2199
|
+
#
|
2200
|
+
# @option params [String] :encryption_key_arn
|
2201
|
+
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
2202
|
+
# protect the job.
|
2203
|
+
#
|
2204
|
+
# @option params [String] :encryption_mode
|
2205
|
+
# The encryption mode for the job, which can be one of the following:
|
2206
|
+
#
|
2207
|
+
# * `SSE-KMS` - Server-side encryption with AWS KMS-managed keys.
|
2208
|
+
#
|
2209
|
+
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
2210
|
+
#
|
2211
|
+
# @option params [required, String] :name
|
2212
|
+
# The name of the job to update.
|
2213
|
+
#
|
2214
|
+
# @option params [String] :log_subscription
|
2215
|
+
# A value that enables or disables Amazon CloudWatch logging for the
|
2216
|
+
# current AWS account. If logging is enabled, CloudWatch writes one log
|
2217
|
+
# stream for each job run.
|
2218
|
+
#
|
2219
|
+
# @option params [Integer] :max_capacity
|
2220
|
+
# The maximum number of nodes that DataBrew can consume when the job
|
2221
|
+
# processes data.
|
2222
|
+
#
|
2223
|
+
# @option params [Integer] :max_retries
|
2224
|
+
# The maximum number of times to retry the job after a job run fails.
|
2225
|
+
#
|
2226
|
+
# @option params [required, Array<Types::Output>] :outputs
|
2227
|
+
# One or more artifacts that represent the output from running the job.
|
2228
|
+
#
|
2229
|
+
# @option params [required, String] :role_arn
|
2230
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
2231
|
+
# Management (IAM) role to be assumed for this request.
|
2232
|
+
#
|
2233
|
+
# @option params [Integer] :timeout
|
2234
|
+
# The job's timeout in minutes. A job that attempts to run longer than
|
2235
|
+
# this timeout period ends with a status of `TIMEOUT`.
|
2236
|
+
#
|
2237
|
+
# @return [Types::UpdateRecipeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2238
|
+
#
|
2239
|
+
# * {Types::UpdateRecipeJobResponse#name #name} => String
|
2240
|
+
#
|
2241
|
+
# @example Request syntax with placeholder values
|
2242
|
+
#
|
2243
|
+
# resp = client.update_recipe_job({
|
2244
|
+
# encryption_key_arn: "EncryptionKeyArn",
|
2245
|
+
# encryption_mode: "SSE-KMS", # accepts SSE-KMS, SSE-S3
|
2246
|
+
# name: "JobName", # required
|
2247
|
+
# log_subscription: "ENABLE", # accepts ENABLE, DISABLE
|
2248
|
+
# max_capacity: 1,
|
2249
|
+
# max_retries: 1,
|
2250
|
+
# outputs: [ # required
|
2251
|
+
# {
|
2252
|
+
# compression_format: "GZIP", # accepts GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB
|
2253
|
+
# format: "CSV", # accepts CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML
|
2254
|
+
# partition_columns: ["ColumnName"],
|
2255
|
+
# location: { # required
|
2256
|
+
# bucket: "Bucket", # required
|
2257
|
+
# key: "Key",
|
2258
|
+
# },
|
2259
|
+
# overwrite: false,
|
2260
|
+
# },
|
2261
|
+
# ],
|
2262
|
+
# role_arn: "Arn", # required
|
2263
|
+
# timeout: 1,
|
2264
|
+
# })
|
2265
|
+
#
|
2266
|
+
# @example Response structure
|
2267
|
+
#
|
2268
|
+
# resp.name #=> String
|
2269
|
+
#
|
2270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateRecipeJob AWS API Documentation
|
2271
|
+
#
|
2272
|
+
# @overload update_recipe_job(params = {})
|
2273
|
+
# @param [Hash] params ({})
|
2274
|
+
def update_recipe_job(params = {}, options = {})
|
2275
|
+
req = build_request(:update_recipe_job, params)
|
2276
|
+
req.send_request(options)
|
2277
|
+
end
|
2278
|
+
|
2279
|
+
# Modifies the definition of an existing AWS Glue DataBrew schedule in
|
2280
|
+
# the current AWS account.
|
2281
|
+
#
|
2282
|
+
# @option params [Array<String>] :job_names
|
2283
|
+
# The name or names of one or more jobs to be run for this schedule.
|
2284
|
+
#
|
2285
|
+
# @option params [required, String] :cron_expression
|
2286
|
+
# The date or dates and time or times, in `cron` format, when the jobs
|
2287
|
+
# are to be run.
|
2288
|
+
#
|
2289
|
+
# @option params [required, String] :name
|
2290
|
+
# The name of the schedule to update.
|
2291
|
+
#
|
2292
|
+
# @return [Types::UpdateScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2293
|
+
#
|
2294
|
+
# * {Types::UpdateScheduleResponse#name #name} => String
|
2295
|
+
#
|
2296
|
+
# @example Request syntax with placeholder values
|
2297
|
+
#
|
2298
|
+
# resp = client.update_schedule({
|
2299
|
+
# job_names: ["JobName"],
|
2300
|
+
# cron_expression: "CronExpression", # required
|
2301
|
+
# name: "ScheduleName", # required
|
2302
|
+
# })
|
2303
|
+
#
|
2304
|
+
# @example Response structure
|
2305
|
+
#
|
2306
|
+
# resp.name #=> String
|
2307
|
+
#
|
2308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateSchedule AWS API Documentation
|
2309
|
+
#
|
2310
|
+
# @overload update_schedule(params = {})
|
2311
|
+
# @param [Hash] params ({})
|
2312
|
+
def update_schedule(params = {}, options = {})
|
2313
|
+
req = build_request(:update_schedule, params)
|
2314
|
+
req.send_request(options)
|
2315
|
+
end
|
2316
|
+
|
2317
|
+
# @!endgroup
|
2318
|
+
|
2319
|
+
# @param params ({})
|
2320
|
+
# @api private
|
2321
|
+
def build_request(operation_name, params = {})
|
2322
|
+
handlers = @handlers.for(operation_name)
|
2323
|
+
context = Seahorse::Client::RequestContext.new(
|
2324
|
+
operation_name: operation_name,
|
2325
|
+
operation: config.api.operation(operation_name),
|
2326
|
+
client: self,
|
2327
|
+
params: params,
|
2328
|
+
config: config)
|
2329
|
+
context[:gem_name] = 'aws-sdk-gluedatabrew'
|
2330
|
+
context[:gem_version] = '1.0.0'
|
2331
|
+
Seahorse::Client::Request.new(handlers, context)
|
2332
|
+
end
|
2333
|
+
|
2334
|
+
# @api private
|
2335
|
+
# @deprecated
|
2336
|
+
def waiter_names
|
2337
|
+
[]
|
2338
|
+
end
|
2339
|
+
|
2340
|
+
class << self
|
2341
|
+
|
2342
|
+
# @api private
|
2343
|
+
attr_reader :identifier
|
2344
|
+
|
2345
|
+
# @api private
|
2346
|
+
def errors_module
|
2347
|
+
Errors
|
2348
|
+
end
|
2349
|
+
|
2350
|
+
end
|
2351
|
+
end
|
2352
|
+
end
|