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
File without changes
|
@@ -0,0 +1,134 @@
|
|
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
|
+
module Aws::GlueDataBrew
|
11
|
+
|
12
|
+
# When GlueDataBrew returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::GlueDataBrew::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all GlueDataBrew errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::GlueDataBrew::Errors::ServiceError
|
20
|
+
# # rescues all GlueDataBrew API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {AccessDeniedException}
|
31
|
+
# * {ConflictException}
|
32
|
+
# * {InternalServerException}
|
33
|
+
# * {ResourceNotFoundException}
|
34
|
+
# * {ServiceQuotaExceededException}
|
35
|
+
# * {ValidationException}
|
36
|
+
#
|
37
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
38
|
+
# if they are not defined above.
|
39
|
+
module Errors
|
40
|
+
|
41
|
+
extend Aws::Errors::DynamicErrors
|
42
|
+
|
43
|
+
class AccessDeniedException < ServiceError
|
44
|
+
|
45
|
+
# @param [Seahorse::Client::RequestContext] context
|
46
|
+
# @param [String] message
|
47
|
+
# @param [Aws::GlueDataBrew::Types::AccessDeniedException] data
|
48
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
49
|
+
super(context, message, data)
|
50
|
+
end
|
51
|
+
|
52
|
+
# @return [String]
|
53
|
+
def message
|
54
|
+
@message || @data[:message]
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
class ConflictException < ServiceError
|
59
|
+
|
60
|
+
# @param [Seahorse::Client::RequestContext] context
|
61
|
+
# @param [String] message
|
62
|
+
# @param [Aws::GlueDataBrew::Types::ConflictException] data
|
63
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
64
|
+
super(context, message, data)
|
65
|
+
end
|
66
|
+
|
67
|
+
# @return [String]
|
68
|
+
def message
|
69
|
+
@message || @data[:message]
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
class InternalServerException < ServiceError
|
74
|
+
|
75
|
+
# @param [Seahorse::Client::RequestContext] context
|
76
|
+
# @param [String] message
|
77
|
+
# @param [Aws::GlueDataBrew::Types::InternalServerException] data
|
78
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
79
|
+
super(context, message, data)
|
80
|
+
end
|
81
|
+
|
82
|
+
# @return [String]
|
83
|
+
def message
|
84
|
+
@message || @data[:message]
|
85
|
+
end
|
86
|
+
end
|
87
|
+
|
88
|
+
class ResourceNotFoundException < ServiceError
|
89
|
+
|
90
|
+
# @param [Seahorse::Client::RequestContext] context
|
91
|
+
# @param [String] message
|
92
|
+
# @param [Aws::GlueDataBrew::Types::ResourceNotFoundException] data
|
93
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
94
|
+
super(context, message, data)
|
95
|
+
end
|
96
|
+
|
97
|
+
# @return [String]
|
98
|
+
def message
|
99
|
+
@message || @data[:message]
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
class ServiceQuotaExceededException < ServiceError
|
104
|
+
|
105
|
+
# @param [Seahorse::Client::RequestContext] context
|
106
|
+
# @param [String] message
|
107
|
+
# @param [Aws::GlueDataBrew::Types::ServiceQuotaExceededException] data
|
108
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
109
|
+
super(context, message, data)
|
110
|
+
end
|
111
|
+
|
112
|
+
# @return [String]
|
113
|
+
def message
|
114
|
+
@message || @data[:message]
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
class ValidationException < ServiceError
|
119
|
+
|
120
|
+
# @param [Seahorse::Client::RequestContext] context
|
121
|
+
# @param [String] message
|
122
|
+
# @param [Aws::GlueDataBrew::Types::ValidationException] data
|
123
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
124
|
+
super(context, message, data)
|
125
|
+
end
|
126
|
+
|
127
|
+
# @return [String]
|
128
|
+
def message
|
129
|
+
@message || @data[:message]
|
130
|
+
end
|
131
|
+
end
|
132
|
+
|
133
|
+
end
|
134
|
+
end
|
@@ -0,0 +1,26 @@
|
|
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
|
+
module Aws::GlueDataBrew
|
11
|
+
|
12
|
+
class Resource
|
13
|
+
|
14
|
+
# @param options ({})
|
15
|
+
# @option options [Client] :client
|
16
|
+
def initialize(options = {})
|
17
|
+
@client = options[:client] || Client.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
# @return [Client]
|
21
|
+
def client
|
22
|
+
@client
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,3418 @@
|
|
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
|
+
module Aws::GlueDataBrew
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# Access to the specified resource was denied.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# @note When making an API call, you may pass BatchDeleteRecipeVersionRequest
|
27
|
+
# data as a hash:
|
28
|
+
#
|
29
|
+
# {
|
30
|
+
# name: "RecipeName", # required
|
31
|
+
# recipe_versions: ["RecipeVersion"], # required
|
32
|
+
# }
|
33
|
+
#
|
34
|
+
# @!attribute [rw] name
|
35
|
+
# The name of the recipe to be modified.
|
36
|
+
# @return [String]
|
37
|
+
#
|
38
|
+
# @!attribute [rw] recipe_versions
|
39
|
+
# An array of version identifiers to be deleted.
|
40
|
+
# @return [Array<String>]
|
41
|
+
#
|
42
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/BatchDeleteRecipeVersionRequest AWS API Documentation
|
43
|
+
#
|
44
|
+
class BatchDeleteRecipeVersionRequest < Struct.new(
|
45
|
+
:name,
|
46
|
+
:recipe_versions)
|
47
|
+
SENSITIVE = []
|
48
|
+
include Aws::Structure
|
49
|
+
end
|
50
|
+
|
51
|
+
# @!attribute [rw] name
|
52
|
+
# The name of the recipe that was modified.
|
53
|
+
# @return [String]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] errors
|
56
|
+
# Errors, if any, that were encountered when deleting the recipe
|
57
|
+
# versions.
|
58
|
+
# @return [Array<Types::RecipeVersionErrorDetail>]
|
59
|
+
#
|
60
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/BatchDeleteRecipeVersionResponse AWS API Documentation
|
61
|
+
#
|
62
|
+
class BatchDeleteRecipeVersionResponse < Struct.new(
|
63
|
+
:name,
|
64
|
+
:errors)
|
65
|
+
SENSITIVE = []
|
66
|
+
include Aws::Structure
|
67
|
+
end
|
68
|
+
|
69
|
+
# Represents an individual condition that evaluates to true or false.
|
70
|
+
#
|
71
|
+
# Conditions are used with recipe actions: The action is only performed
|
72
|
+
# for column values where the condition evaluates to true.
|
73
|
+
#
|
74
|
+
# If a recipe requires more than one condition, then the recipe must
|
75
|
+
# specify multiple `ConditionExpression` elements. Each condition is
|
76
|
+
# applied to the rows in a dataset first, before the recipe action is
|
77
|
+
# performed.
|
78
|
+
#
|
79
|
+
# @note When making an API call, you may pass ConditionExpression
|
80
|
+
# data as a hash:
|
81
|
+
#
|
82
|
+
# {
|
83
|
+
# condition: "Condition", # required
|
84
|
+
# value: "ConditionValue",
|
85
|
+
# target_column: "TargetColumn", # required
|
86
|
+
# }
|
87
|
+
#
|
88
|
+
# @!attribute [rw] condition
|
89
|
+
# A specific condition to apply to a recipe action. For more
|
90
|
+
# information, see [Recipe structure][1] in the *AWS Glue DataBrew
|
91
|
+
# Developer Guide*.
|
92
|
+
#
|
93
|
+
#
|
94
|
+
#
|
95
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html
|
96
|
+
# @return [String]
|
97
|
+
#
|
98
|
+
# @!attribute [rw] value
|
99
|
+
# A value that the condition must evaluate to for the condition to
|
100
|
+
# succeed.
|
101
|
+
# @return [String]
|
102
|
+
#
|
103
|
+
# @!attribute [rw] target_column
|
104
|
+
# A column to apply this condition to, within an AWS Glue DataBrew
|
105
|
+
# dataset.
|
106
|
+
# @return [String]
|
107
|
+
#
|
108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ConditionExpression AWS API Documentation
|
109
|
+
#
|
110
|
+
class ConditionExpression < Struct.new(
|
111
|
+
:condition,
|
112
|
+
:value,
|
113
|
+
:target_column)
|
114
|
+
SENSITIVE = []
|
115
|
+
include Aws::Structure
|
116
|
+
end
|
117
|
+
|
118
|
+
# Updating or deleting a resource can cause an inconsistent state.
|
119
|
+
#
|
120
|
+
# @!attribute [rw] message
|
121
|
+
# @return [String]
|
122
|
+
#
|
123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ConflictException AWS API Documentation
|
124
|
+
#
|
125
|
+
class ConflictException < Struct.new(
|
126
|
+
:message)
|
127
|
+
SENSITIVE = []
|
128
|
+
include Aws::Structure
|
129
|
+
end
|
130
|
+
|
131
|
+
# @note When making an API call, you may pass CreateDatasetRequest
|
132
|
+
# data as a hash:
|
133
|
+
#
|
134
|
+
# {
|
135
|
+
# name: "DatasetName", # required
|
136
|
+
# format_options: {
|
137
|
+
# json: {
|
138
|
+
# multi_line: false,
|
139
|
+
# },
|
140
|
+
# excel: {
|
141
|
+
# sheet_names: ["SheetName"],
|
142
|
+
# sheet_indexes: [1],
|
143
|
+
# },
|
144
|
+
# },
|
145
|
+
# input: { # required
|
146
|
+
# s3_input_definition: {
|
147
|
+
# bucket: "Bucket", # required
|
148
|
+
# key: "Key",
|
149
|
+
# },
|
150
|
+
# data_catalog_input_definition: {
|
151
|
+
# catalog_id: "CatalogId",
|
152
|
+
# database_name: "DatabaseName", # required
|
153
|
+
# table_name: "TableName", # required
|
154
|
+
# temp_directory: {
|
155
|
+
# bucket: "Bucket", # required
|
156
|
+
# key: "Key",
|
157
|
+
# },
|
158
|
+
# },
|
159
|
+
# },
|
160
|
+
# tags: {
|
161
|
+
# "TagKey" => "TagValue",
|
162
|
+
# },
|
163
|
+
# }
|
164
|
+
#
|
165
|
+
# @!attribute [rw] name
|
166
|
+
# The name of the dataset to be created.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] format_options
|
170
|
+
# Options that define how Microsoft Excel input is to be interpreted
|
171
|
+
# by DataBrew.
|
172
|
+
# @return [Types::FormatOptions]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] input
|
175
|
+
# Information on how AWS Glue DataBrew can find data, in either the
|
176
|
+
# AWS Glue Data Catalog or Amazon S3.
|
177
|
+
# @return [Types::Input]
|
178
|
+
#
|
179
|
+
# @!attribute [rw] tags
|
180
|
+
# Metadata tags to apply to this dataset.
|
181
|
+
# @return [Hash<String,String>]
|
182
|
+
#
|
183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateDatasetRequest AWS API Documentation
|
184
|
+
#
|
185
|
+
class CreateDatasetRequest < Struct.new(
|
186
|
+
:name,
|
187
|
+
:format_options,
|
188
|
+
:input,
|
189
|
+
:tags)
|
190
|
+
SENSITIVE = []
|
191
|
+
include Aws::Structure
|
192
|
+
end
|
193
|
+
|
194
|
+
# @!attribute [rw] name
|
195
|
+
# The name of the dataset that you created.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateDatasetResponse AWS API Documentation
|
199
|
+
#
|
200
|
+
class CreateDatasetResponse < Struct.new(
|
201
|
+
:name)
|
202
|
+
SENSITIVE = []
|
203
|
+
include Aws::Structure
|
204
|
+
end
|
205
|
+
|
206
|
+
# @note When making an API call, you may pass CreateProfileJobRequest
|
207
|
+
# data as a hash:
|
208
|
+
#
|
209
|
+
# {
|
210
|
+
# dataset_name: "DatasetName", # required
|
211
|
+
# encryption_key_arn: "EncryptionKeyArn",
|
212
|
+
# encryption_mode: "SSE-KMS", # accepts SSE-KMS, SSE-S3
|
213
|
+
# name: "JobName", # required
|
214
|
+
# log_subscription: "ENABLE", # accepts ENABLE, DISABLE
|
215
|
+
# max_capacity: 1,
|
216
|
+
# max_retries: 1,
|
217
|
+
# output_location: { # required
|
218
|
+
# bucket: "Bucket", # required
|
219
|
+
# key: "Key",
|
220
|
+
# },
|
221
|
+
# role_arn: "Arn", # required
|
222
|
+
# tags: {
|
223
|
+
# "TagKey" => "TagValue",
|
224
|
+
# },
|
225
|
+
# timeout: 1,
|
226
|
+
# }
|
227
|
+
#
|
228
|
+
# @!attribute [rw] dataset_name
|
229
|
+
# The name of the dataset that this job is to act upon.
|
230
|
+
# @return [String]
|
231
|
+
#
|
232
|
+
# @!attribute [rw] encryption_key_arn
|
233
|
+
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
234
|
+
# protect the job.
|
235
|
+
# @return [String]
|
236
|
+
#
|
237
|
+
# @!attribute [rw] encryption_mode
|
238
|
+
# The encryption mode for the job, which can be one of the following:
|
239
|
+
#
|
240
|
+
# * `SSE-KMS` - para>`SSE-KMS` - server-side encryption with AWS
|
241
|
+
# KMS-managed keys.
|
242
|
+
#
|
243
|
+
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
244
|
+
# @return [String]
|
245
|
+
#
|
246
|
+
# @!attribute [rw] name
|
247
|
+
# The name of the job to be created.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] log_subscription
|
251
|
+
# A value that enables or disables Amazon CloudWatch logging for the
|
252
|
+
# current AWS account. If logging is enabled, CloudWatch writes one
|
253
|
+
# log stream for each job run.
|
254
|
+
# @return [String]
|
255
|
+
#
|
256
|
+
# @!attribute [rw] max_capacity
|
257
|
+
# The maximum number of nodes that DataBrew can use when the job
|
258
|
+
# processes data.
|
259
|
+
# @return [Integer]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] max_retries
|
262
|
+
# The maximum number of times to retry the job after a job run fails.
|
263
|
+
# @return [Integer]
|
264
|
+
#
|
265
|
+
# @!attribute [rw] output_location
|
266
|
+
# An Amazon S3 location (bucket name an object key) where DataBrew can
|
267
|
+
# read input data, or write output from a job.
|
268
|
+
# @return [Types::S3Location]
|
269
|
+
#
|
270
|
+
# @!attribute [rw] role_arn
|
271
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
272
|
+
# Management (IAM) role to be assumed for this request.
|
273
|
+
# @return [String]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] tags
|
276
|
+
# Metadata tags to apply to this job.
|
277
|
+
# @return [Hash<String,String>]
|
278
|
+
#
|
279
|
+
# @!attribute [rw] timeout
|
280
|
+
# The job's timeout in minutes. A job that attempts to run longer
|
281
|
+
# than this timeout period ends with a status of `TIMEOUT`.
|
282
|
+
# @return [Integer]
|
283
|
+
#
|
284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateProfileJobRequest AWS API Documentation
|
285
|
+
#
|
286
|
+
class CreateProfileJobRequest < Struct.new(
|
287
|
+
:dataset_name,
|
288
|
+
:encryption_key_arn,
|
289
|
+
:encryption_mode,
|
290
|
+
:name,
|
291
|
+
:log_subscription,
|
292
|
+
:max_capacity,
|
293
|
+
:max_retries,
|
294
|
+
:output_location,
|
295
|
+
:role_arn,
|
296
|
+
:tags,
|
297
|
+
:timeout)
|
298
|
+
SENSITIVE = []
|
299
|
+
include Aws::Structure
|
300
|
+
end
|
301
|
+
|
302
|
+
# @!attribute [rw] name
|
303
|
+
# The name of the job that was created.
|
304
|
+
# @return [String]
|
305
|
+
#
|
306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateProfileJobResponse AWS API Documentation
|
307
|
+
#
|
308
|
+
class CreateProfileJobResponse < Struct.new(
|
309
|
+
:name)
|
310
|
+
SENSITIVE = []
|
311
|
+
include Aws::Structure
|
312
|
+
end
|
313
|
+
|
314
|
+
# @note When making an API call, you may pass CreateProjectRequest
|
315
|
+
# data as a hash:
|
316
|
+
#
|
317
|
+
# {
|
318
|
+
# dataset_name: "DatasetName", # required
|
319
|
+
# name: "ProjectName", # required
|
320
|
+
# recipe_name: "RecipeName", # required
|
321
|
+
# sample: {
|
322
|
+
# size: 1,
|
323
|
+
# type: "FIRST_N", # required, accepts FIRST_N, LAST_N, RANDOM
|
324
|
+
# },
|
325
|
+
# role_arn: "Arn", # required
|
326
|
+
# tags: {
|
327
|
+
# "TagKey" => "TagValue",
|
328
|
+
# },
|
329
|
+
# }
|
330
|
+
#
|
331
|
+
# @!attribute [rw] dataset_name
|
332
|
+
# The name of the dataset to associate this project with.
|
333
|
+
# @return [String]
|
334
|
+
#
|
335
|
+
# @!attribute [rw] name
|
336
|
+
# A unique name for the new project.
|
337
|
+
# @return [String]
|
338
|
+
#
|
339
|
+
# @!attribute [rw] recipe_name
|
340
|
+
# The name of an existing recipe to associate with the project.
|
341
|
+
# @return [String]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] sample
|
344
|
+
# Represents the sample size and sampling type for AWS Glue DataBrew
|
345
|
+
# to use for interactive data analysis.
|
346
|
+
# @return [Types::Sample]
|
347
|
+
#
|
348
|
+
# @!attribute [rw] role_arn
|
349
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
350
|
+
# Management (IAM) role to be assumed for this request.
|
351
|
+
# @return [String]
|
352
|
+
#
|
353
|
+
# @!attribute [rw] tags
|
354
|
+
# Metadata tags to apply to this project.
|
355
|
+
# @return [Hash<String,String>]
|
356
|
+
#
|
357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateProjectRequest AWS API Documentation
|
358
|
+
#
|
359
|
+
class CreateProjectRequest < Struct.new(
|
360
|
+
:dataset_name,
|
361
|
+
:name,
|
362
|
+
:recipe_name,
|
363
|
+
:sample,
|
364
|
+
:role_arn,
|
365
|
+
:tags)
|
366
|
+
SENSITIVE = []
|
367
|
+
include Aws::Structure
|
368
|
+
end
|
369
|
+
|
370
|
+
# @!attribute [rw] name
|
371
|
+
# The name of the project that you created.
|
372
|
+
# @return [String]
|
373
|
+
#
|
374
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateProjectResponse AWS API Documentation
|
375
|
+
#
|
376
|
+
class CreateProjectResponse < Struct.new(
|
377
|
+
:name)
|
378
|
+
SENSITIVE = []
|
379
|
+
include Aws::Structure
|
380
|
+
end
|
381
|
+
|
382
|
+
# @note When making an API call, you may pass CreateRecipeJobRequest
|
383
|
+
# data as a hash:
|
384
|
+
#
|
385
|
+
# {
|
386
|
+
# dataset_name: "DatasetName",
|
387
|
+
# encryption_key_arn: "EncryptionKeyArn",
|
388
|
+
# encryption_mode: "SSE-KMS", # accepts SSE-KMS, SSE-S3
|
389
|
+
# name: "JobName", # required
|
390
|
+
# log_subscription: "ENABLE", # accepts ENABLE, DISABLE
|
391
|
+
# max_capacity: 1,
|
392
|
+
# max_retries: 1,
|
393
|
+
# outputs: [ # required
|
394
|
+
# {
|
395
|
+
# compression_format: "GZIP", # accepts GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB
|
396
|
+
# format: "CSV", # accepts CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML
|
397
|
+
# partition_columns: ["ColumnName"],
|
398
|
+
# location: { # required
|
399
|
+
# bucket: "Bucket", # required
|
400
|
+
# key: "Key",
|
401
|
+
# },
|
402
|
+
# overwrite: false,
|
403
|
+
# },
|
404
|
+
# ],
|
405
|
+
# project_name: "ProjectName",
|
406
|
+
# recipe_reference: {
|
407
|
+
# name: "RecipeName", # required
|
408
|
+
# recipe_version: "RecipeVersion",
|
409
|
+
# },
|
410
|
+
# role_arn: "Arn", # required
|
411
|
+
# tags: {
|
412
|
+
# "TagKey" => "TagValue",
|
413
|
+
# },
|
414
|
+
# timeout: 1,
|
415
|
+
# }
|
416
|
+
#
|
417
|
+
# @!attribute [rw] dataset_name
|
418
|
+
# The name of the dataset that this job processes.
|
419
|
+
# @return [String]
|
420
|
+
#
|
421
|
+
# @!attribute [rw] encryption_key_arn
|
422
|
+
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
423
|
+
# protect the job.
|
424
|
+
# @return [String]
|
425
|
+
#
|
426
|
+
# @!attribute [rw] encryption_mode
|
427
|
+
# The encryption mode for the job, which can be one of the following:
|
428
|
+
#
|
429
|
+
# * `SSE-KMS` - Server-side encryption with AWS KMS-managed keys.
|
430
|
+
#
|
431
|
+
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
432
|
+
# @return [String]
|
433
|
+
#
|
434
|
+
# @!attribute [rw] name
|
435
|
+
# A unique name for the job.
|
436
|
+
# @return [String]
|
437
|
+
#
|
438
|
+
# @!attribute [rw] log_subscription
|
439
|
+
# A value that enables or disables Amazon CloudWatch logging for the
|
440
|
+
# current AWS account. If logging is enabled, CloudWatch writes one
|
441
|
+
# log stream for each job run.
|
442
|
+
# @return [String]
|
443
|
+
#
|
444
|
+
# @!attribute [rw] max_capacity
|
445
|
+
# The maximum number of nodes that DataBrew can consume when the job
|
446
|
+
# processes data.
|
447
|
+
# @return [Integer]
|
448
|
+
#
|
449
|
+
# @!attribute [rw] max_retries
|
450
|
+
# The maximum number of times to retry the job after a job run fails.
|
451
|
+
# @return [Integer]
|
452
|
+
#
|
453
|
+
# @!attribute [rw] outputs
|
454
|
+
# One or more artifacts that represent the output from running the
|
455
|
+
# job.
|
456
|
+
# @return [Array<Types::Output>]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] project_name
|
459
|
+
# Either the name of an existing project, or a combination of a recipe
|
460
|
+
# and a dataset to associate with the recipe.
|
461
|
+
# @return [String]
|
462
|
+
#
|
463
|
+
# @!attribute [rw] recipe_reference
|
464
|
+
# Represents all of the attributes of an AWS Glue DataBrew recipe.
|
465
|
+
# @return [Types::RecipeReference]
|
466
|
+
#
|
467
|
+
# @!attribute [rw] role_arn
|
468
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
469
|
+
# Management (IAM) role to be assumed for this request.
|
470
|
+
# @return [String]
|
471
|
+
#
|
472
|
+
# @!attribute [rw] tags
|
473
|
+
# Metadata tags to apply to this job dataset.
|
474
|
+
# @return [Hash<String,String>]
|
475
|
+
#
|
476
|
+
# @!attribute [rw] timeout
|
477
|
+
# The job's timeout in minutes. A job that attempts to run longer
|
478
|
+
# than this timeout period ends with a status of `TIMEOUT`.
|
479
|
+
# @return [Integer]
|
480
|
+
#
|
481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateRecipeJobRequest AWS API Documentation
|
482
|
+
#
|
483
|
+
class CreateRecipeJobRequest < Struct.new(
|
484
|
+
:dataset_name,
|
485
|
+
:encryption_key_arn,
|
486
|
+
:encryption_mode,
|
487
|
+
:name,
|
488
|
+
:log_subscription,
|
489
|
+
:max_capacity,
|
490
|
+
:max_retries,
|
491
|
+
:outputs,
|
492
|
+
:project_name,
|
493
|
+
:recipe_reference,
|
494
|
+
:role_arn,
|
495
|
+
:tags,
|
496
|
+
:timeout)
|
497
|
+
SENSITIVE = []
|
498
|
+
include Aws::Structure
|
499
|
+
end
|
500
|
+
|
501
|
+
# @!attribute [rw] name
|
502
|
+
# The name of the job that you created.
|
503
|
+
# @return [String]
|
504
|
+
#
|
505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateRecipeJobResponse AWS API Documentation
|
506
|
+
#
|
507
|
+
class CreateRecipeJobResponse < Struct.new(
|
508
|
+
:name)
|
509
|
+
SENSITIVE = []
|
510
|
+
include Aws::Structure
|
511
|
+
end
|
512
|
+
|
513
|
+
# @note When making an API call, you may pass CreateRecipeRequest
|
514
|
+
# data as a hash:
|
515
|
+
#
|
516
|
+
# {
|
517
|
+
# description: "RecipeDescription",
|
518
|
+
# name: "RecipeName", # required
|
519
|
+
# steps: [ # required
|
520
|
+
# {
|
521
|
+
# action: { # required
|
522
|
+
# operation: "Operation", # required
|
523
|
+
# parameters: {
|
524
|
+
# "ParameterName" => "ParameterValue",
|
525
|
+
# },
|
526
|
+
# },
|
527
|
+
# condition_expressions: [
|
528
|
+
# {
|
529
|
+
# condition: "Condition", # required
|
530
|
+
# value: "ConditionValue",
|
531
|
+
# target_column: "TargetColumn", # required
|
532
|
+
# },
|
533
|
+
# ],
|
534
|
+
# },
|
535
|
+
# ],
|
536
|
+
# tags: {
|
537
|
+
# "TagKey" => "TagValue",
|
538
|
+
# },
|
539
|
+
# }
|
540
|
+
#
|
541
|
+
# @!attribute [rw] description
|
542
|
+
# A description for the recipe.
|
543
|
+
# @return [String]
|
544
|
+
#
|
545
|
+
# @!attribute [rw] name
|
546
|
+
# A unique name for the recipe.
|
547
|
+
# @return [String]
|
548
|
+
#
|
549
|
+
# @!attribute [rw] steps
|
550
|
+
# An array containing the steps to be performed by the recipe. Each
|
551
|
+
# recipe step consists of one recipe action and (optionally) an array
|
552
|
+
# of condition expressions.
|
553
|
+
# @return [Array<Types::RecipeStep>]
|
554
|
+
#
|
555
|
+
# @!attribute [rw] tags
|
556
|
+
# Metadata tags to apply to this recipe.
|
557
|
+
# @return [Hash<String,String>]
|
558
|
+
#
|
559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateRecipeRequest AWS API Documentation
|
560
|
+
#
|
561
|
+
class CreateRecipeRequest < Struct.new(
|
562
|
+
:description,
|
563
|
+
:name,
|
564
|
+
:steps,
|
565
|
+
:tags)
|
566
|
+
SENSITIVE = []
|
567
|
+
include Aws::Structure
|
568
|
+
end
|
569
|
+
|
570
|
+
# @!attribute [rw] name
|
571
|
+
# The name of the recipe that you created.
|
572
|
+
# @return [String]
|
573
|
+
#
|
574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateRecipeResponse AWS API Documentation
|
575
|
+
#
|
576
|
+
class CreateRecipeResponse < Struct.new(
|
577
|
+
:name)
|
578
|
+
SENSITIVE = []
|
579
|
+
include Aws::Structure
|
580
|
+
end
|
581
|
+
|
582
|
+
# @note When making an API call, you may pass CreateScheduleRequest
|
583
|
+
# data as a hash:
|
584
|
+
#
|
585
|
+
# {
|
586
|
+
# job_names: ["JobName"],
|
587
|
+
# cron_expression: "CronExpression", # required
|
588
|
+
# tags: {
|
589
|
+
# "TagKey" => "TagValue",
|
590
|
+
# },
|
591
|
+
# name: "ScheduleName", # required
|
592
|
+
# }
|
593
|
+
#
|
594
|
+
# @!attribute [rw] job_names
|
595
|
+
# The name or names of one or more jobs to be run.
|
596
|
+
# @return [Array<String>]
|
597
|
+
#
|
598
|
+
# @!attribute [rw] cron_expression
|
599
|
+
# The date or dates and time or times, in `cron` format, when the jobs
|
600
|
+
# are to be run.
|
601
|
+
# @return [String]
|
602
|
+
#
|
603
|
+
# @!attribute [rw] tags
|
604
|
+
# Metadata tags to apply to this schedule.
|
605
|
+
# @return [Hash<String,String>]
|
606
|
+
#
|
607
|
+
# @!attribute [rw] name
|
608
|
+
# A unique name for the schedule.
|
609
|
+
# @return [String]
|
610
|
+
#
|
611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateScheduleRequest AWS API Documentation
|
612
|
+
#
|
613
|
+
class CreateScheduleRequest < Struct.new(
|
614
|
+
:job_names,
|
615
|
+
:cron_expression,
|
616
|
+
:tags,
|
617
|
+
:name)
|
618
|
+
SENSITIVE = []
|
619
|
+
include Aws::Structure
|
620
|
+
end
|
621
|
+
|
622
|
+
# @!attribute [rw] name
|
623
|
+
# The name of the schedule that was created.
|
624
|
+
# @return [String]
|
625
|
+
#
|
626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateScheduleResponse AWS API Documentation
|
627
|
+
#
|
628
|
+
class CreateScheduleResponse < Struct.new(
|
629
|
+
:name)
|
630
|
+
SENSITIVE = []
|
631
|
+
include Aws::Structure
|
632
|
+
end
|
633
|
+
|
634
|
+
# Represents how metadata stored in the AWS Glue Data Catalog is defined
|
635
|
+
# in an AWS Glue DataBrew dataset.
|
636
|
+
#
|
637
|
+
# @note When making an API call, you may pass DataCatalogInputDefinition
|
638
|
+
# data as a hash:
|
639
|
+
#
|
640
|
+
# {
|
641
|
+
# catalog_id: "CatalogId",
|
642
|
+
# database_name: "DatabaseName", # required
|
643
|
+
# table_name: "TableName", # required
|
644
|
+
# temp_directory: {
|
645
|
+
# bucket: "Bucket", # required
|
646
|
+
# key: "Key",
|
647
|
+
# },
|
648
|
+
# }
|
649
|
+
#
|
650
|
+
# @!attribute [rw] catalog_id
|
651
|
+
# The unique identifier of the AWS account that holds the Data Catalog
|
652
|
+
# that stores the data.
|
653
|
+
# @return [String]
|
654
|
+
#
|
655
|
+
# @!attribute [rw] database_name
|
656
|
+
# The name of a database in the Data Catalog.
|
657
|
+
# @return [String]
|
658
|
+
#
|
659
|
+
# @!attribute [rw] table_name
|
660
|
+
# The name of a database table in the Data Catalog. This table
|
661
|
+
# corresponds to a DataBrew dataset.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
# @!attribute [rw] temp_directory
|
665
|
+
# An Amazon location that AWS Glue Data Catalog can use as a temporary
|
666
|
+
# directory.
|
667
|
+
# @return [Types::S3Location]
|
668
|
+
#
|
669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DataCatalogInputDefinition AWS API Documentation
|
670
|
+
#
|
671
|
+
class DataCatalogInputDefinition < Struct.new(
|
672
|
+
:catalog_id,
|
673
|
+
:database_name,
|
674
|
+
:table_name,
|
675
|
+
:temp_directory)
|
676
|
+
SENSITIVE = []
|
677
|
+
include Aws::Structure
|
678
|
+
end
|
679
|
+
|
680
|
+
# Represents a dataset that can be processed by AWS Glue DataBrew.
|
681
|
+
#
|
682
|
+
# @!attribute [rw] account_id
|
683
|
+
# The ID of the AWS account that owns the dataset.
|
684
|
+
# @return [String]
|
685
|
+
#
|
686
|
+
# @!attribute [rw] created_by
|
687
|
+
# The identifier (the user name) of the user who created the dataset.
|
688
|
+
# @return [String]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] create_date
|
691
|
+
# The date and time that the dataset was created.
|
692
|
+
# @return [Time]
|
693
|
+
#
|
694
|
+
# @!attribute [rw] name
|
695
|
+
# The unique name of the dataset.
|
696
|
+
# @return [String]
|
697
|
+
#
|
698
|
+
# @!attribute [rw] format_options
|
699
|
+
# Options that define how DataBrew interprets the data in the dataset.
|
700
|
+
# @return [Types::FormatOptions]
|
701
|
+
#
|
702
|
+
# @!attribute [rw] input
|
703
|
+
# Information on how DataBrew can find the dataset, in either the AWS
|
704
|
+
# Glue Data Catalog or Amazon S3.
|
705
|
+
# @return [Types::Input]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] last_modified_date
|
708
|
+
# The last modification date and time of the dataset.
|
709
|
+
# @return [Time]
|
710
|
+
#
|
711
|
+
# @!attribute [rw] last_modified_by
|
712
|
+
# The identifier (the user name) of the user who last modified the
|
713
|
+
# dataset.
|
714
|
+
# @return [String]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] source
|
717
|
+
# The location of the data for the dataset, either Amazon S3 or the
|
718
|
+
# AWS Glue Data Catalog.
|
719
|
+
# @return [String]
|
720
|
+
#
|
721
|
+
# @!attribute [rw] tags
|
722
|
+
# Metadata tags that have been applied to the dataset.
|
723
|
+
# @return [Hash<String,String>]
|
724
|
+
#
|
725
|
+
# @!attribute [rw] resource_arn
|
726
|
+
# The unique Amazon Resource Name (ARN) for the dataset.
|
727
|
+
# @return [String]
|
728
|
+
#
|
729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/Dataset AWS API Documentation
|
730
|
+
#
|
731
|
+
class Dataset < Struct.new(
|
732
|
+
:account_id,
|
733
|
+
:created_by,
|
734
|
+
:create_date,
|
735
|
+
:name,
|
736
|
+
:format_options,
|
737
|
+
:input,
|
738
|
+
:last_modified_date,
|
739
|
+
:last_modified_by,
|
740
|
+
:source,
|
741
|
+
:tags,
|
742
|
+
:resource_arn)
|
743
|
+
SENSITIVE = []
|
744
|
+
include Aws::Structure
|
745
|
+
end
|
746
|
+
|
747
|
+
# @note When making an API call, you may pass DeleteDatasetRequest
|
748
|
+
# data as a hash:
|
749
|
+
#
|
750
|
+
# {
|
751
|
+
# name: "DatasetName", # required
|
752
|
+
# }
|
753
|
+
#
|
754
|
+
# @!attribute [rw] name
|
755
|
+
# The name of the dataset to be deleted.
|
756
|
+
# @return [String]
|
757
|
+
#
|
758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteDatasetRequest AWS API Documentation
|
759
|
+
#
|
760
|
+
class DeleteDatasetRequest < Struct.new(
|
761
|
+
:name)
|
762
|
+
SENSITIVE = []
|
763
|
+
include Aws::Structure
|
764
|
+
end
|
765
|
+
|
766
|
+
# @!attribute [rw] name
|
767
|
+
# The name of the dataset that you deleted.
|
768
|
+
# @return [String]
|
769
|
+
#
|
770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteDatasetResponse AWS API Documentation
|
771
|
+
#
|
772
|
+
class DeleteDatasetResponse < Struct.new(
|
773
|
+
:name)
|
774
|
+
SENSITIVE = []
|
775
|
+
include Aws::Structure
|
776
|
+
end
|
777
|
+
|
778
|
+
# @note When making an API call, you may pass DeleteJobRequest
|
779
|
+
# data as a hash:
|
780
|
+
#
|
781
|
+
# {
|
782
|
+
# name: "JobName", # required
|
783
|
+
# }
|
784
|
+
#
|
785
|
+
# @!attribute [rw] name
|
786
|
+
# The name of the job to be deleted.
|
787
|
+
# @return [String]
|
788
|
+
#
|
789
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteJobRequest AWS API Documentation
|
790
|
+
#
|
791
|
+
class DeleteJobRequest < Struct.new(
|
792
|
+
:name)
|
793
|
+
SENSITIVE = []
|
794
|
+
include Aws::Structure
|
795
|
+
end
|
796
|
+
|
797
|
+
# @!attribute [rw] name
|
798
|
+
# The name of the job that you deleted.
|
799
|
+
# @return [String]
|
800
|
+
#
|
801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteJobResponse AWS API Documentation
|
802
|
+
#
|
803
|
+
class DeleteJobResponse < Struct.new(
|
804
|
+
:name)
|
805
|
+
SENSITIVE = []
|
806
|
+
include Aws::Structure
|
807
|
+
end
|
808
|
+
|
809
|
+
# @note When making an API call, you may pass DeleteProjectRequest
|
810
|
+
# data as a hash:
|
811
|
+
#
|
812
|
+
# {
|
813
|
+
# name: "ProjectName", # required
|
814
|
+
# }
|
815
|
+
#
|
816
|
+
# @!attribute [rw] name
|
817
|
+
# The name of the project to be deleted.
|
818
|
+
# @return [String]
|
819
|
+
#
|
820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteProjectRequest AWS API Documentation
|
821
|
+
#
|
822
|
+
class DeleteProjectRequest < Struct.new(
|
823
|
+
:name)
|
824
|
+
SENSITIVE = []
|
825
|
+
include Aws::Structure
|
826
|
+
end
|
827
|
+
|
828
|
+
# @!attribute [rw] name
|
829
|
+
# The name of the project that you deleted.
|
830
|
+
# @return [String]
|
831
|
+
#
|
832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteProjectResponse AWS API Documentation
|
833
|
+
#
|
834
|
+
class DeleteProjectResponse < Struct.new(
|
835
|
+
:name)
|
836
|
+
SENSITIVE = []
|
837
|
+
include Aws::Structure
|
838
|
+
end
|
839
|
+
|
840
|
+
# @note When making an API call, you may pass DeleteRecipeVersionRequest
|
841
|
+
# data as a hash:
|
842
|
+
#
|
843
|
+
# {
|
844
|
+
# name: "RecipeName", # required
|
845
|
+
# recipe_version: "RecipeVersion", # required
|
846
|
+
# }
|
847
|
+
#
|
848
|
+
# @!attribute [rw] name
|
849
|
+
# The name of the recipe to be deleted.
|
850
|
+
# @return [String]
|
851
|
+
#
|
852
|
+
# @!attribute [rw] recipe_version
|
853
|
+
# The version of the recipe to be deleted.
|
854
|
+
# @return [String]
|
855
|
+
#
|
856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteRecipeVersionRequest AWS API Documentation
|
857
|
+
#
|
858
|
+
class DeleteRecipeVersionRequest < Struct.new(
|
859
|
+
:name,
|
860
|
+
:recipe_version)
|
861
|
+
SENSITIVE = []
|
862
|
+
include Aws::Structure
|
863
|
+
end
|
864
|
+
|
865
|
+
# @!attribute [rw] name
|
866
|
+
# The name of the recipe that was deleted.
|
867
|
+
# @return [String]
|
868
|
+
#
|
869
|
+
# @!attribute [rw] recipe_version
|
870
|
+
# The version of the recipe that was deleted.
|
871
|
+
# @return [String]
|
872
|
+
#
|
873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteRecipeVersionResponse AWS API Documentation
|
874
|
+
#
|
875
|
+
class DeleteRecipeVersionResponse < Struct.new(
|
876
|
+
:name,
|
877
|
+
:recipe_version)
|
878
|
+
SENSITIVE = []
|
879
|
+
include Aws::Structure
|
880
|
+
end
|
881
|
+
|
882
|
+
# @note When making an API call, you may pass DeleteScheduleRequest
|
883
|
+
# data as a hash:
|
884
|
+
#
|
885
|
+
# {
|
886
|
+
# name: "ScheduleName", # required
|
887
|
+
# }
|
888
|
+
#
|
889
|
+
# @!attribute [rw] name
|
890
|
+
# The name of the schedule to be deleted.
|
891
|
+
# @return [String]
|
892
|
+
#
|
893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteScheduleRequest AWS API Documentation
|
894
|
+
#
|
895
|
+
class DeleteScheduleRequest < Struct.new(
|
896
|
+
:name)
|
897
|
+
SENSITIVE = []
|
898
|
+
include Aws::Structure
|
899
|
+
end
|
900
|
+
|
901
|
+
# @!attribute [rw] name
|
902
|
+
# The name of the schedule that was deleted.
|
903
|
+
# @return [String]
|
904
|
+
#
|
905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteScheduleResponse AWS API Documentation
|
906
|
+
#
|
907
|
+
class DeleteScheduleResponse < Struct.new(
|
908
|
+
:name)
|
909
|
+
SENSITIVE = []
|
910
|
+
include Aws::Structure
|
911
|
+
end
|
912
|
+
|
913
|
+
# @note When making an API call, you may pass DescribeDatasetRequest
|
914
|
+
# data as a hash:
|
915
|
+
#
|
916
|
+
# {
|
917
|
+
# name: "DatasetName", # required
|
918
|
+
# }
|
919
|
+
#
|
920
|
+
# @!attribute [rw] name
|
921
|
+
# The name of the dataset to be described.
|
922
|
+
# @return [String]
|
923
|
+
#
|
924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeDatasetRequest AWS API Documentation
|
925
|
+
#
|
926
|
+
class DescribeDatasetRequest < Struct.new(
|
927
|
+
:name)
|
928
|
+
SENSITIVE = []
|
929
|
+
include Aws::Structure
|
930
|
+
end
|
931
|
+
|
932
|
+
# @!attribute [rw] created_by
|
933
|
+
# The identifier (user name) of the user who created the dataset.
|
934
|
+
# @return [String]
|
935
|
+
#
|
936
|
+
# @!attribute [rw] create_date
|
937
|
+
# The date and time that the dataset was created.
|
938
|
+
# @return [Time]
|
939
|
+
#
|
940
|
+
# @!attribute [rw] name
|
941
|
+
# The name of the dataset.
|
942
|
+
# @return [String]
|
943
|
+
#
|
944
|
+
# @!attribute [rw] format_options
|
945
|
+
# Options that define how Microsoft Excel input is to be interpreted
|
946
|
+
# by DataBrew.
|
947
|
+
# @return [Types::FormatOptions]
|
948
|
+
#
|
949
|
+
# @!attribute [rw] input
|
950
|
+
# Information on how AWS Glue DataBrew can find data, in either the
|
951
|
+
# AWS Glue Data Catalog or Amazon S3.
|
952
|
+
# @return [Types::Input]
|
953
|
+
#
|
954
|
+
# @!attribute [rw] last_modified_date
|
955
|
+
# The date and time that the dataset was last modified.
|
956
|
+
# @return [Time]
|
957
|
+
#
|
958
|
+
# @!attribute [rw] last_modified_by
|
959
|
+
# The identifier (user name) of the user who last modified the
|
960
|
+
# dataset.
|
961
|
+
# @return [String]
|
962
|
+
#
|
963
|
+
# @!attribute [rw] source
|
964
|
+
# The location of the data for this dataset, Amazon S3 or the AWS Glue
|
965
|
+
# Data Catalog.
|
966
|
+
# @return [String]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] tags
|
969
|
+
# Metadata tags associated with this dataset.
|
970
|
+
# @return [Hash<String,String>]
|
971
|
+
#
|
972
|
+
# @!attribute [rw] resource_arn
|
973
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
974
|
+
# @return [String]
|
975
|
+
#
|
976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeDatasetResponse AWS API Documentation
|
977
|
+
#
|
978
|
+
class DescribeDatasetResponse < Struct.new(
|
979
|
+
:created_by,
|
980
|
+
:create_date,
|
981
|
+
:name,
|
982
|
+
:format_options,
|
983
|
+
:input,
|
984
|
+
:last_modified_date,
|
985
|
+
:last_modified_by,
|
986
|
+
:source,
|
987
|
+
:tags,
|
988
|
+
:resource_arn)
|
989
|
+
SENSITIVE = []
|
990
|
+
include Aws::Structure
|
991
|
+
end
|
992
|
+
|
993
|
+
# @note When making an API call, you may pass DescribeJobRequest
|
994
|
+
# data as a hash:
|
995
|
+
#
|
996
|
+
# {
|
997
|
+
# name: "JobName", # required
|
998
|
+
# }
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] name
|
1001
|
+
# The name of the job to be described.
|
1002
|
+
# @return [String]
|
1003
|
+
#
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeJobRequest AWS API Documentation
|
1005
|
+
#
|
1006
|
+
class DescribeJobRequest < Struct.new(
|
1007
|
+
:name)
|
1008
|
+
SENSITIVE = []
|
1009
|
+
include Aws::Structure
|
1010
|
+
end
|
1011
|
+
|
1012
|
+
# @!attribute [rw] create_date
|
1013
|
+
# The date and time that the job was created.
|
1014
|
+
# @return [Time]
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] created_by
|
1017
|
+
# The identifier (user name) of the user associated with the creation
|
1018
|
+
# of the job.
|
1019
|
+
# @return [String]
|
1020
|
+
#
|
1021
|
+
# @!attribute [rw] dataset_name
|
1022
|
+
# The dataset that the job acts upon.
|
1023
|
+
# @return [String]
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] encryption_key_arn
|
1026
|
+
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
1027
|
+
# protect the job.
|
1028
|
+
# @return [String]
|
1029
|
+
#
|
1030
|
+
# @!attribute [rw] encryption_mode
|
1031
|
+
# The encryption mode for the job, which can be one of the following:
|
1032
|
+
#
|
1033
|
+
# * `SSE-KMS` - Server-side encryption with AWS KMS-managed keys.
|
1034
|
+
#
|
1035
|
+
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
1036
|
+
# @return [String]
|
1037
|
+
#
|
1038
|
+
# @!attribute [rw] name
|
1039
|
+
# The name of the job.
|
1040
|
+
# @return [String]
|
1041
|
+
#
|
1042
|
+
# @!attribute [rw] type
|
1043
|
+
# The job type, which must be one of the following:
|
1044
|
+
#
|
1045
|
+
# * `PROFILE` - The job analyzes the dataset to determine its size,
|
1046
|
+
# data types, data distribution, and more.
|
1047
|
+
#
|
1048
|
+
# * `RECIPE` - The job applies one or more transformations to a
|
1049
|
+
# dataset.
|
1050
|
+
# @return [String]
|
1051
|
+
#
|
1052
|
+
# @!attribute [rw] last_modified_by
|
1053
|
+
# The identifier (user name) of the user who last modified the job.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1056
|
+
# @!attribute [rw] last_modified_date
|
1057
|
+
# The date and time that the job was last modified.
|
1058
|
+
# @return [Time]
|
1059
|
+
#
|
1060
|
+
# @!attribute [rw] log_subscription
|
1061
|
+
# A value that indicates whether Amazon CloudWatch logging is enabled
|
1062
|
+
# for this job.
|
1063
|
+
# @return [String]
|
1064
|
+
#
|
1065
|
+
# @!attribute [rw] max_capacity
|
1066
|
+
# The maximum number of nodes that AWS Glue DataBrew can consume when
|
1067
|
+
# the job processes data.
|
1068
|
+
# @return [Integer]
|
1069
|
+
#
|
1070
|
+
# @!attribute [rw] max_retries
|
1071
|
+
# The maximum number of times to retry the job after a job run fails.
|
1072
|
+
# @return [Integer]
|
1073
|
+
#
|
1074
|
+
# @!attribute [rw] outputs
|
1075
|
+
# One or more artifacts that represent the output from running the
|
1076
|
+
# job.
|
1077
|
+
# @return [Array<Types::Output>]
|
1078
|
+
#
|
1079
|
+
# @!attribute [rw] project_name
|
1080
|
+
# The DataBrew project associated with this job.
|
1081
|
+
# @return [String]
|
1082
|
+
#
|
1083
|
+
# @!attribute [rw] recipe_reference
|
1084
|
+
# Represents all of the attributes of an AWS Glue DataBrew recipe.
|
1085
|
+
# @return [Types::RecipeReference]
|
1086
|
+
#
|
1087
|
+
# @!attribute [rw] resource_arn
|
1088
|
+
# The Amazon Resource Name (ARN) of the job.
|
1089
|
+
# @return [String]
|
1090
|
+
#
|
1091
|
+
# @!attribute [rw] role_arn
|
1092
|
+
# The ARN of the AWS Identity and Access Management (IAM) role that
|
1093
|
+
# was assumed for this request.
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] tags
|
1097
|
+
# Metadata tags associated with this job.
|
1098
|
+
# @return [Hash<String,String>]
|
1099
|
+
#
|
1100
|
+
# @!attribute [rw] timeout
|
1101
|
+
# The job's timeout in minutes. A job that attempts to run longer
|
1102
|
+
# than this timeout period ends with a status of `TIMEOUT`.
|
1103
|
+
# @return [Integer]
|
1104
|
+
#
|
1105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeJobResponse AWS API Documentation
|
1106
|
+
#
|
1107
|
+
class DescribeJobResponse < Struct.new(
|
1108
|
+
:create_date,
|
1109
|
+
:created_by,
|
1110
|
+
:dataset_name,
|
1111
|
+
:encryption_key_arn,
|
1112
|
+
:encryption_mode,
|
1113
|
+
:name,
|
1114
|
+
:type,
|
1115
|
+
:last_modified_by,
|
1116
|
+
:last_modified_date,
|
1117
|
+
:log_subscription,
|
1118
|
+
:max_capacity,
|
1119
|
+
:max_retries,
|
1120
|
+
:outputs,
|
1121
|
+
:project_name,
|
1122
|
+
:recipe_reference,
|
1123
|
+
:resource_arn,
|
1124
|
+
:role_arn,
|
1125
|
+
:tags,
|
1126
|
+
:timeout)
|
1127
|
+
SENSITIVE = []
|
1128
|
+
include Aws::Structure
|
1129
|
+
end
|
1130
|
+
|
1131
|
+
# @note When making an API call, you may pass DescribeProjectRequest
|
1132
|
+
# data as a hash:
|
1133
|
+
#
|
1134
|
+
# {
|
1135
|
+
# name: "ProjectName", # required
|
1136
|
+
# }
|
1137
|
+
#
|
1138
|
+
# @!attribute [rw] name
|
1139
|
+
# The name of the project to be described.
|
1140
|
+
# @return [String]
|
1141
|
+
#
|
1142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeProjectRequest AWS API Documentation
|
1143
|
+
#
|
1144
|
+
class DescribeProjectRequest < Struct.new(
|
1145
|
+
:name)
|
1146
|
+
SENSITIVE = []
|
1147
|
+
include Aws::Structure
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
# @!attribute [rw] create_date
|
1151
|
+
# The date and time that the project was created.
|
1152
|
+
# @return [Time]
|
1153
|
+
#
|
1154
|
+
# @!attribute [rw] created_by
|
1155
|
+
# The identifier (user name) of the user who created the project.
|
1156
|
+
# @return [String]
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] dataset_name
|
1159
|
+
# The dataset associated with the project.
|
1160
|
+
# @return [String]
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] last_modified_date
|
1163
|
+
# The date and time that the project was last modified.
|
1164
|
+
# @return [Time]
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] last_modified_by
|
1167
|
+
# The identifier (user name) of the user who last modified the
|
1168
|
+
# project.
|
1169
|
+
# @return [String]
|
1170
|
+
#
|
1171
|
+
# @!attribute [rw] name
|
1172
|
+
# The name of the project.
|
1173
|
+
# @return [String]
|
1174
|
+
#
|
1175
|
+
# @!attribute [rw] recipe_name
|
1176
|
+
# The recipe associated with this job.
|
1177
|
+
# @return [String]
|
1178
|
+
#
|
1179
|
+
# @!attribute [rw] resource_arn
|
1180
|
+
# The Amazon Resource Name (ARN) of the project.
|
1181
|
+
# @return [String]
|
1182
|
+
#
|
1183
|
+
# @!attribute [rw] sample
|
1184
|
+
# Represents the sample size and sampling type for AWS Glue DataBrew
|
1185
|
+
# to use for interactive data analysis.
|
1186
|
+
# @return [Types::Sample]
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] role_arn
|
1189
|
+
# The ARN of the AWS Identity and Access Management (IAM) role that
|
1190
|
+
# was assumed for this request.
|
1191
|
+
# @return [String]
|
1192
|
+
#
|
1193
|
+
# @!attribute [rw] tags
|
1194
|
+
# Metadata tags associated with this project.
|
1195
|
+
# @return [Hash<String,String>]
|
1196
|
+
#
|
1197
|
+
# @!attribute [rw] session_status
|
1198
|
+
# Describes the current state of the session:
|
1199
|
+
#
|
1200
|
+
# * `PROVISIONING` - allocating resources for the session.
|
1201
|
+
#
|
1202
|
+
# * `INITIALIZING` - getting the session ready for first use.
|
1203
|
+
#
|
1204
|
+
# * `ASSIGNED` - the session is ready for use.
|
1205
|
+
# @return [String]
|
1206
|
+
#
|
1207
|
+
# @!attribute [rw] opened_by
|
1208
|
+
# The identifier (user name) of the user that opened the project for
|
1209
|
+
# use.
|
1210
|
+
# @return [String]
|
1211
|
+
#
|
1212
|
+
# @!attribute [rw] open_date
|
1213
|
+
# The date and time when the project was opened.
|
1214
|
+
# @return [Time]
|
1215
|
+
#
|
1216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeProjectResponse AWS API Documentation
|
1217
|
+
#
|
1218
|
+
class DescribeProjectResponse < Struct.new(
|
1219
|
+
:create_date,
|
1220
|
+
:created_by,
|
1221
|
+
:dataset_name,
|
1222
|
+
:last_modified_date,
|
1223
|
+
:last_modified_by,
|
1224
|
+
:name,
|
1225
|
+
:recipe_name,
|
1226
|
+
:resource_arn,
|
1227
|
+
:sample,
|
1228
|
+
:role_arn,
|
1229
|
+
:tags,
|
1230
|
+
:session_status,
|
1231
|
+
:opened_by,
|
1232
|
+
:open_date)
|
1233
|
+
SENSITIVE = []
|
1234
|
+
include Aws::Structure
|
1235
|
+
end
|
1236
|
+
|
1237
|
+
# @note When making an API call, you may pass DescribeRecipeRequest
|
1238
|
+
# data as a hash:
|
1239
|
+
#
|
1240
|
+
# {
|
1241
|
+
# name: "RecipeName", # required
|
1242
|
+
# recipe_version: "RecipeVersion",
|
1243
|
+
# }
|
1244
|
+
#
|
1245
|
+
# @!attribute [rw] name
|
1246
|
+
# The name of the recipe to be described.
|
1247
|
+
# @return [String]
|
1248
|
+
#
|
1249
|
+
# @!attribute [rw] recipe_version
|
1250
|
+
# The recipe version identifier. If this parameter isn't specified,
|
1251
|
+
# then the latest published version is returned.
|
1252
|
+
# @return [String]
|
1253
|
+
#
|
1254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeRecipeRequest AWS API Documentation
|
1255
|
+
#
|
1256
|
+
class DescribeRecipeRequest < Struct.new(
|
1257
|
+
:name,
|
1258
|
+
:recipe_version)
|
1259
|
+
SENSITIVE = []
|
1260
|
+
include Aws::Structure
|
1261
|
+
end
|
1262
|
+
|
1263
|
+
# @!attribute [rw] created_by
|
1264
|
+
# The identifier (user name) of the user who created the recipe.
|
1265
|
+
# @return [String]
|
1266
|
+
#
|
1267
|
+
# @!attribute [rw] create_date
|
1268
|
+
# The date and time that the recipe was created.
|
1269
|
+
# @return [Time]
|
1270
|
+
#
|
1271
|
+
# @!attribute [rw] last_modified_by
|
1272
|
+
# The identifier (user name) of the user who last modified the recipe.
|
1273
|
+
# @return [String]
|
1274
|
+
#
|
1275
|
+
# @!attribute [rw] last_modified_date
|
1276
|
+
# The date and time that the recipe was last modified.
|
1277
|
+
# @return [Time]
|
1278
|
+
#
|
1279
|
+
# @!attribute [rw] project_name
|
1280
|
+
# The name of the project associated with this recipe.
|
1281
|
+
# @return [String]
|
1282
|
+
#
|
1283
|
+
# @!attribute [rw] published_by
|
1284
|
+
# The identifier (user name) of the user who last published the
|
1285
|
+
# recipe.
|
1286
|
+
# @return [String]
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] published_date
|
1289
|
+
# The date and time when the recipe was last published.
|
1290
|
+
# @return [Time]
|
1291
|
+
#
|
1292
|
+
# @!attribute [rw] description
|
1293
|
+
# The description of the recipe.
|
1294
|
+
# @return [String]
|
1295
|
+
#
|
1296
|
+
# @!attribute [rw] name
|
1297
|
+
# The name of the recipe.
|
1298
|
+
# @return [String]
|
1299
|
+
#
|
1300
|
+
# @!attribute [rw] steps
|
1301
|
+
# One or more steps to be performed by the recipe. Each step consists
|
1302
|
+
# of an action, and the conditions under which the action should
|
1303
|
+
# succeed.
|
1304
|
+
# @return [Array<Types::RecipeStep>]
|
1305
|
+
#
|
1306
|
+
# @!attribute [rw] tags
|
1307
|
+
# Metadata tags associated with this project.
|
1308
|
+
# @return [Hash<String,String>]
|
1309
|
+
#
|
1310
|
+
# @!attribute [rw] resource_arn
|
1311
|
+
# The ARN of the recipe.
|
1312
|
+
# @return [String]
|
1313
|
+
#
|
1314
|
+
# @!attribute [rw] recipe_version
|
1315
|
+
# The recipe version identifier.
|
1316
|
+
# @return [String]
|
1317
|
+
#
|
1318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeRecipeResponse AWS API Documentation
|
1319
|
+
#
|
1320
|
+
class DescribeRecipeResponse < Struct.new(
|
1321
|
+
:created_by,
|
1322
|
+
:create_date,
|
1323
|
+
:last_modified_by,
|
1324
|
+
:last_modified_date,
|
1325
|
+
:project_name,
|
1326
|
+
:published_by,
|
1327
|
+
:published_date,
|
1328
|
+
:description,
|
1329
|
+
:name,
|
1330
|
+
:steps,
|
1331
|
+
:tags,
|
1332
|
+
:resource_arn,
|
1333
|
+
:recipe_version)
|
1334
|
+
SENSITIVE = []
|
1335
|
+
include Aws::Structure
|
1336
|
+
end
|
1337
|
+
|
1338
|
+
# @note When making an API call, you may pass DescribeScheduleRequest
|
1339
|
+
# data as a hash:
|
1340
|
+
#
|
1341
|
+
# {
|
1342
|
+
# name: "ScheduleName", # required
|
1343
|
+
# }
|
1344
|
+
#
|
1345
|
+
# @!attribute [rw] name
|
1346
|
+
# The name of the schedule to be described.
|
1347
|
+
# @return [String]
|
1348
|
+
#
|
1349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeScheduleRequest AWS API Documentation
|
1350
|
+
#
|
1351
|
+
class DescribeScheduleRequest < Struct.new(
|
1352
|
+
:name)
|
1353
|
+
SENSITIVE = []
|
1354
|
+
include Aws::Structure
|
1355
|
+
end
|
1356
|
+
|
1357
|
+
# @!attribute [rw] create_date
|
1358
|
+
# The date and time that the schedule was created.
|
1359
|
+
# @return [Time]
|
1360
|
+
#
|
1361
|
+
# @!attribute [rw] created_by
|
1362
|
+
# The identifier (user name) of the user who created the schedule.
|
1363
|
+
# @return [String]
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] job_names
|
1366
|
+
# The name or names of one or more jobs to be run by using the
|
1367
|
+
# schedule.
|
1368
|
+
# @return [Array<String>]
|
1369
|
+
#
|
1370
|
+
# @!attribute [rw] last_modified_by
|
1371
|
+
# The identifier (user name) of the user who last modified the
|
1372
|
+
# schedule.
|
1373
|
+
# @return [String]
|
1374
|
+
#
|
1375
|
+
# @!attribute [rw] last_modified_date
|
1376
|
+
# The date and time that the schedule was last modified.
|
1377
|
+
# @return [Time]
|
1378
|
+
#
|
1379
|
+
# @!attribute [rw] resource_arn
|
1380
|
+
# The Amazon Resource Name (ARN) of the schedule.
|
1381
|
+
# @return [String]
|
1382
|
+
#
|
1383
|
+
# @!attribute [rw] cron_expression
|
1384
|
+
# The date or dates and time or times, in `cron` format, when the jobs
|
1385
|
+
# are to be run for the schedule.
|
1386
|
+
# @return [String]
|
1387
|
+
#
|
1388
|
+
# @!attribute [rw] tags
|
1389
|
+
# Metadata tags associated with this schedule.
|
1390
|
+
# @return [Hash<String,String>]
|
1391
|
+
#
|
1392
|
+
# @!attribute [rw] name
|
1393
|
+
# The name of the schedule.
|
1394
|
+
# @return [String]
|
1395
|
+
#
|
1396
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeScheduleResponse AWS API Documentation
|
1397
|
+
#
|
1398
|
+
class DescribeScheduleResponse < Struct.new(
|
1399
|
+
:create_date,
|
1400
|
+
:created_by,
|
1401
|
+
:job_names,
|
1402
|
+
:last_modified_by,
|
1403
|
+
:last_modified_date,
|
1404
|
+
:resource_arn,
|
1405
|
+
:cron_expression,
|
1406
|
+
:tags,
|
1407
|
+
:name)
|
1408
|
+
SENSITIVE = []
|
1409
|
+
include Aws::Structure
|
1410
|
+
end
|
1411
|
+
|
1412
|
+
# Options that define how DataBrew will interpret a Microsoft Excel
|
1413
|
+
# file, when creating a dataset from that file.
|
1414
|
+
#
|
1415
|
+
# @note When making an API call, you may pass ExcelOptions
|
1416
|
+
# data as a hash:
|
1417
|
+
#
|
1418
|
+
# {
|
1419
|
+
# sheet_names: ["SheetName"],
|
1420
|
+
# sheet_indexes: [1],
|
1421
|
+
# }
|
1422
|
+
#
|
1423
|
+
# @!attribute [rw] sheet_names
|
1424
|
+
# Specifies one or more named sheets in the Excel file, which will be
|
1425
|
+
# included in the dataset.
|
1426
|
+
# @return [Array<String>]
|
1427
|
+
#
|
1428
|
+
# @!attribute [rw] sheet_indexes
|
1429
|
+
# Specifies one or more sheet numbers in the Excel file, which will be
|
1430
|
+
# included in the dataset.
|
1431
|
+
# @return [Array<Integer>]
|
1432
|
+
#
|
1433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ExcelOptions AWS API Documentation
|
1434
|
+
#
|
1435
|
+
class ExcelOptions < Struct.new(
|
1436
|
+
:sheet_names,
|
1437
|
+
:sheet_indexes)
|
1438
|
+
SENSITIVE = []
|
1439
|
+
include Aws::Structure
|
1440
|
+
end
|
1441
|
+
|
1442
|
+
# Options that define how Microsoft Excel input is to be interpreted by
|
1443
|
+
# DataBrew.
|
1444
|
+
#
|
1445
|
+
# @note When making an API call, you may pass FormatOptions
|
1446
|
+
# data as a hash:
|
1447
|
+
#
|
1448
|
+
# {
|
1449
|
+
# json: {
|
1450
|
+
# multi_line: false,
|
1451
|
+
# },
|
1452
|
+
# excel: {
|
1453
|
+
# sheet_names: ["SheetName"],
|
1454
|
+
# sheet_indexes: [1],
|
1455
|
+
# },
|
1456
|
+
# }
|
1457
|
+
#
|
1458
|
+
# @!attribute [rw] json
|
1459
|
+
# Options that define how JSON input is to be interpreted by DataBrew.
|
1460
|
+
# @return [Types::JsonOptions]
|
1461
|
+
#
|
1462
|
+
# @!attribute [rw] excel
|
1463
|
+
# Options that define how Excel input is to be interpreted by
|
1464
|
+
# DataBrew.
|
1465
|
+
# @return [Types::ExcelOptions]
|
1466
|
+
#
|
1467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/FormatOptions AWS API Documentation
|
1468
|
+
#
|
1469
|
+
class FormatOptions < Struct.new(
|
1470
|
+
:json,
|
1471
|
+
:excel)
|
1472
|
+
SENSITIVE = []
|
1473
|
+
include Aws::Structure
|
1474
|
+
end
|
1475
|
+
|
1476
|
+
# Information on how AWS Glue DataBrew can find data, in either the AWS
|
1477
|
+
# Glue Data Catalog or Amazon S3.
|
1478
|
+
#
|
1479
|
+
# @note When making an API call, you may pass Input
|
1480
|
+
# data as a hash:
|
1481
|
+
#
|
1482
|
+
# {
|
1483
|
+
# s3_input_definition: {
|
1484
|
+
# bucket: "Bucket", # required
|
1485
|
+
# key: "Key",
|
1486
|
+
# },
|
1487
|
+
# data_catalog_input_definition: {
|
1488
|
+
# catalog_id: "CatalogId",
|
1489
|
+
# database_name: "DatabaseName", # required
|
1490
|
+
# table_name: "TableName", # required
|
1491
|
+
# temp_directory: {
|
1492
|
+
# bucket: "Bucket", # required
|
1493
|
+
# key: "Key",
|
1494
|
+
# },
|
1495
|
+
# },
|
1496
|
+
# }
|
1497
|
+
#
|
1498
|
+
# @!attribute [rw] s3_input_definition
|
1499
|
+
# The Amazon S3 location where the data is stored.
|
1500
|
+
# @return [Types::S3Location]
|
1501
|
+
#
|
1502
|
+
# @!attribute [rw] data_catalog_input_definition
|
1503
|
+
# The AWS Glue Data Catalog parameters for the data.
|
1504
|
+
# @return [Types::DataCatalogInputDefinition]
|
1505
|
+
#
|
1506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/Input AWS API Documentation
|
1507
|
+
#
|
1508
|
+
class Input < Struct.new(
|
1509
|
+
:s3_input_definition,
|
1510
|
+
:data_catalog_input_definition)
|
1511
|
+
SENSITIVE = []
|
1512
|
+
include Aws::Structure
|
1513
|
+
end
|
1514
|
+
|
1515
|
+
# An internal service failure occurred.
|
1516
|
+
#
|
1517
|
+
# @!attribute [rw] message
|
1518
|
+
# @return [String]
|
1519
|
+
#
|
1520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/InternalServerException AWS API Documentation
|
1521
|
+
#
|
1522
|
+
class InternalServerException < Struct.new(
|
1523
|
+
:message)
|
1524
|
+
SENSITIVE = []
|
1525
|
+
include Aws::Structure
|
1526
|
+
end
|
1527
|
+
|
1528
|
+
# Represents all of the attributes of an AWS Glue DataBrew job.
|
1529
|
+
#
|
1530
|
+
# @!attribute [rw] account_id
|
1531
|
+
# The ID of the AWS account that owns the job.
|
1532
|
+
# @return [String]
|
1533
|
+
#
|
1534
|
+
# @!attribute [rw] created_by
|
1535
|
+
# The identifier (the user name) of the user who created the job.
|
1536
|
+
# @return [String]
|
1537
|
+
#
|
1538
|
+
# @!attribute [rw] create_date
|
1539
|
+
# The date and time that the job was created.
|
1540
|
+
# @return [Time]
|
1541
|
+
#
|
1542
|
+
# @!attribute [rw] dataset_name
|
1543
|
+
# A dataset that the job is to process.
|
1544
|
+
# @return [String]
|
1545
|
+
#
|
1546
|
+
# @!attribute [rw] encryption_key_arn
|
1547
|
+
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
1548
|
+
# protect a job.
|
1549
|
+
# @return [String]
|
1550
|
+
#
|
1551
|
+
# @!attribute [rw] encryption_mode
|
1552
|
+
# The encryption mode for the job, which can be one of the following:
|
1553
|
+
#
|
1554
|
+
# * `SSE-KMS` - Server-side encryption with AWS KMS-managed keys.
|
1555
|
+
#
|
1556
|
+
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
1557
|
+
# @return [String]
|
1558
|
+
#
|
1559
|
+
# @!attribute [rw] name
|
1560
|
+
# The unique name of the job.
|
1561
|
+
# @return [String]
|
1562
|
+
#
|
1563
|
+
# @!attribute [rw] type
|
1564
|
+
# The job type of the job, which must be one of the following:
|
1565
|
+
#
|
1566
|
+
# * `PROFILE` - A job to analyze a dataset, to determine its size,
|
1567
|
+
# data types, data distribution, and more.
|
1568
|
+
#
|
1569
|
+
# * `RECIPE` - A job to apply one or more transformations to a
|
1570
|
+
# dataset.
|
1571
|
+
# @return [String]
|
1572
|
+
#
|
1573
|
+
# @!attribute [rw] last_modified_by
|
1574
|
+
# The identifier (the user name) of the user who last modified the
|
1575
|
+
# job.
|
1576
|
+
# @return [String]
|
1577
|
+
#
|
1578
|
+
# @!attribute [rw] last_modified_date
|
1579
|
+
# The modification date and time of the job.
|
1580
|
+
# @return [Time]
|
1581
|
+
#
|
1582
|
+
# @!attribute [rw] log_subscription
|
1583
|
+
# The current status of Amazon CloudWatch logging for the job.
|
1584
|
+
# @return [String]
|
1585
|
+
#
|
1586
|
+
# @!attribute [rw] max_capacity
|
1587
|
+
# The maximum number of nodes that can be consumed when the job
|
1588
|
+
# processes data.
|
1589
|
+
# @return [Integer]
|
1590
|
+
#
|
1591
|
+
# @!attribute [rw] max_retries
|
1592
|
+
# The maximum number of times to retry the job after a job run fails.
|
1593
|
+
# @return [Integer]
|
1594
|
+
#
|
1595
|
+
# @!attribute [rw] outputs
|
1596
|
+
# One or more artifacts that represent output from running the job.
|
1597
|
+
# @return [Array<Types::Output>]
|
1598
|
+
#
|
1599
|
+
# @!attribute [rw] project_name
|
1600
|
+
# The name of the project that the job is associated with.
|
1601
|
+
# @return [String]
|
1602
|
+
#
|
1603
|
+
# @!attribute [rw] recipe_reference
|
1604
|
+
# A set of steps that the job runs.
|
1605
|
+
# @return [Types::RecipeReference]
|
1606
|
+
#
|
1607
|
+
# @!attribute [rw] resource_arn
|
1608
|
+
# The unique Amazon Resource Name (ARN) for the job.
|
1609
|
+
# @return [String]
|
1610
|
+
#
|
1611
|
+
# @!attribute [rw] role_arn
|
1612
|
+
# The Amazon Resource Name (ARN) of the role that will be assumed for
|
1613
|
+
# this job.
|
1614
|
+
# @return [String]
|
1615
|
+
#
|
1616
|
+
# @!attribute [rw] timeout
|
1617
|
+
# The job's timeout in minutes. A job that attempts to run longer
|
1618
|
+
# than this timeout period ends with a status of `TIMEOUT`.
|
1619
|
+
# @return [Integer]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] tags
|
1622
|
+
# Metadata tags that have been applied to the job.
|
1623
|
+
# @return [Hash<String,String>]
|
1624
|
+
#
|
1625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/Job AWS API Documentation
|
1626
|
+
#
|
1627
|
+
class Job < Struct.new(
|
1628
|
+
:account_id,
|
1629
|
+
:created_by,
|
1630
|
+
:create_date,
|
1631
|
+
:dataset_name,
|
1632
|
+
:encryption_key_arn,
|
1633
|
+
:encryption_mode,
|
1634
|
+
:name,
|
1635
|
+
:type,
|
1636
|
+
:last_modified_by,
|
1637
|
+
:last_modified_date,
|
1638
|
+
:log_subscription,
|
1639
|
+
:max_capacity,
|
1640
|
+
:max_retries,
|
1641
|
+
:outputs,
|
1642
|
+
:project_name,
|
1643
|
+
:recipe_reference,
|
1644
|
+
:resource_arn,
|
1645
|
+
:role_arn,
|
1646
|
+
:timeout,
|
1647
|
+
:tags)
|
1648
|
+
SENSITIVE = []
|
1649
|
+
include Aws::Structure
|
1650
|
+
end
|
1651
|
+
|
1652
|
+
# Represents one run of an AWS Glue DataBrew job.
|
1653
|
+
#
|
1654
|
+
# @!attribute [rw] attempt
|
1655
|
+
# The number of times that DataBrew has attempted to run the job.
|
1656
|
+
# @return [Integer]
|
1657
|
+
#
|
1658
|
+
# @!attribute [rw] completed_on
|
1659
|
+
# The date and time when the job completed processing.
|
1660
|
+
# @return [Time]
|
1661
|
+
#
|
1662
|
+
# @!attribute [rw] dataset_name
|
1663
|
+
# The name of the dataset for the job to process.
|
1664
|
+
# @return [String]
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] error_message
|
1667
|
+
# A message indicating an error (if any) that was encountered when the
|
1668
|
+
# job ran.
|
1669
|
+
# @return [String]
|
1670
|
+
#
|
1671
|
+
# @!attribute [rw] execution_time
|
1672
|
+
# The amount of time, in seconds, during which a job run consumed
|
1673
|
+
# resources.
|
1674
|
+
# @return [Integer]
|
1675
|
+
#
|
1676
|
+
# @!attribute [rw] job_name
|
1677
|
+
# The name of the job being processed during this run.
|
1678
|
+
# @return [String]
|
1679
|
+
#
|
1680
|
+
# @!attribute [rw] run_id
|
1681
|
+
# The unique identifier of the job run.
|
1682
|
+
# @return [String]
|
1683
|
+
#
|
1684
|
+
# @!attribute [rw] state
|
1685
|
+
# The current state of the job run entity itself.
|
1686
|
+
# @return [String]
|
1687
|
+
#
|
1688
|
+
# @!attribute [rw] log_subscription
|
1689
|
+
# The current status of Amazon CloudWatch logging for the job run.
|
1690
|
+
# @return [String]
|
1691
|
+
#
|
1692
|
+
# @!attribute [rw] log_group_name
|
1693
|
+
# The name of an Amazon CloudWatch log group, where the job writes
|
1694
|
+
# diagnostic messages when it runs.
|
1695
|
+
# @return [String]
|
1696
|
+
#
|
1697
|
+
# @!attribute [rw] outputs
|
1698
|
+
# One or more output artifacts from a job run.
|
1699
|
+
# @return [Array<Types::Output>]
|
1700
|
+
#
|
1701
|
+
# @!attribute [rw] recipe_reference
|
1702
|
+
# The set of steps processed by the job.
|
1703
|
+
# @return [Types::RecipeReference]
|
1704
|
+
#
|
1705
|
+
# @!attribute [rw] started_by
|
1706
|
+
# The identifier (the user name) of the user who initiated the job
|
1707
|
+
# run.
|
1708
|
+
# @return [String]
|
1709
|
+
#
|
1710
|
+
# @!attribute [rw] started_on
|
1711
|
+
# The date and time when the job run began.
|
1712
|
+
# @return [Time]
|
1713
|
+
#
|
1714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/JobRun AWS API Documentation
|
1715
|
+
#
|
1716
|
+
class JobRun < Struct.new(
|
1717
|
+
:attempt,
|
1718
|
+
:completed_on,
|
1719
|
+
:dataset_name,
|
1720
|
+
:error_message,
|
1721
|
+
:execution_time,
|
1722
|
+
:job_name,
|
1723
|
+
:run_id,
|
1724
|
+
:state,
|
1725
|
+
:log_subscription,
|
1726
|
+
:log_group_name,
|
1727
|
+
:outputs,
|
1728
|
+
:recipe_reference,
|
1729
|
+
:started_by,
|
1730
|
+
:started_on)
|
1731
|
+
SENSITIVE = []
|
1732
|
+
include Aws::Structure
|
1733
|
+
end
|
1734
|
+
|
1735
|
+
# Represents the JSON-specific options that define how input is to be
|
1736
|
+
# interpreted by AWS Glue DataBrew.
|
1737
|
+
#
|
1738
|
+
# @note When making an API call, you may pass JsonOptions
|
1739
|
+
# data as a hash:
|
1740
|
+
#
|
1741
|
+
# {
|
1742
|
+
# multi_line: false,
|
1743
|
+
# }
|
1744
|
+
#
|
1745
|
+
# @!attribute [rw] multi_line
|
1746
|
+
# A value that specifies whether JSON input contains embedded new line
|
1747
|
+
# characters.
|
1748
|
+
# @return [Boolean]
|
1749
|
+
#
|
1750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/JsonOptions AWS API Documentation
|
1751
|
+
#
|
1752
|
+
class JsonOptions < Struct.new(
|
1753
|
+
:multi_line)
|
1754
|
+
SENSITIVE = []
|
1755
|
+
include Aws::Structure
|
1756
|
+
end
|
1757
|
+
|
1758
|
+
# @note When making an API call, you may pass ListDatasetsRequest
|
1759
|
+
# data as a hash:
|
1760
|
+
#
|
1761
|
+
# {
|
1762
|
+
# max_results: 1,
|
1763
|
+
# next_token: "NextToken",
|
1764
|
+
# }
|
1765
|
+
#
|
1766
|
+
# @!attribute [rw] max_results
|
1767
|
+
# The maximum number of results to return in this request.
|
1768
|
+
# @return [Integer]
|
1769
|
+
#
|
1770
|
+
# @!attribute [rw] next_token
|
1771
|
+
# A token generated by DataBrew that specifies where to continue
|
1772
|
+
# pagination if a previous request was truncated. To get the next set
|
1773
|
+
# of pages, pass in the NextToken value from the response object of
|
1774
|
+
# the previous page call.
|
1775
|
+
# @return [String]
|
1776
|
+
#
|
1777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListDatasetsRequest AWS API Documentation
|
1778
|
+
#
|
1779
|
+
class ListDatasetsRequest < Struct.new(
|
1780
|
+
:max_results,
|
1781
|
+
:next_token)
|
1782
|
+
SENSITIVE = []
|
1783
|
+
include Aws::Structure
|
1784
|
+
end
|
1785
|
+
|
1786
|
+
# @!attribute [rw] datasets
|
1787
|
+
# A list of datasets that are defined in the current AWS account.
|
1788
|
+
# @return [Array<Types::Dataset>]
|
1789
|
+
#
|
1790
|
+
# @!attribute [rw] next_token
|
1791
|
+
# A token generated by DataBrew that specifies where to continue
|
1792
|
+
# pagination if a previous request was truncated. To obtain the next
|
1793
|
+
# set of pages, pass in the NextToken from the response object of the
|
1794
|
+
# previous page call.
|
1795
|
+
# @return [String]
|
1796
|
+
#
|
1797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListDatasetsResponse AWS API Documentation
|
1798
|
+
#
|
1799
|
+
class ListDatasetsResponse < Struct.new(
|
1800
|
+
:datasets,
|
1801
|
+
:next_token)
|
1802
|
+
SENSITIVE = []
|
1803
|
+
include Aws::Structure
|
1804
|
+
end
|
1805
|
+
|
1806
|
+
# @note When making an API call, you may pass ListJobRunsRequest
|
1807
|
+
# data as a hash:
|
1808
|
+
#
|
1809
|
+
# {
|
1810
|
+
# name: "JobName", # required
|
1811
|
+
# max_results: 1,
|
1812
|
+
# next_token: "NextToken",
|
1813
|
+
# }
|
1814
|
+
#
|
1815
|
+
# @!attribute [rw] name
|
1816
|
+
# The name of the job.
|
1817
|
+
# @return [String]
|
1818
|
+
#
|
1819
|
+
# @!attribute [rw] max_results
|
1820
|
+
# The maximum number of results to return in this request.
|
1821
|
+
# @return [Integer]
|
1822
|
+
#
|
1823
|
+
# @!attribute [rw] next_token
|
1824
|
+
# A token generated by AWS Glue DataBrew that specifies where to
|
1825
|
+
# continue pagination if a previous request was truncated. To get the
|
1826
|
+
# next set of pages, pass in the NextToken value from the response
|
1827
|
+
# object of the previous page call.
|
1828
|
+
# @return [String]
|
1829
|
+
#
|
1830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobRunsRequest AWS API Documentation
|
1831
|
+
#
|
1832
|
+
class ListJobRunsRequest < Struct.new(
|
1833
|
+
:name,
|
1834
|
+
:max_results,
|
1835
|
+
:next_token)
|
1836
|
+
SENSITIVE = []
|
1837
|
+
include Aws::Structure
|
1838
|
+
end
|
1839
|
+
|
1840
|
+
# @!attribute [rw] job_runs
|
1841
|
+
# A list of job runs that have occurred for the specified job.
|
1842
|
+
# @return [Array<Types::JobRun>]
|
1843
|
+
#
|
1844
|
+
# @!attribute [rw] next_token
|
1845
|
+
# A token generated by DataBrew that specifies where to continue
|
1846
|
+
# pagination if a previous request was truncated. To obtain the next
|
1847
|
+
# set of pages, pass in the NextToken from the response object of the
|
1848
|
+
# previous page call.
|
1849
|
+
# @return [String]
|
1850
|
+
#
|
1851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobRunsResponse AWS API Documentation
|
1852
|
+
#
|
1853
|
+
class ListJobRunsResponse < Struct.new(
|
1854
|
+
:job_runs,
|
1855
|
+
:next_token)
|
1856
|
+
SENSITIVE = []
|
1857
|
+
include Aws::Structure
|
1858
|
+
end
|
1859
|
+
|
1860
|
+
# @note When making an API call, you may pass ListJobsRequest
|
1861
|
+
# data as a hash:
|
1862
|
+
#
|
1863
|
+
# {
|
1864
|
+
# dataset_name: "DatasetName",
|
1865
|
+
# max_results: 1,
|
1866
|
+
# next_token: "NextToken",
|
1867
|
+
# project_name: "ProjectName",
|
1868
|
+
# }
|
1869
|
+
#
|
1870
|
+
# @!attribute [rw] dataset_name
|
1871
|
+
# The name of a dataset. Using this parameter indicates to return only
|
1872
|
+
# those jobs that act on the specified dataset.
|
1873
|
+
# @return [String]
|
1874
|
+
#
|
1875
|
+
# @!attribute [rw] max_results
|
1876
|
+
# The maximum number of results to return in this request.
|
1877
|
+
# @return [Integer]
|
1878
|
+
#
|
1879
|
+
# @!attribute [rw] next_token
|
1880
|
+
# A token generated by DataBrew that specifies where to continue
|
1881
|
+
# pagination if a previous request was truncated. To get the next set
|
1882
|
+
# of pages, pass in the NextToken value from the response object of
|
1883
|
+
# the previous page call.
|
1884
|
+
# @return [String]
|
1885
|
+
#
|
1886
|
+
# @!attribute [rw] project_name
|
1887
|
+
# The name of a project. Using this parameter indicates to return only
|
1888
|
+
# those jobs that are associated with the specified project.
|
1889
|
+
# @return [String]
|
1890
|
+
#
|
1891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobsRequest AWS API Documentation
|
1892
|
+
#
|
1893
|
+
class ListJobsRequest < Struct.new(
|
1894
|
+
:dataset_name,
|
1895
|
+
:max_results,
|
1896
|
+
:next_token,
|
1897
|
+
:project_name)
|
1898
|
+
SENSITIVE = []
|
1899
|
+
include Aws::Structure
|
1900
|
+
end
|
1901
|
+
|
1902
|
+
# @!attribute [rw] jobs
|
1903
|
+
# A list of jobs that are defined in the current AWS account.
|
1904
|
+
# @return [Array<Types::Job>]
|
1905
|
+
#
|
1906
|
+
# @!attribute [rw] next_token
|
1907
|
+
# A token generated by DataBrew that specifies where to continue
|
1908
|
+
# pagination if a previous request was truncated. To obtain the next
|
1909
|
+
# set of pages, pass in the NextToken from the response object of the
|
1910
|
+
# previous page call.
|
1911
|
+
# @return [String]
|
1912
|
+
#
|
1913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobsResponse AWS API Documentation
|
1914
|
+
#
|
1915
|
+
class ListJobsResponse < Struct.new(
|
1916
|
+
:jobs,
|
1917
|
+
:next_token)
|
1918
|
+
SENSITIVE = []
|
1919
|
+
include Aws::Structure
|
1920
|
+
end
|
1921
|
+
|
1922
|
+
# @note When making an API call, you may pass ListProjectsRequest
|
1923
|
+
# data as a hash:
|
1924
|
+
#
|
1925
|
+
# {
|
1926
|
+
# next_token: "NextToken",
|
1927
|
+
# max_results: 1,
|
1928
|
+
# }
|
1929
|
+
#
|
1930
|
+
# @!attribute [rw] next_token
|
1931
|
+
# A pagination token that can be used in a subsequent request.
|
1932
|
+
# @return [String]
|
1933
|
+
#
|
1934
|
+
# @!attribute [rw] max_results
|
1935
|
+
# The maximum number of results to return in this request.
|
1936
|
+
# @return [Integer]
|
1937
|
+
#
|
1938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListProjectsRequest AWS API Documentation
|
1939
|
+
#
|
1940
|
+
class ListProjectsRequest < Struct.new(
|
1941
|
+
:next_token,
|
1942
|
+
:max_results)
|
1943
|
+
SENSITIVE = []
|
1944
|
+
include Aws::Structure
|
1945
|
+
end
|
1946
|
+
|
1947
|
+
# @!attribute [rw] projects
|
1948
|
+
# A list of projects that are defined in the current AWS account.
|
1949
|
+
# @return [Array<Types::Project>]
|
1950
|
+
#
|
1951
|
+
# @!attribute [rw] next_token
|
1952
|
+
# A token generated by DataBrew that specifies where to continue
|
1953
|
+
# pagination if a previous request was truncated. To get the next set
|
1954
|
+
# of pages, pass in the NextToken value from the response object of
|
1955
|
+
# the previous page call.
|
1956
|
+
# @return [String]
|
1957
|
+
#
|
1958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListProjectsResponse AWS API Documentation
|
1959
|
+
#
|
1960
|
+
class ListProjectsResponse < Struct.new(
|
1961
|
+
:projects,
|
1962
|
+
:next_token)
|
1963
|
+
SENSITIVE = []
|
1964
|
+
include Aws::Structure
|
1965
|
+
end
|
1966
|
+
|
1967
|
+
# @note When making an API call, you may pass ListRecipeVersionsRequest
|
1968
|
+
# data as a hash:
|
1969
|
+
#
|
1970
|
+
# {
|
1971
|
+
# max_results: 1,
|
1972
|
+
# next_token: "NextToken",
|
1973
|
+
# name: "RecipeName", # required
|
1974
|
+
# }
|
1975
|
+
#
|
1976
|
+
# @!attribute [rw] max_results
|
1977
|
+
# The maximum number of results to return in this request.
|
1978
|
+
# @return [Integer]
|
1979
|
+
#
|
1980
|
+
# @!attribute [rw] next_token
|
1981
|
+
# A pagination token that can be used in a subsequent request.
|
1982
|
+
# @return [String]
|
1983
|
+
#
|
1984
|
+
# @!attribute [rw] name
|
1985
|
+
# The name of the recipe for which to return version information.
|
1986
|
+
# @return [String]
|
1987
|
+
#
|
1988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRecipeVersionsRequest AWS API Documentation
|
1989
|
+
#
|
1990
|
+
class ListRecipeVersionsRequest < Struct.new(
|
1991
|
+
:max_results,
|
1992
|
+
:next_token,
|
1993
|
+
:name)
|
1994
|
+
SENSITIVE = []
|
1995
|
+
include Aws::Structure
|
1996
|
+
end
|
1997
|
+
|
1998
|
+
# @!attribute [rw] next_token
|
1999
|
+
# A token generated by DataBrew that specifies where to continue
|
2000
|
+
# pagination if a previous request was truncated. To get the next set
|
2001
|
+
# of pages, pass in the NextToken value from the response object of
|
2002
|
+
# the previous page call.
|
2003
|
+
# @return [String]
|
2004
|
+
#
|
2005
|
+
# @!attribute [rw] recipes
|
2006
|
+
# A list of versions for the specified recipe.
|
2007
|
+
# @return [Array<Types::Recipe>]
|
2008
|
+
#
|
2009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRecipeVersionsResponse AWS API Documentation
|
2010
|
+
#
|
2011
|
+
class ListRecipeVersionsResponse < Struct.new(
|
2012
|
+
:next_token,
|
2013
|
+
:recipes)
|
2014
|
+
SENSITIVE = []
|
2015
|
+
include Aws::Structure
|
2016
|
+
end
|
2017
|
+
|
2018
|
+
# @note When making an API call, you may pass ListRecipesRequest
|
2019
|
+
# data as a hash:
|
2020
|
+
#
|
2021
|
+
# {
|
2022
|
+
# max_results: 1,
|
2023
|
+
# next_token: "NextToken",
|
2024
|
+
# recipe_version: "RecipeVersion",
|
2025
|
+
# }
|
2026
|
+
#
|
2027
|
+
# @!attribute [rw] max_results
|
2028
|
+
# The maximum number of results to return in this request.
|
2029
|
+
# @return [Integer]
|
2030
|
+
#
|
2031
|
+
# @!attribute [rw] next_token
|
2032
|
+
# A pagination token that can be used in a subsequent request.
|
2033
|
+
# @return [String]
|
2034
|
+
#
|
2035
|
+
# @!attribute [rw] recipe_version
|
2036
|
+
# A version identifier. Using this parameter indicates to return only
|
2037
|
+
# those recipes that have this version identifier.
|
2038
|
+
# @return [String]
|
2039
|
+
#
|
2040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRecipesRequest AWS API Documentation
|
2041
|
+
#
|
2042
|
+
class ListRecipesRequest < Struct.new(
|
2043
|
+
:max_results,
|
2044
|
+
:next_token,
|
2045
|
+
:recipe_version)
|
2046
|
+
SENSITIVE = []
|
2047
|
+
include Aws::Structure
|
2048
|
+
end
|
2049
|
+
|
2050
|
+
# @!attribute [rw] recipes
|
2051
|
+
# A list of recipes that are defined in the current AWS account.
|
2052
|
+
# @return [Array<Types::Recipe>]
|
2053
|
+
#
|
2054
|
+
# @!attribute [rw] next_token
|
2055
|
+
# A token generated by DataBrew that specifies where to continue
|
2056
|
+
# pagination if a previous request was truncated. To get the next set
|
2057
|
+
# of pages, pass in the NextToken value from the response object of
|
2058
|
+
# the previous page call.
|
2059
|
+
# @return [String]
|
2060
|
+
#
|
2061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRecipesResponse AWS API Documentation
|
2062
|
+
#
|
2063
|
+
class ListRecipesResponse < Struct.new(
|
2064
|
+
:recipes,
|
2065
|
+
:next_token)
|
2066
|
+
SENSITIVE = []
|
2067
|
+
include Aws::Structure
|
2068
|
+
end
|
2069
|
+
|
2070
|
+
# @note When making an API call, you may pass ListSchedulesRequest
|
2071
|
+
# data as a hash:
|
2072
|
+
#
|
2073
|
+
# {
|
2074
|
+
# job_name: "JobName",
|
2075
|
+
# max_results: 1,
|
2076
|
+
# next_token: "NextToken",
|
2077
|
+
# }
|
2078
|
+
#
|
2079
|
+
# @!attribute [rw] job_name
|
2080
|
+
# The name of the job that these schedules apply to.
|
2081
|
+
# @return [String]
|
2082
|
+
#
|
2083
|
+
# @!attribute [rw] max_results
|
2084
|
+
# The maximum number of results to return in this request.
|
2085
|
+
# @return [Integer]
|
2086
|
+
#
|
2087
|
+
# @!attribute [rw] next_token
|
2088
|
+
# A pagination token that can be used in a subsequent request.
|
2089
|
+
# @return [String]
|
2090
|
+
#
|
2091
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListSchedulesRequest AWS API Documentation
|
2092
|
+
#
|
2093
|
+
class ListSchedulesRequest < Struct.new(
|
2094
|
+
:job_name,
|
2095
|
+
:max_results,
|
2096
|
+
:next_token)
|
2097
|
+
SENSITIVE = []
|
2098
|
+
include Aws::Structure
|
2099
|
+
end
|
2100
|
+
|
2101
|
+
# @!attribute [rw] schedules
|
2102
|
+
# A list of schedules in the current AWS account.
|
2103
|
+
# @return [Array<Types::Schedule>]
|
2104
|
+
#
|
2105
|
+
# @!attribute [rw] next_token
|
2106
|
+
# A token generated by DataBrew that specifies where to continue
|
2107
|
+
# pagination if a previous request was truncated. To get the next set
|
2108
|
+
# of pages, pass in the NextToken value from the response object of
|
2109
|
+
# the previous page call.
|
2110
|
+
# @return [String]
|
2111
|
+
#
|
2112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListSchedulesResponse AWS API Documentation
|
2113
|
+
#
|
2114
|
+
class ListSchedulesResponse < Struct.new(
|
2115
|
+
:schedules,
|
2116
|
+
:next_token)
|
2117
|
+
SENSITIVE = []
|
2118
|
+
include Aws::Structure
|
2119
|
+
end
|
2120
|
+
|
2121
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
2122
|
+
# data as a hash:
|
2123
|
+
#
|
2124
|
+
# {
|
2125
|
+
# resource_arn: "Arn", # required
|
2126
|
+
# }
|
2127
|
+
#
|
2128
|
+
# @!attribute [rw] resource_arn
|
2129
|
+
# The Amazon Resource Name (ARN) string that uniquely identifies the
|
2130
|
+
# DataBrew resource.
|
2131
|
+
# @return [String]
|
2132
|
+
#
|
2133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListTagsForResourceRequest AWS API Documentation
|
2134
|
+
#
|
2135
|
+
class ListTagsForResourceRequest < Struct.new(
|
2136
|
+
:resource_arn)
|
2137
|
+
SENSITIVE = []
|
2138
|
+
include Aws::Structure
|
2139
|
+
end
|
2140
|
+
|
2141
|
+
# @!attribute [rw] tags
|
2142
|
+
# A list of tags associated with the DataBrew resource.
|
2143
|
+
# @return [Hash<String,String>]
|
2144
|
+
#
|
2145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListTagsForResourceResponse AWS API Documentation
|
2146
|
+
#
|
2147
|
+
class ListTagsForResourceResponse < Struct.new(
|
2148
|
+
:tags)
|
2149
|
+
SENSITIVE = []
|
2150
|
+
include Aws::Structure
|
2151
|
+
end
|
2152
|
+
|
2153
|
+
# Represents individual output from a particular job run.
|
2154
|
+
#
|
2155
|
+
# @note When making an API call, you may pass Output
|
2156
|
+
# data as a hash:
|
2157
|
+
#
|
2158
|
+
# {
|
2159
|
+
# compression_format: "GZIP", # accepts GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB
|
2160
|
+
# format: "CSV", # accepts CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML
|
2161
|
+
# partition_columns: ["ColumnName"],
|
2162
|
+
# location: { # required
|
2163
|
+
# bucket: "Bucket", # required
|
2164
|
+
# key: "Key",
|
2165
|
+
# },
|
2166
|
+
# overwrite: false,
|
2167
|
+
# }
|
2168
|
+
#
|
2169
|
+
# @!attribute [rw] compression_format
|
2170
|
+
# The compression algorithm used to compress the output text of the
|
2171
|
+
# job.
|
2172
|
+
# @return [String]
|
2173
|
+
#
|
2174
|
+
# @!attribute [rw] format
|
2175
|
+
# The data format of the output of the job.
|
2176
|
+
# @return [String]
|
2177
|
+
#
|
2178
|
+
# @!attribute [rw] partition_columns
|
2179
|
+
# The names of one or more partition columns for the output of the
|
2180
|
+
# job.
|
2181
|
+
# @return [Array<String>]
|
2182
|
+
#
|
2183
|
+
# @!attribute [rw] location
|
2184
|
+
# The location in Amazon S3 where the job writes its output.
|
2185
|
+
# @return [Types::S3Location]
|
2186
|
+
#
|
2187
|
+
# @!attribute [rw] overwrite
|
2188
|
+
# A value that, if true, means that any data in the location specified
|
2189
|
+
# for output is overwritten with new output.
|
2190
|
+
# @return [Boolean]
|
2191
|
+
#
|
2192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/Output AWS API Documentation
|
2193
|
+
#
|
2194
|
+
class Output < Struct.new(
|
2195
|
+
:compression_format,
|
2196
|
+
:format,
|
2197
|
+
:partition_columns,
|
2198
|
+
:location,
|
2199
|
+
:overwrite)
|
2200
|
+
SENSITIVE = []
|
2201
|
+
include Aws::Structure
|
2202
|
+
end
|
2203
|
+
|
2204
|
+
# Represents all of the attributes of an AWS Glue DataBrew project.
|
2205
|
+
#
|
2206
|
+
# @!attribute [rw] account_id
|
2207
|
+
# The ID of the AWS account that owns the project.
|
2208
|
+
# @return [String]
|
2209
|
+
#
|
2210
|
+
# @!attribute [rw] create_date
|
2211
|
+
# The date and time that the project was created.
|
2212
|
+
# @return [Time]
|
2213
|
+
#
|
2214
|
+
# @!attribute [rw] created_by
|
2215
|
+
# The identifier (the user name) of the user who crated the project.
|
2216
|
+
# @return [String]
|
2217
|
+
#
|
2218
|
+
# @!attribute [rw] dataset_name
|
2219
|
+
# The dataset that the project is to act upon.
|
2220
|
+
# @return [String]
|
2221
|
+
#
|
2222
|
+
# @!attribute [rw] last_modified_date
|
2223
|
+
# The last modification date and time for the project.
|
2224
|
+
# @return [Time]
|
2225
|
+
#
|
2226
|
+
# @!attribute [rw] last_modified_by
|
2227
|
+
# The identifier (user name) of the user who last modified the
|
2228
|
+
# project.
|
2229
|
+
# @return [String]
|
2230
|
+
#
|
2231
|
+
# @!attribute [rw] name
|
2232
|
+
# The unique name of a project.
|
2233
|
+
# @return [String]
|
2234
|
+
#
|
2235
|
+
# @!attribute [rw] recipe_name
|
2236
|
+
# The name of a recipe that will be developed during a project
|
2237
|
+
# session.
|
2238
|
+
# @return [String]
|
2239
|
+
#
|
2240
|
+
# @!attribute [rw] resource_arn
|
2241
|
+
# The Amazon Resource Name (ARN) for the project.
|
2242
|
+
# @return [String]
|
2243
|
+
#
|
2244
|
+
# @!attribute [rw] sample
|
2245
|
+
# The sample size and sampling type to apply to the data. If this
|
2246
|
+
# parameter isn't specified, then the sample will consiste of the
|
2247
|
+
# first 500 rows from the dataset.
|
2248
|
+
# @return [Types::Sample]
|
2249
|
+
#
|
2250
|
+
# @!attribute [rw] tags
|
2251
|
+
# Metadata tags that have been applied to the project.
|
2252
|
+
# @return [Hash<String,String>]
|
2253
|
+
#
|
2254
|
+
# @!attribute [rw] role_arn
|
2255
|
+
# The Amazon Resource Name (ARN) of the role that will be assumed for
|
2256
|
+
# this project.
|
2257
|
+
# @return [String]
|
2258
|
+
#
|
2259
|
+
# @!attribute [rw] opened_by
|
2260
|
+
# The identifier (the user name) of the user that opened the project
|
2261
|
+
# for use.
|
2262
|
+
# @return [String]
|
2263
|
+
#
|
2264
|
+
# @!attribute [rw] open_date
|
2265
|
+
# The date and time when the project was opened.
|
2266
|
+
# @return [Time]
|
2267
|
+
#
|
2268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/Project AWS API Documentation
|
2269
|
+
#
|
2270
|
+
class Project < Struct.new(
|
2271
|
+
:account_id,
|
2272
|
+
:create_date,
|
2273
|
+
:created_by,
|
2274
|
+
:dataset_name,
|
2275
|
+
:last_modified_date,
|
2276
|
+
:last_modified_by,
|
2277
|
+
:name,
|
2278
|
+
:recipe_name,
|
2279
|
+
:resource_arn,
|
2280
|
+
:sample,
|
2281
|
+
:tags,
|
2282
|
+
:role_arn,
|
2283
|
+
:opened_by,
|
2284
|
+
:open_date)
|
2285
|
+
SENSITIVE = []
|
2286
|
+
include Aws::Structure
|
2287
|
+
end
|
2288
|
+
|
2289
|
+
# @note When making an API call, you may pass PublishRecipeRequest
|
2290
|
+
# data as a hash:
|
2291
|
+
#
|
2292
|
+
# {
|
2293
|
+
# description: "RecipeDescription",
|
2294
|
+
# name: "RecipeName", # required
|
2295
|
+
# }
|
2296
|
+
#
|
2297
|
+
# @!attribute [rw] description
|
2298
|
+
# A description of the recipe to be published, for this version of the
|
2299
|
+
# recipe.
|
2300
|
+
# @return [String]
|
2301
|
+
#
|
2302
|
+
# @!attribute [rw] name
|
2303
|
+
# The name of the recipe to be published.
|
2304
|
+
# @return [String]
|
2305
|
+
#
|
2306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/PublishRecipeRequest AWS API Documentation
|
2307
|
+
#
|
2308
|
+
class PublishRecipeRequest < Struct.new(
|
2309
|
+
:description,
|
2310
|
+
:name)
|
2311
|
+
SENSITIVE = []
|
2312
|
+
include Aws::Structure
|
2313
|
+
end
|
2314
|
+
|
2315
|
+
# @!attribute [rw] name
|
2316
|
+
# The name of the recipe that you published.
|
2317
|
+
# @return [String]
|
2318
|
+
#
|
2319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/PublishRecipeResponse AWS API Documentation
|
2320
|
+
#
|
2321
|
+
class PublishRecipeResponse < Struct.new(
|
2322
|
+
:name)
|
2323
|
+
SENSITIVE = []
|
2324
|
+
include Aws::Structure
|
2325
|
+
end
|
2326
|
+
|
2327
|
+
# Represents one or more actions to be performed on an AWS Glue DataBrew
|
2328
|
+
# dataset.
|
2329
|
+
#
|
2330
|
+
# @!attribute [rw] created_by
|
2331
|
+
# The identifier (the user name) of the user who created the recipe.
|
2332
|
+
# @return [String]
|
2333
|
+
#
|
2334
|
+
# @!attribute [rw] create_date
|
2335
|
+
# The date and time that the recipe was created.
|
2336
|
+
# @return [Time]
|
2337
|
+
#
|
2338
|
+
# @!attribute [rw] last_modified_by
|
2339
|
+
# The identifier (user name) of the user who last modified the recipe.
|
2340
|
+
# @return [String]
|
2341
|
+
#
|
2342
|
+
# @!attribute [rw] last_modified_date
|
2343
|
+
# The last modification date and time of the recipe.
|
2344
|
+
# @return [Time]
|
2345
|
+
#
|
2346
|
+
# @!attribute [rw] project_name
|
2347
|
+
# The name of the project that the recipe is associated with.
|
2348
|
+
# @return [String]
|
2349
|
+
#
|
2350
|
+
# @!attribute [rw] published_by
|
2351
|
+
# The identifier (the user name) of the user who published the recipe.
|
2352
|
+
# @return [String]
|
2353
|
+
#
|
2354
|
+
# @!attribute [rw] published_date
|
2355
|
+
# The date and time when the recipe was published.
|
2356
|
+
# @return [Time]
|
2357
|
+
#
|
2358
|
+
# @!attribute [rw] description
|
2359
|
+
# The description of the recipe.
|
2360
|
+
# @return [String]
|
2361
|
+
#
|
2362
|
+
# @!attribute [rw] name
|
2363
|
+
# The unique name for the recipe.
|
2364
|
+
# @return [String]
|
2365
|
+
#
|
2366
|
+
# @!attribute [rw] resource_arn
|
2367
|
+
# The Amazon Resource Name (ARN) for the recipe.
|
2368
|
+
# @return [String]
|
2369
|
+
#
|
2370
|
+
# @!attribute [rw] steps
|
2371
|
+
# A list of steps that are defined by the recipe.
|
2372
|
+
# @return [Array<Types::RecipeStep>]
|
2373
|
+
#
|
2374
|
+
# @!attribute [rw] tags
|
2375
|
+
# Metadata tags that have been applied to the recipe.
|
2376
|
+
# @return [Hash<String,String>]
|
2377
|
+
#
|
2378
|
+
# @!attribute [rw] recipe_version
|
2379
|
+
# The identifier for the version for the recipe.
|
2380
|
+
# @return [String]
|
2381
|
+
#
|
2382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/Recipe AWS API Documentation
|
2383
|
+
#
|
2384
|
+
class Recipe < Struct.new(
|
2385
|
+
:created_by,
|
2386
|
+
:create_date,
|
2387
|
+
:last_modified_by,
|
2388
|
+
:last_modified_date,
|
2389
|
+
:project_name,
|
2390
|
+
:published_by,
|
2391
|
+
:published_date,
|
2392
|
+
:description,
|
2393
|
+
:name,
|
2394
|
+
:resource_arn,
|
2395
|
+
:steps,
|
2396
|
+
:tags,
|
2397
|
+
:recipe_version)
|
2398
|
+
SENSITIVE = []
|
2399
|
+
include Aws::Structure
|
2400
|
+
end
|
2401
|
+
|
2402
|
+
# Represents a transformation and associated parameters that are used to
|
2403
|
+
# apply a change to an AWS Glue DataBrew dataset. For more information,
|
2404
|
+
# see [Recipe structure][1] and [ecipe actions reference][2] .
|
2405
|
+
#
|
2406
|
+
#
|
2407
|
+
#
|
2408
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html
|
2409
|
+
# [2]: https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html
|
2410
|
+
#
|
2411
|
+
# @note When making an API call, you may pass RecipeAction
|
2412
|
+
# data as a hash:
|
2413
|
+
#
|
2414
|
+
# {
|
2415
|
+
# operation: "Operation", # required
|
2416
|
+
# parameters: {
|
2417
|
+
# "ParameterName" => "ParameterValue",
|
2418
|
+
# },
|
2419
|
+
# }
|
2420
|
+
#
|
2421
|
+
# @!attribute [rw] operation
|
2422
|
+
# The name of a valid DataBrew transformation to be performed on the
|
2423
|
+
# data.
|
2424
|
+
# @return [String]
|
2425
|
+
#
|
2426
|
+
# @!attribute [rw] parameters
|
2427
|
+
# Contextual parameters for the transformation.
|
2428
|
+
# @return [Hash<String,String>]
|
2429
|
+
#
|
2430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/RecipeAction AWS API Documentation
|
2431
|
+
#
|
2432
|
+
class RecipeAction < Struct.new(
|
2433
|
+
:operation,
|
2434
|
+
:parameters)
|
2435
|
+
SENSITIVE = []
|
2436
|
+
include Aws::Structure
|
2437
|
+
end
|
2438
|
+
|
2439
|
+
# Represents all of the attributes of an AWS Glue DataBrew recipe.
|
2440
|
+
#
|
2441
|
+
# @note When making an API call, you may pass RecipeReference
|
2442
|
+
# data as a hash:
|
2443
|
+
#
|
2444
|
+
# {
|
2445
|
+
# name: "RecipeName", # required
|
2446
|
+
# recipe_version: "RecipeVersion",
|
2447
|
+
# }
|
2448
|
+
#
|
2449
|
+
# @!attribute [rw] name
|
2450
|
+
# The name of the recipe.
|
2451
|
+
# @return [String]
|
2452
|
+
#
|
2453
|
+
# @!attribute [rw] recipe_version
|
2454
|
+
# The identifier for the version for the recipe.
|
2455
|
+
# @return [String]
|
2456
|
+
#
|
2457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/RecipeReference AWS API Documentation
|
2458
|
+
#
|
2459
|
+
class RecipeReference < Struct.new(
|
2460
|
+
:name,
|
2461
|
+
:recipe_version)
|
2462
|
+
SENSITIVE = []
|
2463
|
+
include Aws::Structure
|
2464
|
+
end
|
2465
|
+
|
2466
|
+
# Represents a single step to be performed in an AWS Glue DataBrew
|
2467
|
+
# recipe.
|
2468
|
+
#
|
2469
|
+
# @note When making an API call, you may pass RecipeStep
|
2470
|
+
# data as a hash:
|
2471
|
+
#
|
2472
|
+
# {
|
2473
|
+
# action: { # required
|
2474
|
+
# operation: "Operation", # required
|
2475
|
+
# parameters: {
|
2476
|
+
# "ParameterName" => "ParameterValue",
|
2477
|
+
# },
|
2478
|
+
# },
|
2479
|
+
# condition_expressions: [
|
2480
|
+
# {
|
2481
|
+
# condition: "Condition", # required
|
2482
|
+
# value: "ConditionValue",
|
2483
|
+
# target_column: "TargetColumn", # required
|
2484
|
+
# },
|
2485
|
+
# ],
|
2486
|
+
# }
|
2487
|
+
#
|
2488
|
+
# @!attribute [rw] action
|
2489
|
+
# The particular action to be performed in the recipe step.
|
2490
|
+
# @return [Types::RecipeAction]
|
2491
|
+
#
|
2492
|
+
# @!attribute [rw] condition_expressions
|
2493
|
+
# One or more conditions that must be met, in order for the recipe
|
2494
|
+
# step to succeed.
|
2495
|
+
#
|
2496
|
+
# <note markdown="1"> All of the conditions in the array must be met. In other words, all
|
2497
|
+
# of the conditions must be combined using a logical AND operation.
|
2498
|
+
#
|
2499
|
+
# </note>
|
2500
|
+
# @return [Array<Types::ConditionExpression>]
|
2501
|
+
#
|
2502
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/RecipeStep AWS API Documentation
|
2503
|
+
#
|
2504
|
+
class RecipeStep < Struct.new(
|
2505
|
+
:action,
|
2506
|
+
:condition_expressions)
|
2507
|
+
SENSITIVE = []
|
2508
|
+
include Aws::Structure
|
2509
|
+
end
|
2510
|
+
|
2511
|
+
# Represents any errors encountered when attempting to delete multiple
|
2512
|
+
# recipe versions.
|
2513
|
+
#
|
2514
|
+
# @!attribute [rw] error_code
|
2515
|
+
# The HTTP status code for the error.
|
2516
|
+
# @return [String]
|
2517
|
+
#
|
2518
|
+
# @!attribute [rw] error_message
|
2519
|
+
# The text of the error message.
|
2520
|
+
# @return [String]
|
2521
|
+
#
|
2522
|
+
# @!attribute [rw] recipe_version
|
2523
|
+
# The identifier for the recipe version associated with this error.
|
2524
|
+
# @return [String]
|
2525
|
+
#
|
2526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/RecipeVersionErrorDetail AWS API Documentation
|
2527
|
+
#
|
2528
|
+
class RecipeVersionErrorDetail < Struct.new(
|
2529
|
+
:error_code,
|
2530
|
+
:error_message,
|
2531
|
+
:recipe_version)
|
2532
|
+
SENSITIVE = []
|
2533
|
+
include Aws::Structure
|
2534
|
+
end
|
2535
|
+
|
2536
|
+
# One or more resources can't be found.
|
2537
|
+
#
|
2538
|
+
# @!attribute [rw] message
|
2539
|
+
# @return [String]
|
2540
|
+
#
|
2541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ResourceNotFoundException AWS API Documentation
|
2542
|
+
#
|
2543
|
+
class ResourceNotFoundException < Struct.new(
|
2544
|
+
:message)
|
2545
|
+
SENSITIVE = []
|
2546
|
+
include Aws::Structure
|
2547
|
+
end
|
2548
|
+
|
2549
|
+
# An Amazon S3 location (bucket name an object key) where DataBrew can
|
2550
|
+
# read input data, or write output from a job.
|
2551
|
+
#
|
2552
|
+
# @note When making an API call, you may pass S3Location
|
2553
|
+
# data as a hash:
|
2554
|
+
#
|
2555
|
+
# {
|
2556
|
+
# bucket: "Bucket", # required
|
2557
|
+
# key: "Key",
|
2558
|
+
# }
|
2559
|
+
#
|
2560
|
+
# @!attribute [rw] bucket
|
2561
|
+
# The S3 bucket name.
|
2562
|
+
# @return [String]
|
2563
|
+
#
|
2564
|
+
# @!attribute [rw] key
|
2565
|
+
# The unique name of the object in the bucket.
|
2566
|
+
# @return [String]
|
2567
|
+
#
|
2568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/S3Location AWS API Documentation
|
2569
|
+
#
|
2570
|
+
class S3Location < Struct.new(
|
2571
|
+
:bucket,
|
2572
|
+
:key)
|
2573
|
+
SENSITIVE = []
|
2574
|
+
include Aws::Structure
|
2575
|
+
end
|
2576
|
+
|
2577
|
+
# Represents the sample size and sampling type for AWS Glue DataBrew to
|
2578
|
+
# use for interactive data analysis.
|
2579
|
+
#
|
2580
|
+
# @note When making an API call, you may pass Sample
|
2581
|
+
# data as a hash:
|
2582
|
+
#
|
2583
|
+
# {
|
2584
|
+
# size: 1,
|
2585
|
+
# type: "FIRST_N", # required, accepts FIRST_N, LAST_N, RANDOM
|
2586
|
+
# }
|
2587
|
+
#
|
2588
|
+
# @!attribute [rw] size
|
2589
|
+
# The number of rows in the sample.
|
2590
|
+
# @return [Integer]
|
2591
|
+
#
|
2592
|
+
# @!attribute [rw] type
|
2593
|
+
# The way in which DataBrew obtains rows from a dataset.
|
2594
|
+
# @return [String]
|
2595
|
+
#
|
2596
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/Sample AWS API Documentation
|
2597
|
+
#
|
2598
|
+
class Sample < Struct.new(
|
2599
|
+
:size,
|
2600
|
+
:type)
|
2601
|
+
SENSITIVE = []
|
2602
|
+
include Aws::Structure
|
2603
|
+
end
|
2604
|
+
|
2605
|
+
# Represents one or more dates and times when a job is to run.
|
2606
|
+
#
|
2607
|
+
# @!attribute [rw] account_id
|
2608
|
+
# The ID of the AWS account that owns the schedule.
|
2609
|
+
# @return [String]
|
2610
|
+
#
|
2611
|
+
# @!attribute [rw] created_by
|
2612
|
+
# The identifier (the user name) of the user who created the schedule.
|
2613
|
+
# @return [String]
|
2614
|
+
#
|
2615
|
+
# @!attribute [rw] create_date
|
2616
|
+
# The date and time that the schedule was created.
|
2617
|
+
# @return [Time]
|
2618
|
+
#
|
2619
|
+
# @!attribute [rw] job_names
|
2620
|
+
# A list of jobs to be run, according to the schedule.
|
2621
|
+
# @return [Array<String>]
|
2622
|
+
#
|
2623
|
+
# @!attribute [rw] last_modified_by
|
2624
|
+
# The identifier (the user name) of the user who last modified the
|
2625
|
+
# schedule.
|
2626
|
+
# @return [String]
|
2627
|
+
#
|
2628
|
+
# @!attribute [rw] last_modified_date
|
2629
|
+
# The date and time when the schedule was last modified.
|
2630
|
+
# @return [Time]
|
2631
|
+
#
|
2632
|
+
# @!attribute [rw] resource_arn
|
2633
|
+
# The Amazon Resource Name (ARN) of the schedule.
|
2634
|
+
# @return [String]
|
2635
|
+
#
|
2636
|
+
# @!attribute [rw] cron_expression
|
2637
|
+
# The date(s) and time(s), in `cron` format, when the job will run.
|
2638
|
+
# @return [String]
|
2639
|
+
#
|
2640
|
+
# @!attribute [rw] tags
|
2641
|
+
# Metadata tags that have been applied to the schedule.
|
2642
|
+
# @return [Hash<String,String>]
|
2643
|
+
#
|
2644
|
+
# @!attribute [rw] name
|
2645
|
+
# The name of the schedule.
|
2646
|
+
# @return [String]
|
2647
|
+
#
|
2648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/Schedule AWS API Documentation
|
2649
|
+
#
|
2650
|
+
class Schedule < Struct.new(
|
2651
|
+
:account_id,
|
2652
|
+
:created_by,
|
2653
|
+
:create_date,
|
2654
|
+
:job_names,
|
2655
|
+
:last_modified_by,
|
2656
|
+
:last_modified_date,
|
2657
|
+
:resource_arn,
|
2658
|
+
:cron_expression,
|
2659
|
+
:tags,
|
2660
|
+
:name)
|
2661
|
+
SENSITIVE = []
|
2662
|
+
include Aws::Structure
|
2663
|
+
end
|
2664
|
+
|
2665
|
+
# @note When making an API call, you may pass SendProjectSessionActionRequest
|
2666
|
+
# data as a hash:
|
2667
|
+
#
|
2668
|
+
# {
|
2669
|
+
# preview: false,
|
2670
|
+
# name: "ProjectName", # required
|
2671
|
+
# recipe_step: {
|
2672
|
+
# action: { # required
|
2673
|
+
# operation: "Operation", # required
|
2674
|
+
# parameters: {
|
2675
|
+
# "ParameterName" => "ParameterValue",
|
2676
|
+
# },
|
2677
|
+
# },
|
2678
|
+
# condition_expressions: [
|
2679
|
+
# {
|
2680
|
+
# condition: "Condition", # required
|
2681
|
+
# value: "ConditionValue",
|
2682
|
+
# target_column: "TargetColumn", # required
|
2683
|
+
# },
|
2684
|
+
# ],
|
2685
|
+
# },
|
2686
|
+
# step_index: 1,
|
2687
|
+
# client_session_id: "ClientSessionId",
|
2688
|
+
# view_frame: {
|
2689
|
+
# start_column_index: 1, # required
|
2690
|
+
# column_range: 1,
|
2691
|
+
# hidden_columns: ["ColumnName"],
|
2692
|
+
# },
|
2693
|
+
# }
|
2694
|
+
#
|
2695
|
+
# @!attribute [rw] preview
|
2696
|
+
# Returns the result of the recipe step, without applying it. The
|
2697
|
+
# result isn't added to the view frame stack.
|
2698
|
+
# @return [Boolean]
|
2699
|
+
#
|
2700
|
+
# @!attribute [rw] name
|
2701
|
+
# The name of the project to apply the action to.
|
2702
|
+
# @return [String]
|
2703
|
+
#
|
2704
|
+
# @!attribute [rw] recipe_step
|
2705
|
+
# Represents a single step to be performed in an AWS Glue DataBrew
|
2706
|
+
# recipe.
|
2707
|
+
# @return [Types::RecipeStep]
|
2708
|
+
#
|
2709
|
+
# @!attribute [rw] step_index
|
2710
|
+
# The index from which to preview a step. This index is used to
|
2711
|
+
# preview the result of steps that have already been applied, so that
|
2712
|
+
# the resulting view frame is from earlier in the view frame stack.
|
2713
|
+
# @return [Integer]
|
2714
|
+
#
|
2715
|
+
# @!attribute [rw] client_session_id
|
2716
|
+
# A unique identifier for an interactive session that's currently
|
2717
|
+
# open and ready for work. The action will be performed on this
|
2718
|
+
# session.
|
2719
|
+
# @return [String]
|
2720
|
+
#
|
2721
|
+
# @!attribute [rw] view_frame
|
2722
|
+
# Represents the data being being transformed during an AWS Glue
|
2723
|
+
# DataBrew project session.
|
2724
|
+
# @return [Types::ViewFrame]
|
2725
|
+
#
|
2726
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/SendProjectSessionActionRequest AWS API Documentation
|
2727
|
+
#
|
2728
|
+
class SendProjectSessionActionRequest < Struct.new(
|
2729
|
+
:preview,
|
2730
|
+
:name,
|
2731
|
+
:recipe_step,
|
2732
|
+
:step_index,
|
2733
|
+
:client_session_id,
|
2734
|
+
:view_frame)
|
2735
|
+
SENSITIVE = []
|
2736
|
+
include Aws::Structure
|
2737
|
+
end
|
2738
|
+
|
2739
|
+
# @!attribute [rw] result
|
2740
|
+
# A message indicating the result of performing the action.
|
2741
|
+
# @return [String]
|
2742
|
+
#
|
2743
|
+
# @!attribute [rw] name
|
2744
|
+
# The name of the project that was affected by the action.
|
2745
|
+
# @return [String]
|
2746
|
+
#
|
2747
|
+
# @!attribute [rw] action_id
|
2748
|
+
# A unique identifier for the action that was performed.
|
2749
|
+
# @return [Integer]
|
2750
|
+
#
|
2751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/SendProjectSessionActionResponse AWS API Documentation
|
2752
|
+
#
|
2753
|
+
class SendProjectSessionActionResponse < Struct.new(
|
2754
|
+
:result,
|
2755
|
+
:name,
|
2756
|
+
:action_id)
|
2757
|
+
SENSITIVE = []
|
2758
|
+
include Aws::Structure
|
2759
|
+
end
|
2760
|
+
|
2761
|
+
# A service quota is exceeded.
|
2762
|
+
#
|
2763
|
+
# @!attribute [rw] message
|
2764
|
+
# @return [String]
|
2765
|
+
#
|
2766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ServiceQuotaExceededException AWS API Documentation
|
2767
|
+
#
|
2768
|
+
class ServiceQuotaExceededException < Struct.new(
|
2769
|
+
:message)
|
2770
|
+
SENSITIVE = []
|
2771
|
+
include Aws::Structure
|
2772
|
+
end
|
2773
|
+
|
2774
|
+
# @note When making an API call, you may pass StartJobRunRequest
|
2775
|
+
# data as a hash:
|
2776
|
+
#
|
2777
|
+
# {
|
2778
|
+
# name: "JobName", # required
|
2779
|
+
# }
|
2780
|
+
#
|
2781
|
+
# @!attribute [rw] name
|
2782
|
+
# The name of the job to be run.
|
2783
|
+
# @return [String]
|
2784
|
+
#
|
2785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/StartJobRunRequest AWS API Documentation
|
2786
|
+
#
|
2787
|
+
class StartJobRunRequest < Struct.new(
|
2788
|
+
:name)
|
2789
|
+
SENSITIVE = []
|
2790
|
+
include Aws::Structure
|
2791
|
+
end
|
2792
|
+
|
2793
|
+
# @!attribute [rw] run_id
|
2794
|
+
# A system-generated identifier for this particular job run.
|
2795
|
+
# @return [String]
|
2796
|
+
#
|
2797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/StartJobRunResponse AWS API Documentation
|
2798
|
+
#
|
2799
|
+
class StartJobRunResponse < Struct.new(
|
2800
|
+
:run_id)
|
2801
|
+
SENSITIVE = []
|
2802
|
+
include Aws::Structure
|
2803
|
+
end
|
2804
|
+
|
2805
|
+
# @note When making an API call, you may pass StartProjectSessionRequest
|
2806
|
+
# data as a hash:
|
2807
|
+
#
|
2808
|
+
# {
|
2809
|
+
# name: "ProjectName", # required
|
2810
|
+
# assume_control: false,
|
2811
|
+
# }
|
2812
|
+
#
|
2813
|
+
# @!attribute [rw] name
|
2814
|
+
# The name of the project to act upon.
|
2815
|
+
# @return [String]
|
2816
|
+
#
|
2817
|
+
# @!attribute [rw] assume_control
|
2818
|
+
# A value that, if true, enables you to take control of a session,
|
2819
|
+
# even if a different client is currently accessing the project.
|
2820
|
+
# @return [Boolean]
|
2821
|
+
#
|
2822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/StartProjectSessionRequest AWS API Documentation
|
2823
|
+
#
|
2824
|
+
class StartProjectSessionRequest < Struct.new(
|
2825
|
+
:name,
|
2826
|
+
:assume_control)
|
2827
|
+
SENSITIVE = []
|
2828
|
+
include Aws::Structure
|
2829
|
+
end
|
2830
|
+
|
2831
|
+
# @!attribute [rw] name
|
2832
|
+
# The name of the project to be acted upon.
|
2833
|
+
# @return [String]
|
2834
|
+
#
|
2835
|
+
# @!attribute [rw] client_session_id
|
2836
|
+
# A system-generated identifier for the session.
|
2837
|
+
# @return [String]
|
2838
|
+
#
|
2839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/StartProjectSessionResponse AWS API Documentation
|
2840
|
+
#
|
2841
|
+
class StartProjectSessionResponse < Struct.new(
|
2842
|
+
:name,
|
2843
|
+
:client_session_id)
|
2844
|
+
SENSITIVE = []
|
2845
|
+
include Aws::Structure
|
2846
|
+
end
|
2847
|
+
|
2848
|
+
# @note When making an API call, you may pass StopJobRunRequest
|
2849
|
+
# data as a hash:
|
2850
|
+
#
|
2851
|
+
# {
|
2852
|
+
# name: "JobName", # required
|
2853
|
+
# run_id: "JobRunId", # required
|
2854
|
+
# }
|
2855
|
+
#
|
2856
|
+
# @!attribute [rw] name
|
2857
|
+
# The name of the job to be stopped.
|
2858
|
+
# @return [String]
|
2859
|
+
#
|
2860
|
+
# @!attribute [rw] run_id
|
2861
|
+
# The ID of the job run to be stopped.
|
2862
|
+
# @return [String]
|
2863
|
+
#
|
2864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/StopJobRunRequest AWS API Documentation
|
2865
|
+
#
|
2866
|
+
class StopJobRunRequest < Struct.new(
|
2867
|
+
:name,
|
2868
|
+
:run_id)
|
2869
|
+
SENSITIVE = []
|
2870
|
+
include Aws::Structure
|
2871
|
+
end
|
2872
|
+
|
2873
|
+
# @!attribute [rw] run_id
|
2874
|
+
# The ID of the job run that you stopped.
|
2875
|
+
# @return [String]
|
2876
|
+
#
|
2877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/StopJobRunResponse AWS API Documentation
|
2878
|
+
#
|
2879
|
+
class StopJobRunResponse < Struct.new(
|
2880
|
+
:run_id)
|
2881
|
+
SENSITIVE = []
|
2882
|
+
include Aws::Structure
|
2883
|
+
end
|
2884
|
+
|
2885
|
+
# @note When making an API call, you may pass TagResourceRequest
|
2886
|
+
# data as a hash:
|
2887
|
+
#
|
2888
|
+
# {
|
2889
|
+
# resource_arn: "Arn", # required
|
2890
|
+
# tags: { # required
|
2891
|
+
# "TagKey" => "TagValue",
|
2892
|
+
# },
|
2893
|
+
# }
|
2894
|
+
#
|
2895
|
+
# @!attribute [rw] resource_arn
|
2896
|
+
# The DataBrew resource to which tags should be added. The value for
|
2897
|
+
# this parameter is an Amazon Resource Name (ARN). For DataBrew, you
|
2898
|
+
# can tag a dataset, a job, a project, or a recipe.
|
2899
|
+
# @return [String]
|
2900
|
+
#
|
2901
|
+
# @!attribute [rw] tags
|
2902
|
+
# One or more tags to be assigned to the resource.
|
2903
|
+
# @return [Hash<String,String>]
|
2904
|
+
#
|
2905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/TagResourceRequest AWS API Documentation
|
2906
|
+
#
|
2907
|
+
class TagResourceRequest < Struct.new(
|
2908
|
+
:resource_arn,
|
2909
|
+
:tags)
|
2910
|
+
SENSITIVE = []
|
2911
|
+
include Aws::Structure
|
2912
|
+
end
|
2913
|
+
|
2914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/TagResourceResponse AWS API Documentation
|
2915
|
+
#
|
2916
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
2917
|
+
|
2918
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
2919
|
+
# data as a hash:
|
2920
|
+
#
|
2921
|
+
# {
|
2922
|
+
# resource_arn: "Arn", # required
|
2923
|
+
# tag_keys: ["TagKey"], # required
|
2924
|
+
# }
|
2925
|
+
#
|
2926
|
+
# @!attribute [rw] resource_arn
|
2927
|
+
# An DataBrew resource from which you want to remove a tag or tags.
|
2928
|
+
# The value for this parameter is an Amazon Resource Name (ARN).
|
2929
|
+
# @return [String]
|
2930
|
+
#
|
2931
|
+
# @!attribute [rw] tag_keys
|
2932
|
+
# The tag keys (names) of one or more tags to be removed.
|
2933
|
+
# @return [Array<String>]
|
2934
|
+
#
|
2935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UntagResourceRequest AWS API Documentation
|
2936
|
+
#
|
2937
|
+
class UntagResourceRequest < Struct.new(
|
2938
|
+
:resource_arn,
|
2939
|
+
:tag_keys)
|
2940
|
+
SENSITIVE = []
|
2941
|
+
include Aws::Structure
|
2942
|
+
end
|
2943
|
+
|
2944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UntagResourceResponse AWS API Documentation
|
2945
|
+
#
|
2946
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
2947
|
+
|
2948
|
+
# @note When making an API call, you may pass UpdateDatasetRequest
|
2949
|
+
# data as a hash:
|
2950
|
+
#
|
2951
|
+
# {
|
2952
|
+
# name: "DatasetName", # required
|
2953
|
+
# format_options: {
|
2954
|
+
# json: {
|
2955
|
+
# multi_line: false,
|
2956
|
+
# },
|
2957
|
+
# excel: {
|
2958
|
+
# sheet_names: ["SheetName"],
|
2959
|
+
# sheet_indexes: [1],
|
2960
|
+
# },
|
2961
|
+
# },
|
2962
|
+
# input: { # required
|
2963
|
+
# s3_input_definition: {
|
2964
|
+
# bucket: "Bucket", # required
|
2965
|
+
# key: "Key",
|
2966
|
+
# },
|
2967
|
+
# data_catalog_input_definition: {
|
2968
|
+
# catalog_id: "CatalogId",
|
2969
|
+
# database_name: "DatabaseName", # required
|
2970
|
+
# table_name: "TableName", # required
|
2971
|
+
# temp_directory: {
|
2972
|
+
# bucket: "Bucket", # required
|
2973
|
+
# key: "Key",
|
2974
|
+
# },
|
2975
|
+
# },
|
2976
|
+
# },
|
2977
|
+
# }
|
2978
|
+
#
|
2979
|
+
# @!attribute [rw] name
|
2980
|
+
# The name of the dataset to be updated.
|
2981
|
+
# @return [String]
|
2982
|
+
#
|
2983
|
+
# @!attribute [rw] format_options
|
2984
|
+
# Options that define how Microsoft Excel input is to be interpreted
|
2985
|
+
# by DataBrew.
|
2986
|
+
# @return [Types::FormatOptions]
|
2987
|
+
#
|
2988
|
+
# @!attribute [rw] input
|
2989
|
+
# Information on how AWS Glue DataBrew can find data, in either the
|
2990
|
+
# AWS Glue Data Catalog or Amazon S3.
|
2991
|
+
# @return [Types::Input]
|
2992
|
+
#
|
2993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateDatasetRequest AWS API Documentation
|
2994
|
+
#
|
2995
|
+
class UpdateDatasetRequest < Struct.new(
|
2996
|
+
:name,
|
2997
|
+
:format_options,
|
2998
|
+
:input)
|
2999
|
+
SENSITIVE = []
|
3000
|
+
include Aws::Structure
|
3001
|
+
end
|
3002
|
+
|
3003
|
+
# @!attribute [rw] name
|
3004
|
+
# The name of the dataset that you updated.
|
3005
|
+
# @return [String]
|
3006
|
+
#
|
3007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateDatasetResponse AWS API Documentation
|
3008
|
+
#
|
3009
|
+
class UpdateDatasetResponse < Struct.new(
|
3010
|
+
:name)
|
3011
|
+
SENSITIVE = []
|
3012
|
+
include Aws::Structure
|
3013
|
+
end
|
3014
|
+
|
3015
|
+
# @note When making an API call, you may pass UpdateProfileJobRequest
|
3016
|
+
# data as a hash:
|
3017
|
+
#
|
3018
|
+
# {
|
3019
|
+
# encryption_key_arn: "EncryptionKeyArn",
|
3020
|
+
# encryption_mode: "SSE-KMS", # accepts SSE-KMS, SSE-S3
|
3021
|
+
# name: "JobName", # required
|
3022
|
+
# log_subscription: "ENABLE", # accepts ENABLE, DISABLE
|
3023
|
+
# max_capacity: 1,
|
3024
|
+
# max_retries: 1,
|
3025
|
+
# output_location: { # required
|
3026
|
+
# bucket: "Bucket", # required
|
3027
|
+
# key: "Key",
|
3028
|
+
# },
|
3029
|
+
# role_arn: "Arn", # required
|
3030
|
+
# timeout: 1,
|
3031
|
+
# }
|
3032
|
+
#
|
3033
|
+
# @!attribute [rw] encryption_key_arn
|
3034
|
+
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
3035
|
+
# protect the job.
|
3036
|
+
# @return [String]
|
3037
|
+
#
|
3038
|
+
# @!attribute [rw] encryption_mode
|
3039
|
+
# The encryption mode for the job, which can be one of the following:
|
3040
|
+
#
|
3041
|
+
# * `SSE-KMS` - Server-side encryption with AWS KMS-managed keys.
|
3042
|
+
#
|
3043
|
+
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
3044
|
+
# @return [String]
|
3045
|
+
#
|
3046
|
+
# @!attribute [rw] name
|
3047
|
+
# The name of the job to be updated.
|
3048
|
+
# @return [String]
|
3049
|
+
#
|
3050
|
+
# @!attribute [rw] log_subscription
|
3051
|
+
# A value that enables or disables Amazon CloudWatch logging for the
|
3052
|
+
# current AWS account. If logging is enabled, CloudWatch writes one
|
3053
|
+
# log stream for each job run.
|
3054
|
+
# @return [String]
|
3055
|
+
#
|
3056
|
+
# @!attribute [rw] max_capacity
|
3057
|
+
# The maximum number of nodes that DataBrew can use when the job
|
3058
|
+
# processes data.
|
3059
|
+
# @return [Integer]
|
3060
|
+
#
|
3061
|
+
# @!attribute [rw] max_retries
|
3062
|
+
# The maximum number of times to retry the job after a job run fails.
|
3063
|
+
# @return [Integer]
|
3064
|
+
#
|
3065
|
+
# @!attribute [rw] output_location
|
3066
|
+
# An Amazon S3 location (bucket name an object key) where DataBrew can
|
3067
|
+
# read input data, or write output from a job.
|
3068
|
+
# @return [Types::S3Location]
|
3069
|
+
#
|
3070
|
+
# @!attribute [rw] role_arn
|
3071
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
3072
|
+
# Management (IAM) role to be assumed for this request.
|
3073
|
+
# @return [String]
|
3074
|
+
#
|
3075
|
+
# @!attribute [rw] timeout
|
3076
|
+
# The job's timeout in minutes. A job that attempts to run longer
|
3077
|
+
# than this timeout period ends with a status of `TIMEOUT`.
|
3078
|
+
# @return [Integer]
|
3079
|
+
#
|
3080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateProfileJobRequest AWS API Documentation
|
3081
|
+
#
|
3082
|
+
class UpdateProfileJobRequest < Struct.new(
|
3083
|
+
:encryption_key_arn,
|
3084
|
+
:encryption_mode,
|
3085
|
+
:name,
|
3086
|
+
:log_subscription,
|
3087
|
+
:max_capacity,
|
3088
|
+
:max_retries,
|
3089
|
+
:output_location,
|
3090
|
+
:role_arn,
|
3091
|
+
:timeout)
|
3092
|
+
SENSITIVE = []
|
3093
|
+
include Aws::Structure
|
3094
|
+
end
|
3095
|
+
|
3096
|
+
# @!attribute [rw] name
|
3097
|
+
# The name of the job that was updated.
|
3098
|
+
# @return [String]
|
3099
|
+
#
|
3100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateProfileJobResponse AWS API Documentation
|
3101
|
+
#
|
3102
|
+
class UpdateProfileJobResponse < Struct.new(
|
3103
|
+
:name)
|
3104
|
+
SENSITIVE = []
|
3105
|
+
include Aws::Structure
|
3106
|
+
end
|
3107
|
+
|
3108
|
+
# @note When making an API call, you may pass UpdateProjectRequest
|
3109
|
+
# data as a hash:
|
3110
|
+
#
|
3111
|
+
# {
|
3112
|
+
# sample: {
|
3113
|
+
# size: 1,
|
3114
|
+
# type: "FIRST_N", # required, accepts FIRST_N, LAST_N, RANDOM
|
3115
|
+
# },
|
3116
|
+
# role_arn: "Arn", # required
|
3117
|
+
# name: "ProjectName", # required
|
3118
|
+
# }
|
3119
|
+
#
|
3120
|
+
# @!attribute [rw] sample
|
3121
|
+
# Represents the sample size and sampling type for AWS Glue DataBrew
|
3122
|
+
# to use for interactive data analysis.
|
3123
|
+
# @return [Types::Sample]
|
3124
|
+
#
|
3125
|
+
# @!attribute [rw] role_arn
|
3126
|
+
# The Amazon Resource Name (ARN) of the IAM role to be assumed for
|
3127
|
+
# this request.
|
3128
|
+
# @return [String]
|
3129
|
+
#
|
3130
|
+
# @!attribute [rw] name
|
3131
|
+
# The name of the project to be updated.
|
3132
|
+
# @return [String]
|
3133
|
+
#
|
3134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateProjectRequest AWS API Documentation
|
3135
|
+
#
|
3136
|
+
class UpdateProjectRequest < Struct.new(
|
3137
|
+
:sample,
|
3138
|
+
:role_arn,
|
3139
|
+
:name)
|
3140
|
+
SENSITIVE = []
|
3141
|
+
include Aws::Structure
|
3142
|
+
end
|
3143
|
+
|
3144
|
+
# @!attribute [rw] last_modified_date
|
3145
|
+
# The date and time that the project was last modified.
|
3146
|
+
# @return [Time]
|
3147
|
+
#
|
3148
|
+
# @!attribute [rw] name
|
3149
|
+
# The name of the project that you updated.
|
3150
|
+
# @return [String]
|
3151
|
+
#
|
3152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateProjectResponse AWS API Documentation
|
3153
|
+
#
|
3154
|
+
class UpdateProjectResponse < Struct.new(
|
3155
|
+
:last_modified_date,
|
3156
|
+
:name)
|
3157
|
+
SENSITIVE = []
|
3158
|
+
include Aws::Structure
|
3159
|
+
end
|
3160
|
+
|
3161
|
+
# @note When making an API call, you may pass UpdateRecipeJobRequest
|
3162
|
+
# data as a hash:
|
3163
|
+
#
|
3164
|
+
# {
|
3165
|
+
# encryption_key_arn: "EncryptionKeyArn",
|
3166
|
+
# encryption_mode: "SSE-KMS", # accepts SSE-KMS, SSE-S3
|
3167
|
+
# name: "JobName", # required
|
3168
|
+
# log_subscription: "ENABLE", # accepts ENABLE, DISABLE
|
3169
|
+
# max_capacity: 1,
|
3170
|
+
# max_retries: 1,
|
3171
|
+
# outputs: [ # required
|
3172
|
+
# {
|
3173
|
+
# compression_format: "GZIP", # accepts GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB
|
3174
|
+
# format: "CSV", # accepts CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML
|
3175
|
+
# partition_columns: ["ColumnName"],
|
3176
|
+
# location: { # required
|
3177
|
+
# bucket: "Bucket", # required
|
3178
|
+
# key: "Key",
|
3179
|
+
# },
|
3180
|
+
# overwrite: false,
|
3181
|
+
# },
|
3182
|
+
# ],
|
3183
|
+
# role_arn: "Arn", # required
|
3184
|
+
# timeout: 1,
|
3185
|
+
# }
|
3186
|
+
#
|
3187
|
+
# @!attribute [rw] encryption_key_arn
|
3188
|
+
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
3189
|
+
# protect the job.
|
3190
|
+
# @return [String]
|
3191
|
+
#
|
3192
|
+
# @!attribute [rw] encryption_mode
|
3193
|
+
# The encryption mode for the job, which can be one of the following:
|
3194
|
+
#
|
3195
|
+
# * `SSE-KMS` - Server-side encryption with AWS KMS-managed keys.
|
3196
|
+
#
|
3197
|
+
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
3198
|
+
# @return [String]
|
3199
|
+
#
|
3200
|
+
# @!attribute [rw] name
|
3201
|
+
# The name of the job to update.
|
3202
|
+
# @return [String]
|
3203
|
+
#
|
3204
|
+
# @!attribute [rw] log_subscription
|
3205
|
+
# A value that enables or disables Amazon CloudWatch logging for the
|
3206
|
+
# current AWS account. If logging is enabled, CloudWatch writes one
|
3207
|
+
# log stream for each job run.
|
3208
|
+
# @return [String]
|
3209
|
+
#
|
3210
|
+
# @!attribute [rw] max_capacity
|
3211
|
+
# The maximum number of nodes that DataBrew can consume when the job
|
3212
|
+
# processes data.
|
3213
|
+
# @return [Integer]
|
3214
|
+
#
|
3215
|
+
# @!attribute [rw] max_retries
|
3216
|
+
# The maximum number of times to retry the job after a job run fails.
|
3217
|
+
# @return [Integer]
|
3218
|
+
#
|
3219
|
+
# @!attribute [rw] outputs
|
3220
|
+
# One or more artifacts that represent the output from running the
|
3221
|
+
# job.
|
3222
|
+
# @return [Array<Types::Output>]
|
3223
|
+
#
|
3224
|
+
# @!attribute [rw] role_arn
|
3225
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
3226
|
+
# Management (IAM) role to be assumed for this request.
|
3227
|
+
# @return [String]
|
3228
|
+
#
|
3229
|
+
# @!attribute [rw] timeout
|
3230
|
+
# The job's timeout in minutes. A job that attempts to run longer
|
3231
|
+
# than this timeout period ends with a status of `TIMEOUT`.
|
3232
|
+
# @return [Integer]
|
3233
|
+
#
|
3234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateRecipeJobRequest AWS API Documentation
|
3235
|
+
#
|
3236
|
+
class UpdateRecipeJobRequest < Struct.new(
|
3237
|
+
:encryption_key_arn,
|
3238
|
+
:encryption_mode,
|
3239
|
+
:name,
|
3240
|
+
:log_subscription,
|
3241
|
+
:max_capacity,
|
3242
|
+
:max_retries,
|
3243
|
+
:outputs,
|
3244
|
+
:role_arn,
|
3245
|
+
:timeout)
|
3246
|
+
SENSITIVE = []
|
3247
|
+
include Aws::Structure
|
3248
|
+
end
|
3249
|
+
|
3250
|
+
# @!attribute [rw] name
|
3251
|
+
# The name of the job that you updated.
|
3252
|
+
# @return [String]
|
3253
|
+
#
|
3254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateRecipeJobResponse AWS API Documentation
|
3255
|
+
#
|
3256
|
+
class UpdateRecipeJobResponse < Struct.new(
|
3257
|
+
:name)
|
3258
|
+
SENSITIVE = []
|
3259
|
+
include Aws::Structure
|
3260
|
+
end
|
3261
|
+
|
3262
|
+
# @note When making an API call, you may pass UpdateRecipeRequest
|
3263
|
+
# data as a hash:
|
3264
|
+
#
|
3265
|
+
# {
|
3266
|
+
# description: "RecipeDescription",
|
3267
|
+
# name: "RecipeName", # required
|
3268
|
+
# steps: [
|
3269
|
+
# {
|
3270
|
+
# action: { # required
|
3271
|
+
# operation: "Operation", # required
|
3272
|
+
# parameters: {
|
3273
|
+
# "ParameterName" => "ParameterValue",
|
3274
|
+
# },
|
3275
|
+
# },
|
3276
|
+
# condition_expressions: [
|
3277
|
+
# {
|
3278
|
+
# condition: "Condition", # required
|
3279
|
+
# value: "ConditionValue",
|
3280
|
+
# target_column: "TargetColumn", # required
|
3281
|
+
# },
|
3282
|
+
# ],
|
3283
|
+
# },
|
3284
|
+
# ],
|
3285
|
+
# }
|
3286
|
+
#
|
3287
|
+
# @!attribute [rw] description
|
3288
|
+
# A description of the recipe.
|
3289
|
+
# @return [String]
|
3290
|
+
#
|
3291
|
+
# @!attribute [rw] name
|
3292
|
+
# The name of the recipe to be updated.
|
3293
|
+
# @return [String]
|
3294
|
+
#
|
3295
|
+
# @!attribute [rw] steps
|
3296
|
+
# One or more steps to be performed by the recipe. Each step consists
|
3297
|
+
# of an action, and the conditions under which the action should
|
3298
|
+
# succeed.
|
3299
|
+
# @return [Array<Types::RecipeStep>]
|
3300
|
+
#
|
3301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateRecipeRequest AWS API Documentation
|
3302
|
+
#
|
3303
|
+
class UpdateRecipeRequest < Struct.new(
|
3304
|
+
:description,
|
3305
|
+
:name,
|
3306
|
+
:steps)
|
3307
|
+
SENSITIVE = []
|
3308
|
+
include Aws::Structure
|
3309
|
+
end
|
3310
|
+
|
3311
|
+
# @!attribute [rw] name
|
3312
|
+
# The name of the recipe that was updated.
|
3313
|
+
# @return [String]
|
3314
|
+
#
|
3315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateRecipeResponse AWS API Documentation
|
3316
|
+
#
|
3317
|
+
class UpdateRecipeResponse < Struct.new(
|
3318
|
+
:name)
|
3319
|
+
SENSITIVE = []
|
3320
|
+
include Aws::Structure
|
3321
|
+
end
|
3322
|
+
|
3323
|
+
# @note When making an API call, you may pass UpdateScheduleRequest
|
3324
|
+
# data as a hash:
|
3325
|
+
#
|
3326
|
+
# {
|
3327
|
+
# job_names: ["JobName"],
|
3328
|
+
# cron_expression: "CronExpression", # required
|
3329
|
+
# name: "ScheduleName", # required
|
3330
|
+
# }
|
3331
|
+
#
|
3332
|
+
# @!attribute [rw] job_names
|
3333
|
+
# The name or names of one or more jobs to be run for this schedule.
|
3334
|
+
# @return [Array<String>]
|
3335
|
+
#
|
3336
|
+
# @!attribute [rw] cron_expression
|
3337
|
+
# The date or dates and time or times, in `cron` format, when the jobs
|
3338
|
+
# are to be run.
|
3339
|
+
# @return [String]
|
3340
|
+
#
|
3341
|
+
# @!attribute [rw] name
|
3342
|
+
# The name of the schedule to update.
|
3343
|
+
# @return [String]
|
3344
|
+
#
|
3345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateScheduleRequest AWS API Documentation
|
3346
|
+
#
|
3347
|
+
class UpdateScheduleRequest < Struct.new(
|
3348
|
+
:job_names,
|
3349
|
+
:cron_expression,
|
3350
|
+
:name)
|
3351
|
+
SENSITIVE = []
|
3352
|
+
include Aws::Structure
|
3353
|
+
end
|
3354
|
+
|
3355
|
+
# @!attribute [rw] name
|
3356
|
+
# The name of the schedule that was updated.
|
3357
|
+
# @return [String]
|
3358
|
+
#
|
3359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateScheduleResponse AWS API Documentation
|
3360
|
+
#
|
3361
|
+
class UpdateScheduleResponse < Struct.new(
|
3362
|
+
:name)
|
3363
|
+
SENSITIVE = []
|
3364
|
+
include Aws::Structure
|
3365
|
+
end
|
3366
|
+
|
3367
|
+
# The input parameters for this request failed validation.
|
3368
|
+
#
|
3369
|
+
# @!attribute [rw] message
|
3370
|
+
# @return [String]
|
3371
|
+
#
|
3372
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ValidationException AWS API Documentation
|
3373
|
+
#
|
3374
|
+
class ValidationException < Struct.new(
|
3375
|
+
:message)
|
3376
|
+
SENSITIVE = []
|
3377
|
+
include Aws::Structure
|
3378
|
+
end
|
3379
|
+
|
3380
|
+
# Represents the data being being transformed during an AWS Glue
|
3381
|
+
# DataBrew project session.
|
3382
|
+
#
|
3383
|
+
# @note When making an API call, you may pass ViewFrame
|
3384
|
+
# data as a hash:
|
3385
|
+
#
|
3386
|
+
# {
|
3387
|
+
# start_column_index: 1, # required
|
3388
|
+
# column_range: 1,
|
3389
|
+
# hidden_columns: ["ColumnName"],
|
3390
|
+
# }
|
3391
|
+
#
|
3392
|
+
# @!attribute [rw] start_column_index
|
3393
|
+
# The starting index for the range of columns to return in the view
|
3394
|
+
# frame.
|
3395
|
+
# @return [Integer]
|
3396
|
+
#
|
3397
|
+
# @!attribute [rw] column_range
|
3398
|
+
# The number of columns to include in the view frame, beginning with
|
3399
|
+
# the `StartColumnIndex` value and ignoring any columns in the
|
3400
|
+
# `HiddenColumns` list.
|
3401
|
+
# @return [Integer]
|
3402
|
+
#
|
3403
|
+
# @!attribute [rw] hidden_columns
|
3404
|
+
# A list of columns to hide in the view frame.
|
3405
|
+
# @return [Array<String>]
|
3406
|
+
#
|
3407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ViewFrame AWS API Documentation
|
3408
|
+
#
|
3409
|
+
class ViewFrame < Struct.new(
|
3410
|
+
:start_column_index,
|
3411
|
+
:column_range,
|
3412
|
+
:hidden_columns)
|
3413
|
+
SENSITIVE = []
|
3414
|
+
include Aws::Structure
|
3415
|
+
end
|
3416
|
+
|
3417
|
+
end
|
3418
|
+
end
|