aws-sdk-gluedatabrew 1.0.0 → 1.1.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 +4 -4
- data/lib/aws-sdk-gluedatabrew.rb +1 -1
- data/lib/aws-sdk-gluedatabrew/client.rb +175 -129
- data/lib/aws-sdk-gluedatabrew/client_api.rb +41 -0
- data/lib/aws-sdk-gluedatabrew/types.rb +294 -161
- metadata +2 -2
@@ -47,6 +47,8 @@ module Aws::GlueDataBrew
|
|
47
47
|
CreateScheduleResponse = Shapes::StructureShape.new(name: 'CreateScheduleResponse')
|
48
48
|
CreatedBy = Shapes::StringShape.new(name: 'CreatedBy')
|
49
49
|
CronExpression = Shapes::StringShape.new(name: 'CronExpression')
|
50
|
+
CsvOptions = Shapes::StructureShape.new(name: 'CsvOptions')
|
51
|
+
CsvOutputOptions = Shapes::StructureShape.new(name: 'CsvOutputOptions')
|
50
52
|
DataCatalogInputDefinition = Shapes::StructureShape.new(name: 'DataCatalogInputDefinition')
|
51
53
|
DatabaseName = Shapes::StringShape.new(name: 'DatabaseName')
|
52
54
|
Dataset = Shapes::StructureShape.new(name: 'Dataset')
|
@@ -63,6 +65,7 @@ module Aws::GlueDataBrew
|
|
63
65
|
DeleteRecipeVersionResponse = Shapes::StructureShape.new(name: 'DeleteRecipeVersionResponse')
|
64
66
|
DeleteScheduleRequest = Shapes::StructureShape.new(name: 'DeleteScheduleRequest')
|
65
67
|
DeleteScheduleResponse = Shapes::StructureShape.new(name: 'DeleteScheduleResponse')
|
68
|
+
Delimiter = Shapes::StringShape.new(name: 'Delimiter')
|
66
69
|
DescribeDatasetRequest = Shapes::StructureShape.new(name: 'DescribeDatasetRequest')
|
67
70
|
DescribeDatasetResponse = Shapes::StructureShape.new(name: 'DescribeDatasetResponse')
|
68
71
|
DescribeJobRequest = Shapes::StructureShape.new(name: 'DescribeJobRequest')
|
@@ -123,6 +126,7 @@ module Aws::GlueDataBrew
|
|
123
126
|
Operation = Shapes::StringShape.new(name: 'Operation')
|
124
127
|
Output = Shapes::StructureShape.new(name: 'Output')
|
125
128
|
OutputFormat = Shapes::StringShape.new(name: 'OutputFormat')
|
129
|
+
OutputFormatOptions = Shapes::StructureShape.new(name: 'OutputFormatOptions')
|
126
130
|
OutputList = Shapes::ListShape.new(name: 'OutputList')
|
127
131
|
OverwriteOutput = Shapes::BooleanShape.new(name: 'OverwriteOutput')
|
128
132
|
ParameterMap = Shapes::MapShape.new(name: 'ParameterMap')
|
@@ -296,6 +300,12 @@ module Aws::GlueDataBrew
|
|
296
300
|
CreateScheduleResponse.add_member(:name, Shapes::ShapeRef.new(shape: ScheduleName, required: true, location_name: "Name"))
|
297
301
|
CreateScheduleResponse.struct_class = Types::CreateScheduleResponse
|
298
302
|
|
303
|
+
CsvOptions.add_member(:delimiter, Shapes::ShapeRef.new(shape: Delimiter, location_name: "Delimiter"))
|
304
|
+
CsvOptions.struct_class = Types::CsvOptions
|
305
|
+
|
306
|
+
CsvOutputOptions.add_member(:delimiter, Shapes::ShapeRef.new(shape: Delimiter, location_name: "Delimiter"))
|
307
|
+
CsvOutputOptions.struct_class = Types::CsvOutputOptions
|
308
|
+
|
299
309
|
DataCatalogInputDefinition.add_member(:catalog_id, Shapes::ShapeRef.new(shape: CatalogId, location_name: "CatalogId"))
|
300
310
|
DataCatalogInputDefinition.add_member(:database_name, Shapes::ShapeRef.new(shape: DatabaseName, required: true, location_name: "DatabaseName"))
|
301
311
|
DataCatalogInputDefinition.add_member(:table_name, Shapes::ShapeRef.new(shape: TableName, required: true, location_name: "TableName"))
|
@@ -446,6 +456,7 @@ module Aws::GlueDataBrew
|
|
446
456
|
|
447
457
|
FormatOptions.add_member(:json, Shapes::ShapeRef.new(shape: JsonOptions, location_name: "Json"))
|
448
458
|
FormatOptions.add_member(:excel, Shapes::ShapeRef.new(shape: ExcelOptions, location_name: "Excel"))
|
459
|
+
FormatOptions.add_member(:csv, Shapes::ShapeRef.new(shape: CsvOptions, location_name: "Csv"))
|
449
460
|
FormatOptions.struct_class = Types::FormatOptions
|
450
461
|
|
451
462
|
HiddenColumnList.member = Shapes::ShapeRef.new(shape: ColumnName)
|
@@ -577,8 +588,12 @@ module Aws::GlueDataBrew
|
|
577
588
|
Output.add_member(:partition_columns, Shapes::ShapeRef.new(shape: ColumnNameList, location_name: "PartitionColumns"))
|
578
589
|
Output.add_member(:location, Shapes::ShapeRef.new(shape: S3Location, required: true, location_name: "Location"))
|
579
590
|
Output.add_member(:overwrite, Shapes::ShapeRef.new(shape: OverwriteOutput, location_name: "Overwrite"))
|
591
|
+
Output.add_member(:format_options, Shapes::ShapeRef.new(shape: OutputFormatOptions, location_name: "FormatOptions"))
|
580
592
|
Output.struct_class = Types::Output
|
581
593
|
|
594
|
+
OutputFormatOptions.add_member(:csv, Shapes::ShapeRef.new(shape: CsvOutputOptions, location_name: "Csv"))
|
595
|
+
OutputFormatOptions.struct_class = Types::OutputFormatOptions
|
596
|
+
|
582
597
|
OutputList.member = Shapes::ShapeRef.new(shape: Output)
|
583
598
|
|
584
599
|
ParameterMap.key = Shapes::ShapeRef.new(shape: ParameterName)
|
@@ -848,6 +863,10 @@ module Aws::GlueDataBrew
|
|
848
863
|
o.http_request_uri = "/profileJobs"
|
849
864
|
o.input = Shapes::ShapeRef.new(shape: CreateProfileJobRequest)
|
850
865
|
o.output = Shapes::ShapeRef.new(shape: CreateProfileJobResponse)
|
866
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
867
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
868
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
869
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
851
870
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
852
871
|
end)
|
853
872
|
|
@@ -880,6 +899,10 @@ module Aws::GlueDataBrew
|
|
880
899
|
o.http_request_uri = "/recipeJobs"
|
881
900
|
o.input = Shapes::ShapeRef.new(shape: CreateRecipeJobRequest)
|
882
901
|
o.output = Shapes::ShapeRef.new(shape: CreateRecipeJobResponse)
|
902
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
903
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
904
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
905
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
883
906
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
884
907
|
end)
|
885
908
|
|
@@ -889,6 +912,8 @@ module Aws::GlueDataBrew
|
|
889
912
|
o.http_request_uri = "/schedules"
|
890
913
|
o.input = Shapes::ShapeRef.new(shape: CreateScheduleRequest)
|
891
914
|
o.output = Shapes::ShapeRef.new(shape: CreateScheduleResponse)
|
915
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
916
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
892
917
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
893
918
|
end)
|
894
919
|
|
@@ -898,6 +923,7 @@ module Aws::GlueDataBrew
|
|
898
923
|
o.http_request_uri = "/datasets/{name}"
|
899
924
|
o.input = Shapes::ShapeRef.new(shape: DeleteDatasetRequest)
|
900
925
|
o.output = Shapes::ShapeRef.new(shape: DeleteDatasetResponse)
|
926
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
901
927
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
902
928
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
903
929
|
end)
|
@@ -908,6 +934,7 @@ module Aws::GlueDataBrew
|
|
908
934
|
o.http_request_uri = "/jobs/{name}"
|
909
935
|
o.input = Shapes::ShapeRef.new(shape: DeleteJobRequest)
|
910
936
|
o.output = Shapes::ShapeRef.new(shape: DeleteJobResponse)
|
937
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
911
938
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
912
939
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
913
940
|
end)
|
@@ -918,6 +945,7 @@ module Aws::GlueDataBrew
|
|
918
945
|
o.http_request_uri = "/projects/{name}"
|
919
946
|
o.input = Shapes::ShapeRef.new(shape: DeleteProjectRequest)
|
920
947
|
o.output = Shapes::ShapeRef.new(shape: DeleteProjectResponse)
|
948
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
921
949
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
922
950
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
923
951
|
end)
|
@@ -928,6 +956,7 @@ module Aws::GlueDataBrew
|
|
928
956
|
o.http_request_uri = "/recipes/{name}/recipeVersion/{recipeVersion}"
|
929
957
|
o.input = Shapes::ShapeRef.new(shape: DeleteRecipeVersionRequest)
|
930
958
|
o.output = Shapes::ShapeRef.new(shape: DeleteRecipeVersionResponse)
|
959
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
931
960
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
932
961
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
933
962
|
end)
|
@@ -1117,6 +1146,7 @@ module Aws::GlueDataBrew
|
|
1117
1146
|
o.output = Shapes::ShapeRef.new(shape: PublishRecipeResponse)
|
1118
1147
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1119
1148
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1149
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
1120
1150
|
end)
|
1121
1151
|
|
1122
1152
|
api.add_operation(:send_project_session_action, Seahorse::Model::Operation.new.tap do |o|
|
@@ -1136,7 +1166,9 @@ module Aws::GlueDataBrew
|
|
1136
1166
|
o.http_request_uri = "/jobs/{name}/startJobRun"
|
1137
1167
|
o.input = Shapes::ShapeRef.new(shape: StartJobRunRequest)
|
1138
1168
|
o.output = Shapes::ShapeRef.new(shape: StartJobRunResponse)
|
1169
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1139
1170
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1171
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
1140
1172
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1141
1173
|
end)
|
1142
1174
|
|
@@ -1146,7 +1178,9 @@ module Aws::GlueDataBrew
|
|
1146
1178
|
o.http_request_uri = "/projects/{name}/startProjectSession"
|
1147
1179
|
o.input = Shapes::ShapeRef.new(shape: StartProjectSessionRequest)
|
1148
1180
|
o.output = Shapes::ShapeRef.new(shape: StartProjectSessionResponse)
|
1181
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1149
1182
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1183
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
1150
1184
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1151
1185
|
end)
|
1152
1186
|
|
@@ -1188,6 +1222,7 @@ module Aws::GlueDataBrew
|
|
1188
1222
|
o.http_request_uri = "/datasets/{name}"
|
1189
1223
|
o.input = Shapes::ShapeRef.new(shape: UpdateDatasetRequest)
|
1190
1224
|
o.output = Shapes::ShapeRef.new(shape: UpdateDatasetResponse)
|
1225
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1191
1226
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1192
1227
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1193
1228
|
end)
|
@@ -1198,6 +1233,8 @@ module Aws::GlueDataBrew
|
|
1198
1233
|
o.http_request_uri = "/profileJobs/{name}"
|
1199
1234
|
o.input = Shapes::ShapeRef.new(shape: UpdateProfileJobRequest)
|
1200
1235
|
o.output = Shapes::ShapeRef.new(shape: UpdateProfileJobResponse)
|
1236
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1237
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1201
1238
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1202
1239
|
end)
|
1203
1240
|
|
@@ -1227,6 +1264,8 @@ module Aws::GlueDataBrew
|
|
1227
1264
|
o.http_request_uri = "/recipeJobs/{name}"
|
1228
1265
|
o.input = Shapes::ShapeRef.new(shape: UpdateRecipeJobRequest)
|
1229
1266
|
o.output = Shapes::ShapeRef.new(shape: UpdateRecipeJobResponse)
|
1267
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1268
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1230
1269
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1231
1270
|
end)
|
1232
1271
|
|
@@ -1236,6 +1275,8 @@ module Aws::GlueDataBrew
|
|
1236
1275
|
o.http_request_uri = "/schedules/{name}"
|
1237
1276
|
o.input = Shapes::ShapeRef.new(shape: UpdateScheduleRequest)
|
1238
1277
|
o.output = Shapes::ShapeRef.new(shape: UpdateScheduleResponse)
|
1278
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1279
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
1239
1280
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1240
1281
|
end)
|
1241
1282
|
end
|
@@ -32,11 +32,13 @@ module Aws::GlueDataBrew
|
|
32
32
|
# }
|
33
33
|
#
|
34
34
|
# @!attribute [rw] name
|
35
|
-
# The name of the recipe to be
|
35
|
+
# The name of the recipe whose versions are to be deleted.
|
36
36
|
# @return [String]
|
37
37
|
#
|
38
38
|
# @!attribute [rw] recipe_versions
|
39
|
-
# An array of version identifiers to be
|
39
|
+
# An array of version identifiers, for the recipe versions to be
|
40
|
+
# deleted. You can specify numeric versions (`X.Y`) or
|
41
|
+
# `LATEST_WORKING`. `LATEST_PUBLISHED` is not supported.
|
40
42
|
# @return [Array<String>]
|
41
43
|
#
|
42
44
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/BatchDeleteRecipeVersionRequest AWS API Documentation
|
@@ -53,7 +55,7 @@ module Aws::GlueDataBrew
|
|
53
55
|
# @return [String]
|
54
56
|
#
|
55
57
|
# @!attribute [rw] errors
|
56
|
-
# Errors, if any, that
|
58
|
+
# Errors, if any, that occurred while attempting to delete the recipe
|
57
59
|
# versions.
|
58
60
|
# @return [Array<Types::RecipeVersionErrorDetail>]
|
59
61
|
#
|
@@ -92,7 +94,7 @@ module Aws::GlueDataBrew
|
|
92
94
|
#
|
93
95
|
#
|
94
96
|
#
|
95
|
-
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/
|
97
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/recipes.html#recipes.structure
|
96
98
|
# @return [String]
|
97
99
|
#
|
98
100
|
# @!attribute [rw] value
|
@@ -101,8 +103,7 @@ module Aws::GlueDataBrew
|
|
101
103
|
# @return [String]
|
102
104
|
#
|
103
105
|
# @!attribute [rw] target_column
|
104
|
-
# A column to apply this condition to
|
105
|
-
# dataset.
|
106
|
+
# A column to apply this condition to.
|
106
107
|
# @return [String]
|
107
108
|
#
|
108
109
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ConditionExpression AWS API Documentation
|
@@ -141,6 +142,9 @@ module Aws::GlueDataBrew
|
|
141
142
|
# sheet_names: ["SheetName"],
|
142
143
|
# sheet_indexes: [1],
|
143
144
|
# },
|
145
|
+
# csv: {
|
146
|
+
# delimiter: "Delimiter",
|
147
|
+
# },
|
144
148
|
# },
|
145
149
|
# input: { # required
|
146
150
|
# s3_input_definition: {
|
@@ -163,17 +167,18 @@ module Aws::GlueDataBrew
|
|
163
167
|
# }
|
164
168
|
#
|
165
169
|
# @!attribute [rw] name
|
166
|
-
# The name of the dataset to be created.
|
170
|
+
# The name of the dataset to be created. Valid characters are
|
171
|
+
# alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
|
167
172
|
# @return [String]
|
168
173
|
#
|
169
174
|
# @!attribute [rw] format_options
|
170
|
-
# Options that define
|
171
|
-
#
|
175
|
+
# Options that define the structure of either Csv, Excel, or JSON
|
176
|
+
# input.
|
172
177
|
# @return [Types::FormatOptions]
|
173
178
|
#
|
174
179
|
# @!attribute [rw] input
|
175
|
-
# Information on how
|
176
|
-
#
|
180
|
+
# Information on how DataBrew can find data, in either the AWS Glue
|
181
|
+
# Data Catalog or Amazon S3.
|
177
182
|
# @return [Types::Input]
|
178
183
|
#
|
179
184
|
# @!attribute [rw] tags
|
@@ -244,13 +249,14 @@ module Aws::GlueDataBrew
|
|
244
249
|
# @return [String]
|
245
250
|
#
|
246
251
|
# @!attribute [rw] name
|
247
|
-
# The name of the job to be created.
|
252
|
+
# The name of the job to be created. Valid characters are alphanumeric
|
253
|
+
# (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
|
248
254
|
# @return [String]
|
249
255
|
#
|
250
256
|
# @!attribute [rw] log_subscription
|
251
|
-
#
|
252
|
-
#
|
253
|
-
#
|
257
|
+
# Enables or disables Amazon CloudWatch logging for the job. If
|
258
|
+
# logging is enabled, CloudWatch writes one log stream for each job
|
259
|
+
# run.
|
254
260
|
# @return [String]
|
255
261
|
#
|
256
262
|
# @!attribute [rw] max_capacity
|
@@ -269,7 +275,7 @@ module Aws::GlueDataBrew
|
|
269
275
|
#
|
270
276
|
# @!attribute [rw] role_arn
|
271
277
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
272
|
-
# Management (IAM) role to be assumed
|
278
|
+
# Management (IAM) role to be assumed when DataBrew runs the job.
|
273
279
|
# @return [String]
|
274
280
|
#
|
275
281
|
# @!attribute [rw] tags
|
@@ -329,11 +335,12 @@ module Aws::GlueDataBrew
|
|
329
335
|
# }
|
330
336
|
#
|
331
337
|
# @!attribute [rw] dataset_name
|
332
|
-
# The name of
|
338
|
+
# The name of an existing dataset to associate this project with.
|
333
339
|
# @return [String]
|
334
340
|
#
|
335
341
|
# @!attribute [rw] name
|
336
|
-
# A unique name for the new project.
|
342
|
+
# A unique name for the new project. Valid characters are alphanumeric
|
343
|
+
# (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
|
337
344
|
# @return [String]
|
338
345
|
#
|
339
346
|
# @!attribute [rw] recipe_name
|
@@ -341,8 +348,8 @@ module Aws::GlueDataBrew
|
|
341
348
|
# @return [String]
|
342
349
|
#
|
343
350
|
# @!attribute [rw] sample
|
344
|
-
# Represents the sample size and sampling type for
|
345
|
-
#
|
351
|
+
# Represents the sample size and sampling type for DataBrew to use for
|
352
|
+
# interactive data analysis.
|
346
353
|
# @return [Types::Sample]
|
347
354
|
#
|
348
355
|
# @!attribute [rw] role_arn
|
@@ -400,6 +407,11 @@ module Aws::GlueDataBrew
|
|
400
407
|
# key: "Key",
|
401
408
|
# },
|
402
409
|
# overwrite: false,
|
410
|
+
# format_options: {
|
411
|
+
# csv: {
|
412
|
+
# delimiter: "Delimiter",
|
413
|
+
# },
|
414
|
+
# },
|
403
415
|
# },
|
404
416
|
# ],
|
405
417
|
# project_name: "ProjectName",
|
@@ -432,13 +444,14 @@ module Aws::GlueDataBrew
|
|
432
444
|
# @return [String]
|
433
445
|
#
|
434
446
|
# @!attribute [rw] name
|
435
|
-
# A unique name for the job.
|
447
|
+
# A unique name for the job. Valid characters are alphanumeric (A-Z,
|
448
|
+
# a-z, 0-9), hyphen (-), period (.), and space.
|
436
449
|
# @return [String]
|
437
450
|
#
|
438
451
|
# @!attribute [rw] log_subscription
|
439
|
-
#
|
440
|
-
#
|
441
|
-
#
|
452
|
+
# Enables or disables Amazon CloudWatch logging for the job. If
|
453
|
+
# logging is enabled, CloudWatch writes one log stream for each job
|
454
|
+
# run.
|
442
455
|
# @return [String]
|
443
456
|
#
|
444
457
|
# @!attribute [rw] max_capacity
|
@@ -461,16 +474,16 @@ module Aws::GlueDataBrew
|
|
461
474
|
# @return [String]
|
462
475
|
#
|
463
476
|
# @!attribute [rw] recipe_reference
|
464
|
-
# Represents
|
477
|
+
# Represents the name and version of a DataBrew recipe.
|
465
478
|
# @return [Types::RecipeReference]
|
466
479
|
#
|
467
480
|
# @!attribute [rw] role_arn
|
468
481
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
469
|
-
# Management (IAM) role to be assumed
|
482
|
+
# Management (IAM) role to be assumed when DataBrew runs the job.
|
470
483
|
# @return [String]
|
471
484
|
#
|
472
485
|
# @!attribute [rw] tags
|
473
|
-
# Metadata tags to apply to this job
|
486
|
+
# Metadata tags to apply to this job.
|
474
487
|
# @return [Hash<String,String>]
|
475
488
|
#
|
476
489
|
# @!attribute [rw] timeout
|
@@ -543,7 +556,8 @@ module Aws::GlueDataBrew
|
|
543
556
|
# @return [String]
|
544
557
|
#
|
545
558
|
# @!attribute [rw] name
|
546
|
-
# A unique name for the recipe.
|
559
|
+
# A unique name for the recipe. Valid characters are alphanumeric
|
560
|
+
# (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
|
547
561
|
# @return [String]
|
548
562
|
#
|
549
563
|
# @!attribute [rw] steps
|
@@ -596,8 +610,13 @@ module Aws::GlueDataBrew
|
|
596
610
|
# @return [Array<String>]
|
597
611
|
#
|
598
612
|
# @!attribute [rw] cron_expression
|
599
|
-
# The date or dates and time or times
|
600
|
-
#
|
613
|
+
# The date or dates and time or times when the jobs are to be run. For
|
614
|
+
# more information, see [Cron expressions][1] in the *AWS Glue
|
615
|
+
# DataBrew Developer Guide*.
|
616
|
+
#
|
617
|
+
#
|
618
|
+
#
|
619
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html
|
601
620
|
# @return [String]
|
602
621
|
#
|
603
622
|
# @!attribute [rw] tags
|
@@ -605,7 +624,8 @@ module Aws::GlueDataBrew
|
|
605
624
|
# @return [Hash<String,String>]
|
606
625
|
#
|
607
626
|
# @!attribute [rw] name
|
608
|
-
# A unique name for the schedule.
|
627
|
+
# A unique name for the schedule. Valid characters are alphanumeric
|
628
|
+
# (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
|
609
629
|
# @return [String]
|
610
630
|
#
|
611
631
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateScheduleRequest AWS API Documentation
|
@@ -631,8 +651,53 @@ module Aws::GlueDataBrew
|
|
631
651
|
include Aws::Structure
|
632
652
|
end
|
633
653
|
|
654
|
+
# Options that define how DataBrew will read a Csv file when creating a
|
655
|
+
# dataset from that file.
|
656
|
+
#
|
657
|
+
# @note When making an API call, you may pass CsvOptions
|
658
|
+
# data as a hash:
|
659
|
+
#
|
660
|
+
# {
|
661
|
+
# delimiter: "Delimiter",
|
662
|
+
# }
|
663
|
+
#
|
664
|
+
# @!attribute [rw] delimiter
|
665
|
+
# A single character that specifies the delimiter being used in the
|
666
|
+
# Csv file.
|
667
|
+
# @return [String]
|
668
|
+
#
|
669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CsvOptions AWS API Documentation
|
670
|
+
#
|
671
|
+
class CsvOptions < Struct.new(
|
672
|
+
:delimiter)
|
673
|
+
SENSITIVE = []
|
674
|
+
include Aws::Structure
|
675
|
+
end
|
676
|
+
|
677
|
+
# Options that define how DataBrew will write a Csv file a.
|
678
|
+
#
|
679
|
+
# @note When making an API call, you may pass CsvOutputOptions
|
680
|
+
# data as a hash:
|
681
|
+
#
|
682
|
+
# {
|
683
|
+
# delimiter: "Delimiter",
|
684
|
+
# }
|
685
|
+
#
|
686
|
+
# @!attribute [rw] delimiter
|
687
|
+
# A single character that specifies the delimiter used to create Csv
|
688
|
+
# job output.
|
689
|
+
# @return [String]
|
690
|
+
#
|
691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CsvOutputOptions AWS API Documentation
|
692
|
+
#
|
693
|
+
class CsvOutputOptions < Struct.new(
|
694
|
+
:delimiter)
|
695
|
+
SENSITIVE = []
|
696
|
+
include Aws::Structure
|
697
|
+
end
|
698
|
+
|
634
699
|
# Represents how metadata stored in the AWS Glue Data Catalog is defined
|
635
|
-
# in
|
700
|
+
# in a DataBrew dataset.
|
636
701
|
#
|
637
702
|
# @note When making an API call, you may pass DataCatalogInputDefinition
|
638
703
|
# data as a hash:
|
@@ -677,14 +742,14 @@ module Aws::GlueDataBrew
|
|
677
742
|
include Aws::Structure
|
678
743
|
end
|
679
744
|
|
680
|
-
# Represents a dataset that can be processed by
|
745
|
+
# Represents a dataset that can be processed by DataBrew.
|
681
746
|
#
|
682
747
|
# @!attribute [rw] account_id
|
683
748
|
# The ID of the AWS account that owns the dataset.
|
684
749
|
# @return [String]
|
685
750
|
#
|
686
751
|
# @!attribute [rw] created_by
|
687
|
-
# The
|
752
|
+
# The Amazon Resource Name (ARN) of the user who created the dataset.
|
688
753
|
# @return [String]
|
689
754
|
#
|
690
755
|
# @!attribute [rw] create_date
|
@@ -709,7 +774,7 @@ module Aws::GlueDataBrew
|
|
709
774
|
# @return [Time]
|
710
775
|
#
|
711
776
|
# @!attribute [rw] last_modified_by
|
712
|
-
# The
|
777
|
+
# The Amazon Resource Name (ARN) of the user who last modified the
|
713
778
|
# dataset.
|
714
779
|
# @return [String]
|
715
780
|
#
|
@@ -846,11 +911,13 @@ module Aws::GlueDataBrew
|
|
846
911
|
# }
|
847
912
|
#
|
848
913
|
# @!attribute [rw] name
|
849
|
-
# The name of the recipe
|
914
|
+
# The name of the recipe.
|
850
915
|
# @return [String]
|
851
916
|
#
|
852
917
|
# @!attribute [rw] recipe_version
|
853
|
-
# The version of the recipe to be deleted.
|
918
|
+
# The version of the recipe to be deleted. You can specify a numeric
|
919
|
+
# versions (`X.Y`) or `LATEST_WORKING`. `LATEST_PUBLISHED` is not
|
920
|
+
# supported.
|
854
921
|
# @return [String]
|
855
922
|
#
|
856
923
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteRecipeVersionRequest AWS API Documentation
|
@@ -942,13 +1009,13 @@ module Aws::GlueDataBrew
|
|
942
1009
|
# @return [String]
|
943
1010
|
#
|
944
1011
|
# @!attribute [rw] format_options
|
945
|
-
# Options that define
|
946
|
-
#
|
1012
|
+
# Options that define the structure of either Csv, Excel, or JSON
|
1013
|
+
# input.
|
947
1014
|
# @return [Types::FormatOptions]
|
948
1015
|
#
|
949
1016
|
# @!attribute [rw] input
|
950
|
-
# Information on how
|
951
|
-
#
|
1017
|
+
# Information on how DataBrew can find data, in either the AWS Glue
|
1018
|
+
# Data Catalog or Amazon S3.
|
952
1019
|
# @return [Types::Input]
|
953
1020
|
#
|
954
1021
|
# @!attribute [rw] last_modified_date
|
@@ -1058,12 +1125,11 @@ module Aws::GlueDataBrew
|
|
1058
1125
|
# @return [Time]
|
1059
1126
|
#
|
1060
1127
|
# @!attribute [rw] log_subscription
|
1061
|
-
#
|
1062
|
-
# for this job.
|
1128
|
+
# Indicates whether Amazon CloudWatch logging is enabled for this job.
|
1063
1129
|
# @return [String]
|
1064
1130
|
#
|
1065
1131
|
# @!attribute [rw] max_capacity
|
1066
|
-
# The maximum number of nodes that
|
1132
|
+
# The maximum number of compute nodes that DataBrew can consume when
|
1067
1133
|
# the job processes data.
|
1068
1134
|
# @return [Integer]
|
1069
1135
|
#
|
@@ -1081,7 +1147,7 @@ module Aws::GlueDataBrew
|
|
1081
1147
|
# @return [String]
|
1082
1148
|
#
|
1083
1149
|
# @!attribute [rw] recipe_reference
|
1084
|
-
# Represents
|
1150
|
+
# Represents the name and version of a DataBrew recipe.
|
1085
1151
|
# @return [Types::RecipeReference]
|
1086
1152
|
#
|
1087
1153
|
# @!attribute [rw] resource_arn
|
@@ -1089,8 +1155,8 @@ module Aws::GlueDataBrew
|
|
1089
1155
|
# @return [String]
|
1090
1156
|
#
|
1091
1157
|
# @!attribute [rw] role_arn
|
1092
|
-
# The ARN of the AWS Identity and Access Management (IAM) role
|
1093
|
-
#
|
1158
|
+
# The ARN of the AWS Identity and Access Management (IAM) role to be
|
1159
|
+
# assumed when DataBrew runs the job.
|
1094
1160
|
# @return [String]
|
1095
1161
|
#
|
1096
1162
|
# @!attribute [rw] tags
|
@@ -1181,13 +1247,13 @@ module Aws::GlueDataBrew
|
|
1181
1247
|
# @return [String]
|
1182
1248
|
#
|
1183
1249
|
# @!attribute [rw] sample
|
1184
|
-
# Represents the sample size and sampling type for
|
1185
|
-
#
|
1250
|
+
# Represents the sample size and sampling type for DataBrew to use for
|
1251
|
+
# interactive data analysis.
|
1186
1252
|
# @return [Types::Sample]
|
1187
1253
|
#
|
1188
1254
|
# @!attribute [rw] role_arn
|
1189
|
-
# The ARN of the AWS Identity and Access Management (IAM) role
|
1190
|
-
#
|
1255
|
+
# The ARN of the AWS Identity and Access Management (IAM) role to be
|
1256
|
+
# assumed when DataBrew runs the job.
|
1191
1257
|
# @return [String]
|
1192
1258
|
#
|
1193
1259
|
# @!attribute [rw] tags
|
@@ -1381,8 +1447,13 @@ module Aws::GlueDataBrew
|
|
1381
1447
|
# @return [String]
|
1382
1448
|
#
|
1383
1449
|
# @!attribute [rw] cron_expression
|
1384
|
-
# The date or dates and time or times
|
1385
|
-
#
|
1450
|
+
# The date or dates and time or times when the jobs are to be run for
|
1451
|
+
# the schedule. For more information, see [Cron expressions][1] in the
|
1452
|
+
# *AWS Glue DataBrew Developer Guide*.
|
1453
|
+
#
|
1454
|
+
#
|
1455
|
+
#
|
1456
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html
|
1386
1457
|
# @return [String]
|
1387
1458
|
#
|
1388
1459
|
# @!attribute [rw] tags
|
@@ -1439,8 +1510,7 @@ module Aws::GlueDataBrew
|
|
1439
1510
|
include Aws::Structure
|
1440
1511
|
end
|
1441
1512
|
|
1442
|
-
# Options that define
|
1443
|
-
# DataBrew.
|
1513
|
+
# Options that define the structure of either Csv, Excel, or JSON input.
|
1444
1514
|
#
|
1445
1515
|
# @note When making an API call, you may pass FormatOptions
|
1446
1516
|
# data as a hash:
|
@@ -1453,6 +1523,9 @@ module Aws::GlueDataBrew
|
|
1453
1523
|
# sheet_names: ["SheetName"],
|
1454
1524
|
# sheet_indexes: [1],
|
1455
1525
|
# },
|
1526
|
+
# csv: {
|
1527
|
+
# delimiter: "Delimiter",
|
1528
|
+
# },
|
1456
1529
|
# }
|
1457
1530
|
#
|
1458
1531
|
# @!attribute [rw] json
|
@@ -1464,17 +1537,22 @@ module Aws::GlueDataBrew
|
|
1464
1537
|
# DataBrew.
|
1465
1538
|
# @return [Types::ExcelOptions]
|
1466
1539
|
#
|
1540
|
+
# @!attribute [rw] csv
|
1541
|
+
# Options that define how Csv input is to be interpreted by DataBrew.
|
1542
|
+
# @return [Types::CsvOptions]
|
1543
|
+
#
|
1467
1544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/FormatOptions AWS API Documentation
|
1468
1545
|
#
|
1469
1546
|
class FormatOptions < Struct.new(
|
1470
1547
|
:json,
|
1471
|
-
:excel
|
1548
|
+
:excel,
|
1549
|
+
:csv)
|
1472
1550
|
SENSITIVE = []
|
1473
1551
|
include Aws::Structure
|
1474
1552
|
end
|
1475
1553
|
|
1476
|
-
# Information on how
|
1477
|
-
#
|
1554
|
+
# Information on how DataBrew can find data, in either the AWS Glue Data
|
1555
|
+
# Catalog or Amazon S3.
|
1478
1556
|
#
|
1479
1557
|
# @note When making an API call, you may pass Input
|
1480
1558
|
# data as a hash:
|
@@ -1525,14 +1603,14 @@ module Aws::GlueDataBrew
|
|
1525
1603
|
include Aws::Structure
|
1526
1604
|
end
|
1527
1605
|
|
1528
|
-
# Represents all of the attributes of
|
1606
|
+
# Represents all of the attributes of a DataBrew job.
|
1529
1607
|
#
|
1530
1608
|
# @!attribute [rw] account_id
|
1531
1609
|
# The ID of the AWS account that owns the job.
|
1532
1610
|
# @return [String]
|
1533
1611
|
#
|
1534
1612
|
# @!attribute [rw] created_by
|
1535
|
-
# The
|
1613
|
+
# The Amazon Resource Name (ARN) of the user who created the job.
|
1536
1614
|
# @return [String]
|
1537
1615
|
#
|
1538
1616
|
# @!attribute [rw] create_date
|
@@ -1545,7 +1623,12 @@ module Aws::GlueDataBrew
|
|
1545
1623
|
#
|
1546
1624
|
# @!attribute [rw] encryption_key_arn
|
1547
1625
|
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
1548
|
-
# protect
|
1626
|
+
# protect the job output. For more information, see [Encrypting data
|
1627
|
+
# written by DataBrew jobs][1]
|
1628
|
+
#
|
1629
|
+
#
|
1630
|
+
#
|
1631
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html
|
1549
1632
|
# @return [String]
|
1550
1633
|
#
|
1551
1634
|
# @!attribute [rw] encryption_mode
|
@@ -1571,7 +1654,7 @@ module Aws::GlueDataBrew
|
|
1571
1654
|
# @return [String]
|
1572
1655
|
#
|
1573
1656
|
# @!attribute [rw] last_modified_by
|
1574
|
-
# The
|
1657
|
+
# The Amazon Resource Name (ARN) of the user who last modified the
|
1575
1658
|
# job.
|
1576
1659
|
# @return [String]
|
1577
1660
|
#
|
@@ -1649,7 +1732,7 @@ module Aws::GlueDataBrew
|
|
1649
1732
|
include Aws::Structure
|
1650
1733
|
end
|
1651
1734
|
|
1652
|
-
# Represents one run of
|
1735
|
+
# Represents one run of a DataBrew job.
|
1653
1736
|
#
|
1654
1737
|
# @!attribute [rw] attempt
|
1655
1738
|
# The number of times that DataBrew has attempted to run the job.
|
@@ -1703,7 +1786,7 @@ module Aws::GlueDataBrew
|
|
1703
1786
|
# @return [Types::RecipeReference]
|
1704
1787
|
#
|
1705
1788
|
# @!attribute [rw] started_by
|
1706
|
-
# The
|
1789
|
+
# The Amazon Resource Name (ARN) of the user who initiated the job
|
1707
1790
|
# run.
|
1708
1791
|
# @return [String]
|
1709
1792
|
#
|
@@ -1768,10 +1851,8 @@ module Aws::GlueDataBrew
|
|
1768
1851
|
# @return [Integer]
|
1769
1852
|
#
|
1770
1853
|
# @!attribute [rw] next_token
|
1771
|
-
#
|
1772
|
-
#
|
1773
|
-
# of pages, pass in the NextToken value from the response object of
|
1774
|
-
# the previous page call.
|
1854
|
+
# The token returned by a previous call to retrieve the next set of
|
1855
|
+
# results.
|
1775
1856
|
# @return [String]
|
1776
1857
|
#
|
1777
1858
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListDatasetsRequest AWS API Documentation
|
@@ -1784,14 +1865,12 @@ module Aws::GlueDataBrew
|
|
1784
1865
|
end
|
1785
1866
|
|
1786
1867
|
# @!attribute [rw] datasets
|
1787
|
-
# A list of datasets that are defined
|
1868
|
+
# A list of datasets that are defined.
|
1788
1869
|
# @return [Array<Types::Dataset>]
|
1789
1870
|
#
|
1790
1871
|
# @!attribute [rw] next_token
|
1791
|
-
# A token
|
1792
|
-
#
|
1793
|
-
# set of pages, pass in the NextToken from the response object of the
|
1794
|
-
# previous page call.
|
1872
|
+
# A token that you can use in a subsequent call to retrieve the next
|
1873
|
+
# set of results.
|
1795
1874
|
# @return [String]
|
1796
1875
|
#
|
1797
1876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListDatasetsResponse AWS API Documentation
|
@@ -1821,10 +1900,8 @@ module Aws::GlueDataBrew
|
|
1821
1900
|
# @return [Integer]
|
1822
1901
|
#
|
1823
1902
|
# @!attribute [rw] next_token
|
1824
|
-
#
|
1825
|
-
#
|
1826
|
-
# next set of pages, pass in the NextToken value from the response
|
1827
|
-
# object of the previous page call.
|
1903
|
+
# The token returned by a previous call to retrieve the next set of
|
1904
|
+
# results.
|
1828
1905
|
# @return [String]
|
1829
1906
|
#
|
1830
1907
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobRunsRequest AWS API Documentation
|
@@ -1842,10 +1919,8 @@ module Aws::GlueDataBrew
|
|
1842
1919
|
# @return [Array<Types::JobRun>]
|
1843
1920
|
#
|
1844
1921
|
# @!attribute [rw] next_token
|
1845
|
-
# A token
|
1846
|
-
#
|
1847
|
-
# set of pages, pass in the NextToken from the response object of the
|
1848
|
-
# previous page call.
|
1922
|
+
# A token that you can use in a subsequent call to retrieve the next
|
1923
|
+
# set of results.
|
1849
1924
|
# @return [String]
|
1850
1925
|
#
|
1851
1926
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobRunsResponse AWS API Documentation
|
@@ -1900,14 +1975,12 @@ module Aws::GlueDataBrew
|
|
1900
1975
|
end
|
1901
1976
|
|
1902
1977
|
# @!attribute [rw] jobs
|
1903
|
-
# A list of jobs that are defined
|
1978
|
+
# A list of jobs that are defined.
|
1904
1979
|
# @return [Array<Types::Job>]
|
1905
1980
|
#
|
1906
1981
|
# @!attribute [rw] next_token
|
1907
|
-
# A token
|
1908
|
-
#
|
1909
|
-
# set of pages, pass in the NextToken from the response object of the
|
1910
|
-
# previous page call.
|
1982
|
+
# A token that you can use in a subsequent call to retrieve the next
|
1983
|
+
# set of results.
|
1911
1984
|
# @return [String]
|
1912
1985
|
#
|
1913
1986
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobsResponse AWS API Documentation
|
@@ -1928,7 +2001,8 @@ module Aws::GlueDataBrew
|
|
1928
2001
|
# }
|
1929
2002
|
#
|
1930
2003
|
# @!attribute [rw] next_token
|
1931
|
-
#
|
2004
|
+
# The token returned by a previous call to retrieve the next set of
|
2005
|
+
# results.
|
1932
2006
|
# @return [String]
|
1933
2007
|
#
|
1934
2008
|
# @!attribute [rw] max_results
|
@@ -1945,14 +2019,12 @@ module Aws::GlueDataBrew
|
|
1945
2019
|
end
|
1946
2020
|
|
1947
2021
|
# @!attribute [rw] projects
|
1948
|
-
# A list of projects that are defined
|
2022
|
+
# A list of projects that are defined .
|
1949
2023
|
# @return [Array<Types::Project>]
|
1950
2024
|
#
|
1951
2025
|
# @!attribute [rw] next_token
|
1952
|
-
# A token
|
1953
|
-
#
|
1954
|
-
# of pages, pass in the NextToken value from the response object of
|
1955
|
-
# the previous page call.
|
2026
|
+
# A token that you can use in a subsequent call to retrieve the next
|
2027
|
+
# set of results.
|
1956
2028
|
# @return [String]
|
1957
2029
|
#
|
1958
2030
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListProjectsResponse AWS API Documentation
|
@@ -1978,7 +2050,8 @@ module Aws::GlueDataBrew
|
|
1978
2050
|
# @return [Integer]
|
1979
2051
|
#
|
1980
2052
|
# @!attribute [rw] next_token
|
1981
|
-
#
|
2053
|
+
# The token returned by a previous call to retrieve the next set of
|
2054
|
+
# results.
|
1982
2055
|
# @return [String]
|
1983
2056
|
#
|
1984
2057
|
# @!attribute [rw] name
|
@@ -1996,10 +2069,8 @@ module Aws::GlueDataBrew
|
|
1996
2069
|
end
|
1997
2070
|
|
1998
2071
|
# @!attribute [rw] next_token
|
1999
|
-
# A token
|
2000
|
-
#
|
2001
|
-
# of pages, pass in the NextToken value from the response object of
|
2002
|
-
# the previous page call.
|
2072
|
+
# A token that you can use in a subsequent call to retrieve the next
|
2073
|
+
# set of results.
|
2003
2074
|
# @return [String]
|
2004
2075
|
#
|
2005
2076
|
# @!attribute [rw] recipes
|
@@ -2029,12 +2100,17 @@ module Aws::GlueDataBrew
|
|
2029
2100
|
# @return [Integer]
|
2030
2101
|
#
|
2031
2102
|
# @!attribute [rw] next_token
|
2032
|
-
#
|
2103
|
+
# The token returned by a previous call to retrieve the next set of
|
2104
|
+
# results.
|
2033
2105
|
# @return [String]
|
2034
2106
|
#
|
2035
2107
|
# @!attribute [rw] recipe_version
|
2036
|
-
#
|
2037
|
-
#
|
2108
|
+
# Return only those recipes with a version identifier of
|
2109
|
+
# `LATEST_WORKING` or `LATEST_PUBLISHED`. If `RecipeVersion` is
|
2110
|
+
# omitted, `ListRecipes` returns all of the `LATEST_PUBLISHED` recipe
|
2111
|
+
# versions.
|
2112
|
+
#
|
2113
|
+
# Valid values: `LATEST_WORKING` \| `LATEST_PUBLISHED`
|
2038
2114
|
# @return [String]
|
2039
2115
|
#
|
2040
2116
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRecipesRequest AWS API Documentation
|
@@ -2048,14 +2124,12 @@ module Aws::GlueDataBrew
|
|
2048
2124
|
end
|
2049
2125
|
|
2050
2126
|
# @!attribute [rw] recipes
|
2051
|
-
# A list of recipes that are defined
|
2127
|
+
# A list of recipes that are defined.
|
2052
2128
|
# @return [Array<Types::Recipe>]
|
2053
2129
|
#
|
2054
2130
|
# @!attribute [rw] next_token
|
2055
|
-
# A token
|
2056
|
-
#
|
2057
|
-
# of pages, pass in the NextToken value from the response object of
|
2058
|
-
# the previous page call.
|
2131
|
+
# A token that you can use in a subsequent call to retrieve the next
|
2132
|
+
# set of results.
|
2059
2133
|
# @return [String]
|
2060
2134
|
#
|
2061
2135
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRecipesResponse AWS API Documentation
|
@@ -2085,7 +2159,8 @@ module Aws::GlueDataBrew
|
|
2085
2159
|
# @return [Integer]
|
2086
2160
|
#
|
2087
2161
|
# @!attribute [rw] next_token
|
2088
|
-
#
|
2162
|
+
# The token returned by a previous call to retrieve the next set of
|
2163
|
+
# results.
|
2089
2164
|
# @return [String]
|
2090
2165
|
#
|
2091
2166
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListSchedulesRequest AWS API Documentation
|
@@ -2099,14 +2174,12 @@ module Aws::GlueDataBrew
|
|
2099
2174
|
end
|
2100
2175
|
|
2101
2176
|
# @!attribute [rw] schedules
|
2102
|
-
# A list of schedules
|
2177
|
+
# A list of schedules that are defined.
|
2103
2178
|
# @return [Array<Types::Schedule>]
|
2104
2179
|
#
|
2105
2180
|
# @!attribute [rw] next_token
|
2106
|
-
# A token
|
2107
|
-
#
|
2108
|
-
# of pages, pass in the NextToken value from the response object of
|
2109
|
-
# the previous page call.
|
2181
|
+
# A token that you can use in a subsequent call to retrieve the next
|
2182
|
+
# set of results.
|
2110
2183
|
# @return [String]
|
2111
2184
|
#
|
2112
2185
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListSchedulesResponse AWS API Documentation
|
@@ -2150,7 +2223,8 @@ module Aws::GlueDataBrew
|
|
2150
2223
|
include Aws::Structure
|
2151
2224
|
end
|
2152
2225
|
|
2153
|
-
#
|
2226
|
+
# Parameters that specify how and where DataBrew will write the output
|
2227
|
+
# generated by recipe jobs or profile jobs.
|
2154
2228
|
#
|
2155
2229
|
# @note When making an API call, you may pass Output
|
2156
2230
|
# data as a hash:
|
@@ -2164,6 +2238,11 @@ module Aws::GlueDataBrew
|
|
2164
2238
|
# key: "Key",
|
2165
2239
|
# },
|
2166
2240
|
# overwrite: false,
|
2241
|
+
# format_options: {
|
2242
|
+
# csv: {
|
2243
|
+
# delimiter: "Delimiter",
|
2244
|
+
# },
|
2245
|
+
# },
|
2167
2246
|
# }
|
2168
2247
|
#
|
2169
2248
|
# @!attribute [rw] compression_format
|
@@ -2189,6 +2268,10 @@ module Aws::GlueDataBrew
|
|
2189
2268
|
# for output is overwritten with new output.
|
2190
2269
|
# @return [Boolean]
|
2191
2270
|
#
|
2271
|
+
# @!attribute [rw] format_options
|
2272
|
+
# Options that define how DataBrew formats job output files.
|
2273
|
+
# @return [Types::OutputFormatOptions]
|
2274
|
+
#
|
2192
2275
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/Output AWS API Documentation
|
2193
2276
|
#
|
2194
2277
|
class Output < Struct.new(
|
@@ -2196,12 +2279,36 @@ module Aws::GlueDataBrew
|
|
2196
2279
|
:format,
|
2197
2280
|
:partition_columns,
|
2198
2281
|
:location,
|
2199
|
-
:overwrite
|
2282
|
+
:overwrite,
|
2283
|
+
:format_options)
|
2284
|
+
SENSITIVE = []
|
2285
|
+
include Aws::Structure
|
2286
|
+
end
|
2287
|
+
|
2288
|
+
# Options that define the structure of Csv job output.
|
2289
|
+
#
|
2290
|
+
# @note When making an API call, you may pass OutputFormatOptions
|
2291
|
+
# data as a hash:
|
2292
|
+
#
|
2293
|
+
# {
|
2294
|
+
# csv: {
|
2295
|
+
# delimiter: "Delimiter",
|
2296
|
+
# },
|
2297
|
+
# }
|
2298
|
+
#
|
2299
|
+
# @!attribute [rw] csv
|
2300
|
+
# Options that define how DataBrew writes Csv output.
|
2301
|
+
# @return [Types::CsvOutputOptions]
|
2302
|
+
#
|
2303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/OutputFormatOptions AWS API Documentation
|
2304
|
+
#
|
2305
|
+
class OutputFormatOptions < Struct.new(
|
2306
|
+
:csv)
|
2200
2307
|
SENSITIVE = []
|
2201
2308
|
include Aws::Structure
|
2202
2309
|
end
|
2203
2310
|
|
2204
|
-
# Represents all of the attributes of
|
2311
|
+
# Represents all of the attributes of a DataBrew project.
|
2205
2312
|
#
|
2206
2313
|
# @!attribute [rw] account_id
|
2207
2314
|
# The ID of the AWS account that owns the project.
|
@@ -2212,7 +2319,7 @@ module Aws::GlueDataBrew
|
|
2212
2319
|
# @return [Time]
|
2213
2320
|
#
|
2214
2321
|
# @!attribute [rw] created_by
|
2215
|
-
# The
|
2322
|
+
# The Amazon Resource Name (ARN) of the user who crated the project.
|
2216
2323
|
# @return [String]
|
2217
2324
|
#
|
2218
2325
|
# @!attribute [rw] dataset_name
|
@@ -2224,7 +2331,7 @@ module Aws::GlueDataBrew
|
|
2224
2331
|
# @return [Time]
|
2225
2332
|
#
|
2226
2333
|
# @!attribute [rw] last_modified_by
|
2227
|
-
# The
|
2334
|
+
# The Amazon Resource Name (ARN) of the user who last modified the
|
2228
2335
|
# project.
|
2229
2336
|
# @return [String]
|
2230
2337
|
#
|
@@ -2257,7 +2364,7 @@ module Aws::GlueDataBrew
|
|
2257
2364
|
# @return [String]
|
2258
2365
|
#
|
2259
2366
|
# @!attribute [rw] opened_by
|
2260
|
-
# The
|
2367
|
+
# The Amazon Resource Name (ARN) of the user that opened the project
|
2261
2368
|
# for use.
|
2262
2369
|
# @return [String]
|
2263
2370
|
#
|
@@ -2324,11 +2431,10 @@ module Aws::GlueDataBrew
|
|
2324
2431
|
include Aws::Structure
|
2325
2432
|
end
|
2326
2433
|
|
2327
|
-
# Represents one or more actions to be performed on
|
2328
|
-
# dataset.
|
2434
|
+
# Represents one or more actions to be performed on a DataBrew dataset.
|
2329
2435
|
#
|
2330
2436
|
# @!attribute [rw] created_by
|
2331
|
-
# The
|
2437
|
+
# The Amazon Resource Name (ARN) of the user who created the recipe.
|
2332
2438
|
# @return [String]
|
2333
2439
|
#
|
2334
2440
|
# @!attribute [rw] create_date
|
@@ -2336,7 +2442,8 @@ module Aws::GlueDataBrew
|
|
2336
2442
|
# @return [Time]
|
2337
2443
|
#
|
2338
2444
|
# @!attribute [rw] last_modified_by
|
2339
|
-
# The
|
2445
|
+
# The Amazon Resource Name (ARN) of the user who last modified the
|
2446
|
+
# recipe.
|
2340
2447
|
# @return [String]
|
2341
2448
|
#
|
2342
2449
|
# @!attribute [rw] last_modified_date
|
@@ -2348,7 +2455,7 @@ module Aws::GlueDataBrew
|
|
2348
2455
|
# @return [String]
|
2349
2456
|
#
|
2350
2457
|
# @!attribute [rw] published_by
|
2351
|
-
# The
|
2458
|
+
# The Amazon Resource Name (ARN) of the user who published the recipe.
|
2352
2459
|
# @return [String]
|
2353
2460
|
#
|
2354
2461
|
# @!attribute [rw] published_date
|
@@ -2376,7 +2483,18 @@ module Aws::GlueDataBrew
|
|
2376
2483
|
# @return [Hash<String,String>]
|
2377
2484
|
#
|
2378
2485
|
# @!attribute [rw] recipe_version
|
2379
|
-
# The identifier for the version for the recipe.
|
2486
|
+
# The identifier for the version for the recipe. Must be one of the
|
2487
|
+
# following:
|
2488
|
+
#
|
2489
|
+
# * Numeric version (`X.Y`) - `X` and `Y` stand for major and minor
|
2490
|
+
# version numbers. The maximum length of each is 6 digits, and
|
2491
|
+
# neither can be negative values. Both `X` and `Y` are required, and
|
2492
|
+
# "0.0" is not a valid version.
|
2493
|
+
#
|
2494
|
+
# * `LATEST_WORKING` - the most recent valid version being developed
|
2495
|
+
# in a DataBrew project.
|
2496
|
+
#
|
2497
|
+
# * `LATEST_PUBLISHED` - the most recent published version.
|
2380
2498
|
# @return [String]
|
2381
2499
|
#
|
2382
2500
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/Recipe AWS API Documentation
|
@@ -2400,8 +2518,8 @@ module Aws::GlueDataBrew
|
|
2400
2518
|
end
|
2401
2519
|
|
2402
2520
|
# Represents a transformation and associated parameters that are used to
|
2403
|
-
# apply a change to
|
2404
|
-
#
|
2521
|
+
# apply a change to a DataBrew dataset. For more information, see
|
2522
|
+
# [Recipe structure][1] and [Recipe actions reference][2].
|
2405
2523
|
#
|
2406
2524
|
#
|
2407
2525
|
#
|
@@ -2436,7 +2554,7 @@ module Aws::GlueDataBrew
|
|
2436
2554
|
include Aws::Structure
|
2437
2555
|
end
|
2438
2556
|
|
2439
|
-
# Represents
|
2557
|
+
# Represents the name and version of a DataBrew recipe.
|
2440
2558
|
#
|
2441
2559
|
# @note When making an API call, you may pass RecipeReference
|
2442
2560
|
# data as a hash:
|
@@ -2463,8 +2581,7 @@ module Aws::GlueDataBrew
|
|
2463
2581
|
include Aws::Structure
|
2464
2582
|
end
|
2465
2583
|
|
2466
|
-
# Represents a single step
|
2467
|
-
# recipe.
|
2584
|
+
# Represents a single step from a DataBrew recipe to be performed.
|
2468
2585
|
#
|
2469
2586
|
# @note When making an API call, you may pass RecipeStep
|
2470
2587
|
# data as a hash:
|
@@ -2574,8 +2691,8 @@ module Aws::GlueDataBrew
|
|
2574
2691
|
include Aws::Structure
|
2575
2692
|
end
|
2576
2693
|
|
2577
|
-
# Represents the sample size and sampling type for
|
2578
|
-
#
|
2694
|
+
# Represents the sample size and sampling type for DataBrew to use for
|
2695
|
+
# interactive data analysis.
|
2579
2696
|
#
|
2580
2697
|
# @note When making an API call, you may pass Sample
|
2581
2698
|
# data as a hash:
|
@@ -2609,7 +2726,7 @@ module Aws::GlueDataBrew
|
|
2609
2726
|
# @return [String]
|
2610
2727
|
#
|
2611
2728
|
# @!attribute [rw] created_by
|
2612
|
-
# The
|
2729
|
+
# The Amazon Resource Name (ARN) of the user who created the schedule.
|
2613
2730
|
# @return [String]
|
2614
2731
|
#
|
2615
2732
|
# @!attribute [rw] create_date
|
@@ -2621,7 +2738,7 @@ module Aws::GlueDataBrew
|
|
2621
2738
|
# @return [Array<String>]
|
2622
2739
|
#
|
2623
2740
|
# @!attribute [rw] last_modified_by
|
2624
|
-
# The
|
2741
|
+
# The Amazon Resource Name (ARN) of the user who last modified the
|
2625
2742
|
# schedule.
|
2626
2743
|
# @return [String]
|
2627
2744
|
#
|
@@ -2634,7 +2751,13 @@ module Aws::GlueDataBrew
|
|
2634
2751
|
# @return [String]
|
2635
2752
|
#
|
2636
2753
|
# @!attribute [rw] cron_expression
|
2637
|
-
# The date(s) and time(s)
|
2754
|
+
# The date(s) and time(s) when the job will run. For more information,
|
2755
|
+
# see [Cron expressions][1] in the *AWS Glue DataBrew Developer
|
2756
|
+
# Guide*.
|
2757
|
+
#
|
2758
|
+
#
|
2759
|
+
#
|
2760
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html
|
2638
2761
|
# @return [String]
|
2639
2762
|
#
|
2640
2763
|
# @!attribute [rw] tags
|
@@ -2693,8 +2816,8 @@ module Aws::GlueDataBrew
|
|
2693
2816
|
# }
|
2694
2817
|
#
|
2695
2818
|
# @!attribute [rw] preview
|
2696
|
-
#
|
2697
|
-
#
|
2819
|
+
# If true, the result of the recipe step will be returned, but not
|
2820
|
+
# applied.
|
2698
2821
|
# @return [Boolean]
|
2699
2822
|
#
|
2700
2823
|
# @!attribute [rw] name
|
@@ -2702,8 +2825,7 @@ module Aws::GlueDataBrew
|
|
2702
2825
|
# @return [String]
|
2703
2826
|
#
|
2704
2827
|
# @!attribute [rw] recipe_step
|
2705
|
-
# Represents a single step
|
2706
|
-
# recipe.
|
2828
|
+
# Represents a single step from a DataBrew recipe to be performed.
|
2707
2829
|
# @return [Types::RecipeStep]
|
2708
2830
|
#
|
2709
2831
|
# @!attribute [rw] step_index
|
@@ -2719,8 +2841,7 @@ module Aws::GlueDataBrew
|
|
2719
2841
|
# @return [String]
|
2720
2842
|
#
|
2721
2843
|
# @!attribute [rw] view_frame
|
2722
|
-
# Represents the data being being transformed during an
|
2723
|
-
# DataBrew project session.
|
2844
|
+
# Represents the data being being transformed during an action.
|
2724
2845
|
# @return [Types::ViewFrame]
|
2725
2846
|
#
|
2726
2847
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/SendProjectSessionActionRequest AWS API Documentation
|
@@ -2924,8 +3045,8 @@ module Aws::GlueDataBrew
|
|
2924
3045
|
# }
|
2925
3046
|
#
|
2926
3047
|
# @!attribute [rw] resource_arn
|
2927
|
-
#
|
2928
|
-
#
|
3048
|
+
# A DataBrew resource from which you want to remove a tag or tags. The
|
3049
|
+
# value for this parameter is an Amazon Resource Name (ARN).
|
2929
3050
|
# @return [String]
|
2930
3051
|
#
|
2931
3052
|
# @!attribute [rw] tag_keys
|
@@ -2958,6 +3079,9 @@ module Aws::GlueDataBrew
|
|
2958
3079
|
# sheet_names: ["SheetName"],
|
2959
3080
|
# sheet_indexes: [1],
|
2960
3081
|
# },
|
3082
|
+
# csv: {
|
3083
|
+
# delimiter: "Delimiter",
|
3084
|
+
# },
|
2961
3085
|
# },
|
2962
3086
|
# input: { # required
|
2963
3087
|
# s3_input_definition: {
|
@@ -2981,13 +3105,13 @@ module Aws::GlueDataBrew
|
|
2981
3105
|
# @return [String]
|
2982
3106
|
#
|
2983
3107
|
# @!attribute [rw] format_options
|
2984
|
-
# Options that define
|
2985
|
-
#
|
3108
|
+
# Options that define the structure of either Csv, Excel, or JSON
|
3109
|
+
# input.
|
2986
3110
|
# @return [Types::FormatOptions]
|
2987
3111
|
#
|
2988
3112
|
# @!attribute [rw] input
|
2989
|
-
# Information on how
|
2990
|
-
#
|
3113
|
+
# Information on how DataBrew can find data, in either the AWS Glue
|
3114
|
+
# Data Catalog or Amazon S3.
|
2991
3115
|
# @return [Types::Input]
|
2992
3116
|
#
|
2993
3117
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateDatasetRequest AWS API Documentation
|
@@ -3048,14 +3172,14 @@ module Aws::GlueDataBrew
|
|
3048
3172
|
# @return [String]
|
3049
3173
|
#
|
3050
3174
|
# @!attribute [rw] log_subscription
|
3051
|
-
#
|
3052
|
-
#
|
3053
|
-
#
|
3175
|
+
# Enables or disables Amazon CloudWatch logging for the job. If
|
3176
|
+
# logging is enabled, CloudWatch writes one log stream for each job
|
3177
|
+
# run.
|
3054
3178
|
# @return [String]
|
3055
3179
|
#
|
3056
3180
|
# @!attribute [rw] max_capacity
|
3057
|
-
# The maximum number of nodes that DataBrew can use when the
|
3058
|
-
# processes data.
|
3181
|
+
# The maximum number of compute nodes that DataBrew can use when the
|
3182
|
+
# job processes data.
|
3059
3183
|
# @return [Integer]
|
3060
3184
|
#
|
3061
3185
|
# @!attribute [rw] max_retries
|
@@ -3069,7 +3193,7 @@ module Aws::GlueDataBrew
|
|
3069
3193
|
#
|
3070
3194
|
# @!attribute [rw] role_arn
|
3071
3195
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
3072
|
-
# Management (IAM) role to be assumed
|
3196
|
+
# Management (IAM) role to be assumed when DataBrew runs the job.
|
3073
3197
|
# @return [String]
|
3074
3198
|
#
|
3075
3199
|
# @!attribute [rw] timeout
|
@@ -3118,8 +3242,8 @@ module Aws::GlueDataBrew
|
|
3118
3242
|
# }
|
3119
3243
|
#
|
3120
3244
|
# @!attribute [rw] sample
|
3121
|
-
# Represents the sample size and sampling type for
|
3122
|
-
#
|
3245
|
+
# Represents the sample size and sampling type for DataBrew to use for
|
3246
|
+
# interactive data analysis.
|
3123
3247
|
# @return [Types::Sample]
|
3124
3248
|
#
|
3125
3249
|
# @!attribute [rw] role_arn
|
@@ -3178,6 +3302,11 @@ module Aws::GlueDataBrew
|
|
3178
3302
|
# key: "Key",
|
3179
3303
|
# },
|
3180
3304
|
# overwrite: false,
|
3305
|
+
# format_options: {
|
3306
|
+
# csv: {
|
3307
|
+
# delimiter: "Delimiter",
|
3308
|
+
# },
|
3309
|
+
# },
|
3181
3310
|
# },
|
3182
3311
|
# ],
|
3183
3312
|
# role_arn: "Arn", # required
|
@@ -3202,9 +3331,9 @@ module Aws::GlueDataBrew
|
|
3202
3331
|
# @return [String]
|
3203
3332
|
#
|
3204
3333
|
# @!attribute [rw] log_subscription
|
3205
|
-
#
|
3206
|
-
#
|
3207
|
-
#
|
3334
|
+
# Enables or disables Amazon CloudWatch logging for the job. If
|
3335
|
+
# logging is enabled, CloudWatch writes one log stream for each job
|
3336
|
+
# run.
|
3208
3337
|
# @return [String]
|
3209
3338
|
#
|
3210
3339
|
# @!attribute [rw] max_capacity
|
@@ -3223,7 +3352,7 @@ module Aws::GlueDataBrew
|
|
3223
3352
|
#
|
3224
3353
|
# @!attribute [rw] role_arn
|
3225
3354
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
3226
|
-
# Management (IAM) role to be assumed
|
3355
|
+
# Management (IAM) role to be assumed when DataBrew runs the job.
|
3227
3356
|
# @return [String]
|
3228
3357
|
#
|
3229
3358
|
# @!attribute [rw] timeout
|
@@ -3334,8 +3463,13 @@ module Aws::GlueDataBrew
|
|
3334
3463
|
# @return [Array<String>]
|
3335
3464
|
#
|
3336
3465
|
# @!attribute [rw] cron_expression
|
3337
|
-
# The date or dates and time or times
|
3338
|
-
#
|
3466
|
+
# The date or dates and time or times when the jobs are to be run. For
|
3467
|
+
# more information, see [Cron expressions][1] in the *AWS Glue
|
3468
|
+
# DataBrew Developer Guide*.
|
3469
|
+
#
|
3470
|
+
#
|
3471
|
+
#
|
3472
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html
|
3339
3473
|
# @return [String]
|
3340
3474
|
#
|
3341
3475
|
# @!attribute [rw] name
|
@@ -3377,8 +3511,7 @@ module Aws::GlueDataBrew
|
|
3377
3511
|
include Aws::Structure
|
3378
3512
|
end
|
3379
3513
|
|
3380
|
-
# Represents the data being being transformed during an
|
3381
|
-
# DataBrew project session.
|
3514
|
+
# Represents the data being being transformed during an action.
|
3382
3515
|
#
|
3383
3516
|
# @note When making an API call, you may pass ViewFrame
|
3384
3517
|
# data as a hash:
|