aws-sdk-gluedatabrew 1.7.0 → 1.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-gluedatabrew.rb +1 -1
- data/lib/aws-sdk-gluedatabrew/client.rb +122 -30
- data/lib/aws-sdk-gluedatabrew/client_api.rb +29 -2
- data/lib/aws-sdk-gluedatabrew/types.rb +306 -96
- metadata +3 -4
@@ -89,7 +89,7 @@ module Aws::GlueDataBrew
|
|
89
89
|
#
|
90
90
|
# @!attribute [rw] condition
|
91
91
|
# A specific condition to apply to a recipe action. For more
|
92
|
-
# information, see [Recipe structure][1] in the *
|
92
|
+
# information, see [Recipe structure][1] in the *Glue DataBrew
|
93
93
|
# Developer Guide*.
|
94
94
|
#
|
95
95
|
#
|
@@ -214,8 +214,8 @@ module Aws::GlueDataBrew
|
|
214
214
|
# @return [String]
|
215
215
|
#
|
216
216
|
# @!attribute [rw] format
|
217
|
-
# The file format of a dataset that is created from an S3 file
|
218
|
-
# folder.
|
217
|
+
# The file format of a dataset that is created from an Amazon S3 file
|
218
|
+
# or folder.
|
219
219
|
# @return [String]
|
220
220
|
#
|
221
221
|
# @!attribute [rw] format_options
|
@@ -225,12 +225,12 @@ module Aws::GlueDataBrew
|
|
225
225
|
#
|
226
226
|
# @!attribute [rw] input
|
227
227
|
# Represents information on how DataBrew can find data, in either the
|
228
|
-
#
|
228
|
+
# Glue Data Catalog or Amazon S3.
|
229
229
|
# @return [Types::Input]
|
230
230
|
#
|
231
231
|
# @!attribute [rw] path_options
|
232
|
-
# A set of options that defines how DataBrew interprets an S3
|
233
|
-
# the dataset.
|
232
|
+
# A set of options that defines how DataBrew interprets an Amazon S3
|
233
|
+
# path of the dataset.
|
234
234
|
# @return [Types::PathOptions]
|
235
235
|
#
|
236
236
|
# @!attribute [rw] tags
|
@@ -300,8 +300,8 @@ module Aws::GlueDataBrew
|
|
300
300
|
# @!attribute [rw] encryption_mode
|
301
301
|
# The encryption mode for the job, which can be one of the following:
|
302
302
|
#
|
303
|
-
# * `SSE-KMS` - `SSE-KMS` - Server-side encryption with
|
304
|
-
#
|
303
|
+
# * `SSE-KMS` - `SSE-KMS` - Server-side encryption with KMS-managed
|
304
|
+
# keys.
|
305
305
|
#
|
306
306
|
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
307
307
|
# @return [String]
|
@@ -332,8 +332,8 @@ module Aws::GlueDataBrew
|
|
332
332
|
# @return [Types::S3Location]
|
333
333
|
#
|
334
334
|
# @!attribute [rw] role_arn
|
335
|
-
# The Amazon Resource Name (ARN) of the
|
336
|
-
#
|
335
|
+
# The Amazon Resource Name (ARN) of the Identity and Access Management
|
336
|
+
# (IAM) role to be assumed when DataBrew runs the job.
|
337
337
|
# @return [String]
|
338
338
|
#
|
339
339
|
# @!attribute [rw] tags
|
@@ -420,8 +420,8 @@ module Aws::GlueDataBrew
|
|
420
420
|
# @return [Types::Sample]
|
421
421
|
#
|
422
422
|
# @!attribute [rw] role_arn
|
423
|
-
# The Amazon Resource Name (ARN) of the
|
424
|
-
#
|
423
|
+
# The Amazon Resource Name (ARN) of the Identity and Access Management
|
424
|
+
# (IAM) role to be assumed for this request.
|
425
425
|
# @return [String]
|
426
426
|
#
|
427
427
|
# @!attribute [rw] tags
|
@@ -464,7 +464,7 @@ module Aws::GlueDataBrew
|
|
464
464
|
# log_subscription: "ENABLE", # accepts ENABLE, DISABLE
|
465
465
|
# max_capacity: 1,
|
466
466
|
# max_retries: 1,
|
467
|
-
# outputs: [
|
467
|
+
# outputs: [
|
468
468
|
# {
|
469
469
|
# compression_format: "GZIP", # accepts GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB
|
470
470
|
# format: "CSV", # accepts CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML
|
@@ -481,6 +481,27 @@ module Aws::GlueDataBrew
|
|
481
481
|
# },
|
482
482
|
# },
|
483
483
|
# ],
|
484
|
+
# data_catalog_outputs: [
|
485
|
+
# {
|
486
|
+
# catalog_id: "CatalogId",
|
487
|
+
# database_name: "DatabaseName", # required
|
488
|
+
# table_name: "TableName", # required
|
489
|
+
# s3_options: {
|
490
|
+
# location: { # required
|
491
|
+
# bucket: "Bucket", # required
|
492
|
+
# key: "Key",
|
493
|
+
# },
|
494
|
+
# },
|
495
|
+
# database_options: {
|
496
|
+
# temp_directory: {
|
497
|
+
# bucket: "Bucket", # required
|
498
|
+
# key: "Key",
|
499
|
+
# },
|
500
|
+
# table_name: "DatabaseTableName", # required
|
501
|
+
# },
|
502
|
+
# overwrite: false,
|
503
|
+
# },
|
504
|
+
# ],
|
484
505
|
# project_name: "ProjectName",
|
485
506
|
# recipe_reference: {
|
486
507
|
# name: "RecipeName", # required
|
@@ -505,7 +526,7 @@ module Aws::GlueDataBrew
|
|
505
526
|
# @!attribute [rw] encryption_mode
|
506
527
|
# The encryption mode for the job, which can be one of the following:
|
507
528
|
#
|
508
|
-
# * `SSE-KMS` - Server-side encryption with keys managed by
|
529
|
+
# * `SSE-KMS` - Server-side encryption with keys managed by KMS.
|
509
530
|
#
|
510
531
|
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
511
532
|
# @return [String]
|
@@ -535,6 +556,11 @@ module Aws::GlueDataBrew
|
|
535
556
|
# job.
|
536
557
|
# @return [Array<Types::Output>]
|
537
558
|
#
|
559
|
+
# @!attribute [rw] data_catalog_outputs
|
560
|
+
# One or more artifacts that represent the AWS Glue Data Catalog
|
561
|
+
# output from running the job.
|
562
|
+
# @return [Array<Types::DataCatalogOutput>]
|
563
|
+
#
|
538
564
|
# @!attribute [rw] project_name
|
539
565
|
# Either the name of an existing project, or a combination of a recipe
|
540
566
|
# and a dataset to associate with the recipe.
|
@@ -545,8 +571,8 @@ module Aws::GlueDataBrew
|
|
545
571
|
# @return [Types::RecipeReference]
|
546
572
|
#
|
547
573
|
# @!attribute [rw] role_arn
|
548
|
-
# The Amazon Resource Name (ARN) of the
|
549
|
-
#
|
574
|
+
# The Amazon Resource Name (ARN) of the Identity and Access Management
|
575
|
+
# (IAM) role to be assumed when DataBrew runs the job.
|
550
576
|
# @return [String]
|
551
577
|
#
|
552
578
|
# @!attribute [rw] tags
|
@@ -569,6 +595,7 @@ module Aws::GlueDataBrew
|
|
569
595
|
:max_capacity,
|
570
596
|
:max_retries,
|
571
597
|
:outputs,
|
598
|
+
:data_catalog_outputs,
|
572
599
|
:project_name,
|
573
600
|
:recipe_reference,
|
574
601
|
:role_arn,
|
@@ -678,8 +705,8 @@ module Aws::GlueDataBrew
|
|
678
705
|
#
|
679
706
|
# @!attribute [rw] cron_expression
|
680
707
|
# The date or dates and time or times when the jobs are to be run. For
|
681
|
-
# more information, see [Cron expressions][1] in the *
|
682
|
-
#
|
708
|
+
# more information, see [Cron expressions][1] in the *Glue DataBrew
|
709
|
+
# Developer Guide*.
|
683
710
|
#
|
684
711
|
#
|
685
712
|
#
|
@@ -773,8 +800,8 @@ module Aws::GlueDataBrew
|
|
773
800
|
include Aws::Structure
|
774
801
|
end
|
775
802
|
|
776
|
-
# Represents how metadata stored in the
|
777
|
-
#
|
803
|
+
# Represents how metadata stored in the Glue Data Catalog is defined in
|
804
|
+
# a DataBrew dataset.
|
778
805
|
#
|
779
806
|
# @note When making an API call, you may pass DataCatalogInputDefinition
|
780
807
|
# data as a hash:
|
@@ -790,8 +817,8 @@ module Aws::GlueDataBrew
|
|
790
817
|
# }
|
791
818
|
#
|
792
819
|
# @!attribute [rw] catalog_id
|
793
|
-
# The unique identifier of the
|
794
|
-
# that stores the data.
|
820
|
+
# The unique identifier of the Amazon Web Services account that holds
|
821
|
+
# the Data Catalog that stores the data.
|
795
822
|
# @return [String]
|
796
823
|
#
|
797
824
|
# @!attribute [rw] database_name
|
@@ -804,8 +831,8 @@ module Aws::GlueDataBrew
|
|
804
831
|
# @return [String]
|
805
832
|
#
|
806
833
|
# @!attribute [rw] temp_directory
|
807
|
-
#
|
808
|
-
#
|
834
|
+
# Represents an Amazon location where DataBrew can store intermediate
|
835
|
+
# results.
|
809
836
|
# @return [Types::S3Location]
|
810
837
|
#
|
811
838
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DataCatalogInputDefinition AWS API Documentation
|
@@ -819,6 +846,74 @@ module Aws::GlueDataBrew
|
|
819
846
|
include Aws::Structure
|
820
847
|
end
|
821
848
|
|
849
|
+
# Represents options that specify how and where DataBrew writes the
|
850
|
+
# output generated by recipe jobs.
|
851
|
+
#
|
852
|
+
# @note When making an API call, you may pass DataCatalogOutput
|
853
|
+
# data as a hash:
|
854
|
+
#
|
855
|
+
# {
|
856
|
+
# catalog_id: "CatalogId",
|
857
|
+
# database_name: "DatabaseName", # required
|
858
|
+
# table_name: "TableName", # required
|
859
|
+
# s3_options: {
|
860
|
+
# location: { # required
|
861
|
+
# bucket: "Bucket", # required
|
862
|
+
# key: "Key",
|
863
|
+
# },
|
864
|
+
# },
|
865
|
+
# database_options: {
|
866
|
+
# temp_directory: {
|
867
|
+
# bucket: "Bucket", # required
|
868
|
+
# key: "Key",
|
869
|
+
# },
|
870
|
+
# table_name: "DatabaseTableName", # required
|
871
|
+
# },
|
872
|
+
# overwrite: false,
|
873
|
+
# }
|
874
|
+
#
|
875
|
+
# @!attribute [rw] catalog_id
|
876
|
+
# The unique identifier of the AWS account that holds the Data Catalog
|
877
|
+
# that stores the data.
|
878
|
+
# @return [String]
|
879
|
+
#
|
880
|
+
# @!attribute [rw] database_name
|
881
|
+
# The name of a database in the Data Catalog.
|
882
|
+
# @return [String]
|
883
|
+
#
|
884
|
+
# @!attribute [rw] table_name
|
885
|
+
# The name of a table in the Data Catalog.
|
886
|
+
# @return [String]
|
887
|
+
#
|
888
|
+
# @!attribute [rw] s3_options
|
889
|
+
# Represents options that specify how and where DataBrew writes the S3
|
890
|
+
# output generated by recipe jobs.
|
891
|
+
# @return [Types::S3TableOutputOptions]
|
892
|
+
#
|
893
|
+
# @!attribute [rw] database_options
|
894
|
+
# Represents options that specify how and where DataBrew writes the
|
895
|
+
# database output generated by recipe jobs.
|
896
|
+
# @return [Types::DatabaseTableOutputOptions]
|
897
|
+
#
|
898
|
+
# @!attribute [rw] overwrite
|
899
|
+
# A value that, if true, means that any data in the location specified
|
900
|
+
# for output is overwritten with new output. Not supported with
|
901
|
+
# DatabaseOptions.
|
902
|
+
# @return [Boolean]
|
903
|
+
#
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DataCatalogOutput AWS API Documentation
|
905
|
+
#
|
906
|
+
class DataCatalogOutput < Struct.new(
|
907
|
+
:catalog_id,
|
908
|
+
:database_name,
|
909
|
+
:table_name,
|
910
|
+
:s3_options,
|
911
|
+
:database_options,
|
912
|
+
:overwrite)
|
913
|
+
SENSITIVE = []
|
914
|
+
include Aws::Structure
|
915
|
+
end
|
916
|
+
|
822
917
|
# Connection information for dataset input files stored in a database.
|
823
918
|
#
|
824
919
|
# @note When making an API call, you may pass DatabaseInputDefinition
|
@@ -834,8 +929,8 @@ module Aws::GlueDataBrew
|
|
834
929
|
# }
|
835
930
|
#
|
836
931
|
# @!attribute [rw] glue_connection_name
|
837
|
-
# The
|
838
|
-
#
|
932
|
+
# The Glue Connection that stores the connection information for the
|
933
|
+
# target database.
|
839
934
|
# @return [String]
|
840
935
|
#
|
841
936
|
# @!attribute [rw] database_table_name
|
@@ -857,10 +952,43 @@ module Aws::GlueDataBrew
|
|
857
952
|
include Aws::Structure
|
858
953
|
end
|
859
954
|
|
955
|
+
# Represents options that specify how and where DataBrew writes the
|
956
|
+
# database output generated by recipe jobs.
|
957
|
+
#
|
958
|
+
# @note When making an API call, you may pass DatabaseTableOutputOptions
|
959
|
+
# data as a hash:
|
960
|
+
#
|
961
|
+
# {
|
962
|
+
# temp_directory: {
|
963
|
+
# bucket: "Bucket", # required
|
964
|
+
# key: "Key",
|
965
|
+
# },
|
966
|
+
# table_name: "DatabaseTableName", # required
|
967
|
+
# }
|
968
|
+
#
|
969
|
+
# @!attribute [rw] temp_directory
|
970
|
+
# Represents an Amazon S3 location (bucket name and object key) where
|
971
|
+
# DataBrew can store intermediate results.
|
972
|
+
# @return [Types::S3Location]
|
973
|
+
#
|
974
|
+
# @!attribute [rw] table_name
|
975
|
+
# A prefix for the name of a table DataBrew will create in the
|
976
|
+
# database.
|
977
|
+
# @return [String]
|
978
|
+
#
|
979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DatabaseTableOutputOptions AWS API Documentation
|
980
|
+
#
|
981
|
+
class DatabaseTableOutputOptions < Struct.new(
|
982
|
+
:temp_directory,
|
983
|
+
:table_name)
|
984
|
+
SENSITIVE = []
|
985
|
+
include Aws::Structure
|
986
|
+
end
|
987
|
+
|
860
988
|
# Represents a dataset that can be processed by DataBrew.
|
861
989
|
#
|
862
990
|
# @!attribute [rw] account_id
|
863
|
-
# The ID of the
|
991
|
+
# The ID of the Amazon Web Services account that owns the dataset.
|
864
992
|
# @return [String]
|
865
993
|
#
|
866
994
|
# @!attribute [rw] created_by
|
@@ -876,8 +1004,8 @@ module Aws::GlueDataBrew
|
|
876
1004
|
# @return [String]
|
877
1005
|
#
|
878
1006
|
# @!attribute [rw] format
|
879
|
-
# The file format of a dataset that is created from an S3 file
|
880
|
-
# folder.
|
1007
|
+
# The file format of a dataset that is created from an Amazon S3 file
|
1008
|
+
# or folder.
|
881
1009
|
# @return [String]
|
882
1010
|
#
|
883
1011
|
# @!attribute [rw] format_options
|
@@ -886,8 +1014,8 @@ module Aws::GlueDataBrew
|
|
886
1014
|
# @return [Types::FormatOptions]
|
887
1015
|
#
|
888
1016
|
# @!attribute [rw] input
|
889
|
-
# Information on how DataBrew can find the dataset, in either the
|
890
|
-
#
|
1017
|
+
# Information on how DataBrew can find the dataset, in either the Glue
|
1018
|
+
# Data Catalog or Amazon S3.
|
891
1019
|
# @return [Types::Input]
|
892
1020
|
#
|
893
1021
|
# @!attribute [rw] last_modified_date
|
@@ -901,12 +1029,12 @@ module Aws::GlueDataBrew
|
|
901
1029
|
#
|
902
1030
|
# @!attribute [rw] source
|
903
1031
|
# The location of the data for the dataset, either Amazon S3 or the
|
904
|
-
#
|
1032
|
+
# Glue Data Catalog.
|
905
1033
|
# @return [String]
|
906
1034
|
#
|
907
1035
|
# @!attribute [rw] path_options
|
908
|
-
# A set of options that defines how DataBrew interprets an S3
|
909
|
-
# the dataset.
|
1036
|
+
# A set of options that defines how DataBrew interprets an Amazon S3
|
1037
|
+
# path of the dataset.
|
910
1038
|
# @return [Types::PathOptions]
|
911
1039
|
#
|
912
1040
|
# @!attribute [rw] tags
|
@@ -938,7 +1066,7 @@ module Aws::GlueDataBrew
|
|
938
1066
|
end
|
939
1067
|
|
940
1068
|
# Represents a dataset paramater that defines type and conditions for a
|
941
|
-
# parameter in the S3 path of the dataset.
|
1069
|
+
# parameter in the Amazon S3 path of the dataset.
|
942
1070
|
#
|
943
1071
|
# @note When making an API call, you may pass DatasetParameter
|
944
1072
|
# data as a hash:
|
@@ -961,7 +1089,8 @@ module Aws::GlueDataBrew
|
|
961
1089
|
# }
|
962
1090
|
#
|
963
1091
|
# @!attribute [rw] name
|
964
|
-
# The name of the parameter that is used in the dataset's S3
|
1092
|
+
# The name of the parameter that is used in the dataset's Amazon S3
|
1093
|
+
# path.
|
965
1094
|
# @return [String]
|
966
1095
|
#
|
967
1096
|
# @!attribute [rw] type
|
@@ -976,8 +1105,7 @@ module Aws::GlueDataBrew
|
|
976
1105
|
#
|
977
1106
|
# @!attribute [rw] create_column
|
978
1107
|
# Optional boolean value that defines whether the captured value of
|
979
|
-
# this parameter should be
|
980
|
-
# dataset.
|
1108
|
+
# this parameter should be used to create a new column in a dataset.
|
981
1109
|
# @return [Boolean]
|
982
1110
|
#
|
983
1111
|
# @!attribute [rw] filter
|
@@ -998,7 +1126,7 @@ module Aws::GlueDataBrew
|
|
998
1126
|
end
|
999
1127
|
|
1000
1128
|
# Represents additional options for correct interpretation of datetime
|
1001
|
-
# parameters used in the S3 path of a dataset.
|
1129
|
+
# parameters used in the Amazon S3 path of a dataset.
|
1002
1130
|
#
|
1003
1131
|
# @note When making an API call, you may pass DatetimeOptions
|
1004
1132
|
# data as a hash:
|
@@ -1011,16 +1139,17 @@ module Aws::GlueDataBrew
|
|
1011
1139
|
#
|
1012
1140
|
# @!attribute [rw] format
|
1013
1141
|
# Required option, that defines the datetime format used for a date
|
1014
|
-
# parameter in the S3 path. Should use only supported datetime
|
1015
|
-
# specifiers and separation characters, all
|
1016
|
-
#
|
1142
|
+
# parameter in the Amazon S3 path. Should use only supported datetime
|
1143
|
+
# specifiers and separation characters, all literal a-z or A-Z
|
1144
|
+
# characters should be escaped with single quotes. E.g.
|
1017
1145
|
# "MM.dd.yyyy-'at'-HH:mm".
|
1018
1146
|
# @return [String]
|
1019
1147
|
#
|
1020
1148
|
# @!attribute [rw] timezone_offset
|
1021
1149
|
# Optional value for a timezone offset of the datetime parameter value
|
1022
|
-
# in the S3 path. Shouldn't be used if Format for this
|
1023
|
-
# includes timezone fields. If no offset specified, UTC is
|
1150
|
+
# in the Amazon S3 path. Shouldn't be used if Format for this
|
1151
|
+
# parameter includes timezone fields. If no offset specified, UTC is
|
1152
|
+
# assumed.
|
1024
1153
|
# @return [String]
|
1025
1154
|
#
|
1026
1155
|
# @!attribute [rw] locale_code
|
@@ -1238,8 +1367,8 @@ module Aws::GlueDataBrew
|
|
1238
1367
|
# @return [String]
|
1239
1368
|
#
|
1240
1369
|
# @!attribute [rw] format
|
1241
|
-
# The file format of a dataset that is created from an S3 file
|
1242
|
-
# folder.
|
1370
|
+
# The file format of a dataset that is created from an Amazon S3 file
|
1371
|
+
# or folder.
|
1243
1372
|
# @return [String]
|
1244
1373
|
#
|
1245
1374
|
# @!attribute [rw] format_options
|
@@ -1249,7 +1378,7 @@ module Aws::GlueDataBrew
|
|
1249
1378
|
#
|
1250
1379
|
# @!attribute [rw] input
|
1251
1380
|
# Represents information on how DataBrew can find data, in either the
|
1252
|
-
#
|
1381
|
+
# Glue Data Catalog or Amazon S3.
|
1253
1382
|
# @return [Types::Input]
|
1254
1383
|
#
|
1255
1384
|
# @!attribute [rw] last_modified_date
|
@@ -1262,13 +1391,13 @@ module Aws::GlueDataBrew
|
|
1262
1391
|
# @return [String]
|
1263
1392
|
#
|
1264
1393
|
# @!attribute [rw] source
|
1265
|
-
# The location of the data for this dataset, Amazon S3 or the
|
1394
|
+
# The location of the data for this dataset, Amazon S3 or the Glue
|
1266
1395
|
# Data Catalog.
|
1267
1396
|
# @return [String]
|
1268
1397
|
#
|
1269
1398
|
# @!attribute [rw] path_options
|
1270
|
-
# A set of options that defines how DataBrew interprets an S3
|
1271
|
-
# the dataset.
|
1399
|
+
# A set of options that defines how DataBrew interprets an Amazon S3
|
1400
|
+
# path of the dataset.
|
1272
1401
|
# @return [Types::PathOptions]
|
1273
1402
|
#
|
1274
1403
|
# @!attribute [rw] tags
|
@@ -1338,7 +1467,7 @@ module Aws::GlueDataBrew
|
|
1338
1467
|
# @!attribute [rw] encryption_mode
|
1339
1468
|
# The encryption mode for the job, which can be one of the following:
|
1340
1469
|
#
|
1341
|
-
# * `SSE-KMS` - Server-side encryption with keys managed by
|
1470
|
+
# * `SSE-KMS` - Server-side encryption with keys managed by KMS.
|
1342
1471
|
#
|
1343
1472
|
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
1344
1473
|
# @return [String]
|
@@ -1383,6 +1512,11 @@ module Aws::GlueDataBrew
|
|
1383
1512
|
# job.
|
1384
1513
|
# @return [Array<Types::Output>]
|
1385
1514
|
#
|
1515
|
+
# @!attribute [rw] data_catalog_outputs
|
1516
|
+
# One or more artifacts that represent the AWS Glue Data Catalog
|
1517
|
+
# output from running the job.
|
1518
|
+
# @return [Array<Types::DataCatalogOutput>]
|
1519
|
+
#
|
1386
1520
|
# @!attribute [rw] project_name
|
1387
1521
|
# The DataBrew project associated with this job.
|
1388
1522
|
# @return [String]
|
@@ -1396,7 +1530,7 @@ module Aws::GlueDataBrew
|
|
1396
1530
|
# @return [String]
|
1397
1531
|
#
|
1398
1532
|
# @!attribute [rw] role_arn
|
1399
|
-
# The ARN of the
|
1533
|
+
# The ARN of the Identity and Access Management (IAM) role to be
|
1400
1534
|
# assumed when DataBrew runs the job.
|
1401
1535
|
# @return [String]
|
1402
1536
|
#
|
@@ -1430,6 +1564,7 @@ module Aws::GlueDataBrew
|
|
1430
1564
|
:max_capacity,
|
1431
1565
|
:max_retries,
|
1432
1566
|
:outputs,
|
1567
|
+
:data_catalog_outputs,
|
1433
1568
|
:project_name,
|
1434
1569
|
:recipe_reference,
|
1435
1570
|
:resource_arn,
|
@@ -1513,6 +1648,11 @@ module Aws::GlueDataBrew
|
|
1513
1648
|
# One or more output artifacts from a job run.
|
1514
1649
|
# @return [Array<Types::Output>]
|
1515
1650
|
#
|
1651
|
+
# @!attribute [rw] data_catalog_outputs
|
1652
|
+
# One or more artifacts that represent the AWS Glue Data Catalog
|
1653
|
+
# output from running the job.
|
1654
|
+
# @return [Array<Types::DataCatalogOutput>]
|
1655
|
+
#
|
1516
1656
|
# @!attribute [rw] recipe_reference
|
1517
1657
|
# Represents the name and version of a DataBrew recipe.
|
1518
1658
|
# @return [Types::RecipeReference]
|
@@ -1547,6 +1687,7 @@ module Aws::GlueDataBrew
|
|
1547
1687
|
:log_subscription,
|
1548
1688
|
:log_group_name,
|
1549
1689
|
:outputs,
|
1690
|
+
:data_catalog_outputs,
|
1550
1691
|
:recipe_reference,
|
1551
1692
|
:started_by,
|
1552
1693
|
:started_on,
|
@@ -1613,7 +1754,7 @@ module Aws::GlueDataBrew
|
|
1613
1754
|
# @return [Types::Sample]
|
1614
1755
|
#
|
1615
1756
|
# @!attribute [rw] role_arn
|
1616
|
-
# The ARN of the
|
1757
|
+
# The ARN of the Identity and Access Management (IAM) role to be
|
1617
1758
|
# assumed when DataBrew runs the job.
|
1618
1759
|
# @return [String]
|
1619
1760
|
#
|
@@ -1810,7 +1951,7 @@ module Aws::GlueDataBrew
|
|
1810
1951
|
# @!attribute [rw] cron_expression
|
1811
1952
|
# The date or dates and time or times when the jobs are to be run for
|
1812
1953
|
# the schedule. For more information, see [Cron expressions][1] in the
|
1813
|
-
# *
|
1954
|
+
# *Glue DataBrew Developer Guide*.
|
1814
1955
|
#
|
1815
1956
|
#
|
1816
1957
|
#
|
@@ -1879,8 +2020,8 @@ module Aws::GlueDataBrew
|
|
1879
2020
|
include Aws::Structure
|
1880
2021
|
end
|
1881
2022
|
|
1882
|
-
# Represents a limit imposed on number of S3 files that should be
|
1883
|
-
# selected for a dataset from a connected S3 path.
|
2023
|
+
# Represents a limit imposed on number of Amazon S3 files that should be
|
2024
|
+
# selected for a dataset from a connected Amazon S3 path.
|
1884
2025
|
#
|
1885
2026
|
# @note When making an API call, you may pass FilesLimit
|
1886
2027
|
# data as a hash:
|
@@ -1892,19 +2033,19 @@ module Aws::GlueDataBrew
|
|
1892
2033
|
# }
|
1893
2034
|
#
|
1894
2035
|
# @!attribute [rw] max_files
|
1895
|
-
# The number of S3 files to select.
|
2036
|
+
# The number of Amazon S3 files to select.
|
1896
2037
|
# @return [Integer]
|
1897
2038
|
#
|
1898
2039
|
# @!attribute [rw] ordered_by
|
1899
|
-
# A criteria to use for S3 files sorting before their
|
1900
|
-
# default uses LAST\_MODIFIED\_DATE as a sorting
|
1901
|
-
# it's the only allowed value.
|
2040
|
+
# A criteria to use for Amazon S3 files sorting before their
|
2041
|
+
# selection. By default uses LAST\_MODIFIED\_DATE as a sorting
|
2042
|
+
# criteria. Currently it's the only allowed value.
|
1902
2043
|
# @return [String]
|
1903
2044
|
#
|
1904
2045
|
# @!attribute [rw] order
|
1905
|
-
# A criteria to use for S3 files sorting before their
|
1906
|
-
# default uses DESCENDING order, i.e. most recent files
|
1907
|
-
# first. Anotherpossible value is ASCENDING.
|
2046
|
+
# A criteria to use for Amazon S3 files sorting before their
|
2047
|
+
# selection. By default uses DESCENDING order, i.e. most recent files
|
2048
|
+
# are selected first. Anotherpossible value is ASCENDING.
|
1908
2049
|
# @return [String]
|
1909
2050
|
#
|
1910
2051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/FilesLimit AWS API Documentation
|
@@ -1917,7 +2058,13 @@ module Aws::GlueDataBrew
|
|
1917
2058
|
include Aws::Structure
|
1918
2059
|
end
|
1919
2060
|
|
1920
|
-
# Represents a structure for defining parameter conditions.
|
2061
|
+
# Represents a structure for defining parameter conditions. Supported
|
2062
|
+
# conditions are described here: [Supported conditions for dynamic
|
2063
|
+
# datasets][1] in the *Glue DataBrew Developer Guide*.
|
2064
|
+
#
|
2065
|
+
#
|
2066
|
+
#
|
2067
|
+
# [1]: https://docs-aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets
|
1921
2068
|
#
|
1922
2069
|
# @note When making an API call, you may pass FilterExpression
|
1923
2070
|
# data as a hash:
|
@@ -1996,7 +2143,7 @@ module Aws::GlueDataBrew
|
|
1996
2143
|
end
|
1997
2144
|
|
1998
2145
|
# Represents information on how DataBrew can find data, in either the
|
1999
|
-
#
|
2146
|
+
# Glue Data Catalog or Amazon S3.
|
2000
2147
|
#
|
2001
2148
|
# @note When making an API call, you may pass Input
|
2002
2149
|
# data as a hash:
|
@@ -2030,7 +2177,7 @@ module Aws::GlueDataBrew
|
|
2030
2177
|
# @return [Types::S3Location]
|
2031
2178
|
#
|
2032
2179
|
# @!attribute [rw] data_catalog_input_definition
|
2033
|
-
# The
|
2180
|
+
# The Glue Data Catalog parameters for the data.
|
2034
2181
|
# @return [Types::DataCatalogInputDefinition]
|
2035
2182
|
#
|
2036
2183
|
# @!attribute [rw] database_input_definition
|
@@ -2063,7 +2210,7 @@ module Aws::GlueDataBrew
|
|
2063
2210
|
# Represents all of the attributes of a DataBrew job.
|
2064
2211
|
#
|
2065
2212
|
# @!attribute [rw] account_id
|
2066
|
-
# The ID of the
|
2213
|
+
# The ID of the Amazon Web Services account that owns the job.
|
2067
2214
|
# @return [String]
|
2068
2215
|
#
|
2069
2216
|
# @!attribute [rw] created_by
|
@@ -2091,7 +2238,7 @@ module Aws::GlueDataBrew
|
|
2091
2238
|
# @!attribute [rw] encryption_mode
|
2092
2239
|
# The encryption mode for the job, which can be one of the following:
|
2093
2240
|
#
|
2094
|
-
# * `SSE-KMS` - Server-side encryption with keys managed by
|
2241
|
+
# * `SSE-KMS` - Server-side encryption with keys managed by KMS.
|
2095
2242
|
#
|
2096
2243
|
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
2097
2244
|
# @return [String]
|
@@ -2136,6 +2283,11 @@ module Aws::GlueDataBrew
|
|
2136
2283
|
# One or more artifacts that represent output from running the job.
|
2137
2284
|
# @return [Array<Types::Output>]
|
2138
2285
|
#
|
2286
|
+
# @!attribute [rw] data_catalog_outputs
|
2287
|
+
# One or more artifacts that represent the AWS Glue Data Catalog
|
2288
|
+
# output from running the job.
|
2289
|
+
# @return [Array<Types::DataCatalogOutput>]
|
2290
|
+
#
|
2139
2291
|
# @!attribute [rw] project_name
|
2140
2292
|
# The name of the project that the job is associated with.
|
2141
2293
|
# @return [String]
|
@@ -2187,6 +2339,7 @@ module Aws::GlueDataBrew
|
|
2187
2339
|
:max_capacity,
|
2188
2340
|
:max_retries,
|
2189
2341
|
:outputs,
|
2342
|
+
:data_catalog_outputs,
|
2190
2343
|
:project_name,
|
2191
2344
|
:recipe_reference,
|
2192
2345
|
:resource_arn,
|
@@ -2247,6 +2400,11 @@ module Aws::GlueDataBrew
|
|
2247
2400
|
# One or more output artifacts from a job run.
|
2248
2401
|
# @return [Array<Types::Output>]
|
2249
2402
|
#
|
2403
|
+
# @!attribute [rw] data_catalog_outputs
|
2404
|
+
# One or more artifacts that represent the AWS Glue Data Catalog
|
2405
|
+
# output from running the job.
|
2406
|
+
# @return [Array<Types::DataCatalogOutput>]
|
2407
|
+
#
|
2250
2408
|
# @!attribute [rw] recipe_reference
|
2251
2409
|
# The set of steps processed by the job.
|
2252
2410
|
# @return [Types::RecipeReference]
|
@@ -2282,6 +2440,7 @@ module Aws::GlueDataBrew
|
|
2282
2440
|
:log_subscription,
|
2283
2441
|
:log_group_name,
|
2284
2442
|
:outputs,
|
2443
|
+
:data_catalog_outputs,
|
2285
2444
|
:recipe_reference,
|
2286
2445
|
:started_by,
|
2287
2446
|
:started_on,
|
@@ -2332,7 +2491,7 @@ module Aws::GlueDataBrew
|
|
2332
2491
|
end
|
2333
2492
|
|
2334
2493
|
# Represents the JSON-specific options that define how input is to be
|
2335
|
-
# interpreted by
|
2494
|
+
# interpreted by Glue DataBrew.
|
2336
2495
|
#
|
2337
2496
|
# @note When making an API call, you may pass JsonOptions
|
2338
2497
|
# data as a hash:
|
@@ -2828,7 +2987,7 @@ module Aws::GlueDataBrew
|
|
2828
2987
|
end
|
2829
2988
|
|
2830
2989
|
# Represents a set of options that define how DataBrew selects files for
|
2831
|
-
# a given S3 path in a dataset.
|
2990
|
+
# a given Amazon S3 path in a dataset.
|
2832
2991
|
#
|
2833
2992
|
# @note When making an API call, you may pass PathOptions
|
2834
2993
|
# data as a hash:
|
@@ -2866,8 +3025,8 @@ module Aws::GlueDataBrew
|
|
2866
3025
|
# }
|
2867
3026
|
#
|
2868
3027
|
# @!attribute [rw] last_modified_date_condition
|
2869
|
-
# If provided, this structure defines a date range for matching
|
2870
|
-
# objects based on their LastModifiedDate attribute in S3.
|
3028
|
+
# If provided, this structure defines a date range for matching Amazon
|
3029
|
+
# S3 objects based on their LastModifiedDate attribute in Amazon S3.
|
2871
3030
|
# @return [Types::FilterExpression]
|
2872
3031
|
#
|
2873
3032
|
# @!attribute [rw] files_limit
|
@@ -2876,8 +3035,8 @@ module Aws::GlueDataBrew
|
|
2876
3035
|
# @return [Types::FilesLimit]
|
2877
3036
|
#
|
2878
3037
|
# @!attribute [rw] parameters
|
2879
|
-
# A structure that maps names of parameters used in the S3 path
|
2880
|
-
# dataset to their definitions.
|
3038
|
+
# A structure that maps names of parameters used in the Amazon S3 path
|
3039
|
+
# of a dataset to their definitions.
|
2881
3040
|
# @return [Hash<String,Types::DatasetParameter>]
|
2882
3041
|
#
|
2883
3042
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/PathOptions AWS API Documentation
|
@@ -2893,7 +3052,7 @@ module Aws::GlueDataBrew
|
|
2893
3052
|
# Represents all of the attributes of a DataBrew project.
|
2894
3053
|
#
|
2895
3054
|
# @!attribute [rw] account_id
|
2896
|
-
# The ID of the
|
3055
|
+
# The ID of the Amazon Web Services account that owns the project.
|
2897
3056
|
# @return [String]
|
2898
3057
|
#
|
2899
3058
|
# @!attribute [rw] create_date
|
@@ -3101,12 +3260,11 @@ module Aws::GlueDataBrew
|
|
3101
3260
|
|
3102
3261
|
# Represents a transformation and associated parameters that are used to
|
3103
3262
|
# apply a change to a DataBrew dataset. For more information, see
|
3104
|
-
# [Recipe
|
3263
|
+
# [Recipe actions reference][1].
|
3105
3264
|
#
|
3106
3265
|
#
|
3107
3266
|
#
|
3108
|
-
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/recipe-
|
3109
|
-
# [2]: https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html
|
3267
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html
|
3110
3268
|
#
|
3111
3269
|
# @note When making an API call, you may pass RecipeAction
|
3112
3270
|
# data as a hash:
|
@@ -3257,7 +3415,7 @@ module Aws::GlueDataBrew
|
|
3257
3415
|
# }
|
3258
3416
|
#
|
3259
3417
|
# @!attribute [rw] bucket
|
3260
|
-
# The S3 bucket name.
|
3418
|
+
# The Amazon S3 bucket name.
|
3261
3419
|
# @return [String]
|
3262
3420
|
#
|
3263
3421
|
# @!attribute [rw] key
|
@@ -3273,6 +3431,32 @@ module Aws::GlueDataBrew
|
|
3273
3431
|
include Aws::Structure
|
3274
3432
|
end
|
3275
3433
|
|
3434
|
+
# Represents options that specify how and where DataBrew writes the S3
|
3435
|
+
# output generated by recipe jobs.
|
3436
|
+
#
|
3437
|
+
# @note When making an API call, you may pass S3TableOutputOptions
|
3438
|
+
# data as a hash:
|
3439
|
+
#
|
3440
|
+
# {
|
3441
|
+
# location: { # required
|
3442
|
+
# bucket: "Bucket", # required
|
3443
|
+
# key: "Key",
|
3444
|
+
# },
|
3445
|
+
# }
|
3446
|
+
#
|
3447
|
+
# @!attribute [rw] location
|
3448
|
+
# Represents an Amazon S3 location (bucket name and object key) where
|
3449
|
+
# DataBrew can write output from a job.
|
3450
|
+
# @return [Types::S3Location]
|
3451
|
+
#
|
3452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/S3TableOutputOptions AWS API Documentation
|
3453
|
+
#
|
3454
|
+
class S3TableOutputOptions < Struct.new(
|
3455
|
+
:location)
|
3456
|
+
SENSITIVE = []
|
3457
|
+
include Aws::Structure
|
3458
|
+
end
|
3459
|
+
|
3276
3460
|
# Represents the sample size and sampling type for DataBrew to use for
|
3277
3461
|
# interactive data analysis.
|
3278
3462
|
#
|
@@ -3304,7 +3488,7 @@ module Aws::GlueDataBrew
|
|
3304
3488
|
# Represents one or more dates and times when a job is to run.
|
3305
3489
|
#
|
3306
3490
|
# @!attribute [rw] account_id
|
3307
|
-
# The ID of the
|
3491
|
+
# The ID of the Amazon Web Services account that owns the schedule.
|
3308
3492
|
# @return [String]
|
3309
3493
|
#
|
3310
3494
|
# @!attribute [rw] created_by
|
@@ -3334,8 +3518,7 @@ module Aws::GlueDataBrew
|
|
3334
3518
|
#
|
3335
3519
|
# @!attribute [rw] cron_expression
|
3336
3520
|
# The dates and times when the job is to run. For more information,
|
3337
|
-
# see [Cron expressions][1] in the *
|
3338
|
-
# Guide*.
|
3521
|
+
# see [Cron expressions][1] in the *Glue DataBrew Developer Guide*.
|
3339
3522
|
#
|
3340
3523
|
#
|
3341
3524
|
#
|
@@ -3729,8 +3912,8 @@ module Aws::GlueDataBrew
|
|
3729
3912
|
# @return [String]
|
3730
3913
|
#
|
3731
3914
|
# @!attribute [rw] format
|
3732
|
-
# The file format of a dataset that is created from an S3 file
|
3733
|
-
# folder.
|
3915
|
+
# The file format of a dataset that is created from an Amazon S3 file
|
3916
|
+
# or folder.
|
3734
3917
|
# @return [String]
|
3735
3918
|
#
|
3736
3919
|
# @!attribute [rw] format_options
|
@@ -3740,12 +3923,12 @@ module Aws::GlueDataBrew
|
|
3740
3923
|
#
|
3741
3924
|
# @!attribute [rw] input
|
3742
3925
|
# Represents information on how DataBrew can find data, in either the
|
3743
|
-
#
|
3926
|
+
# Glue Data Catalog or Amazon S3.
|
3744
3927
|
# @return [Types::Input]
|
3745
3928
|
#
|
3746
3929
|
# @!attribute [rw] path_options
|
3747
|
-
# A set of options that defines how DataBrew interprets an S3
|
3748
|
-
# the dataset.
|
3930
|
+
# A set of options that defines how DataBrew interprets an Amazon S3
|
3931
|
+
# path of the dataset.
|
3749
3932
|
# @return [Types::PathOptions]
|
3750
3933
|
#
|
3751
3934
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateDatasetRequest AWS API Documentation
|
@@ -3802,7 +3985,7 @@ module Aws::GlueDataBrew
|
|
3802
3985
|
# @!attribute [rw] encryption_mode
|
3803
3986
|
# The encryption mode for the job, which can be one of the following:
|
3804
3987
|
#
|
3805
|
-
# * `SSE-KMS` - Server-side encryption with keys managed by
|
3988
|
+
# * `SSE-KMS` - Server-side encryption with keys managed by KMS.
|
3806
3989
|
#
|
3807
3990
|
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
3808
3991
|
# @return [String]
|
@@ -3832,8 +4015,8 @@ module Aws::GlueDataBrew
|
|
3832
4015
|
# @return [Types::S3Location]
|
3833
4016
|
#
|
3834
4017
|
# @!attribute [rw] role_arn
|
3835
|
-
# The Amazon Resource Name (ARN) of the
|
3836
|
-
#
|
4018
|
+
# The Amazon Resource Name (ARN) of the Identity and Access Management
|
4019
|
+
# (IAM) role to be assumed when DataBrew runs the job.
|
3837
4020
|
# @return [String]
|
3838
4021
|
#
|
3839
4022
|
# @!attribute [rw] timeout
|
@@ -3941,7 +4124,7 @@ module Aws::GlueDataBrew
|
|
3941
4124
|
# log_subscription: "ENABLE", # accepts ENABLE, DISABLE
|
3942
4125
|
# max_capacity: 1,
|
3943
4126
|
# max_retries: 1,
|
3944
|
-
# outputs: [
|
4127
|
+
# outputs: [
|
3945
4128
|
# {
|
3946
4129
|
# compression_format: "GZIP", # accepts GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB
|
3947
4130
|
# format: "CSV", # accepts CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML
|
@@ -3958,6 +4141,27 @@ module Aws::GlueDataBrew
|
|
3958
4141
|
# },
|
3959
4142
|
# },
|
3960
4143
|
# ],
|
4144
|
+
# data_catalog_outputs: [
|
4145
|
+
# {
|
4146
|
+
# catalog_id: "CatalogId",
|
4147
|
+
# database_name: "DatabaseName", # required
|
4148
|
+
# table_name: "TableName", # required
|
4149
|
+
# s3_options: {
|
4150
|
+
# location: { # required
|
4151
|
+
# bucket: "Bucket", # required
|
4152
|
+
# key: "Key",
|
4153
|
+
# },
|
4154
|
+
# },
|
4155
|
+
# database_options: {
|
4156
|
+
# temp_directory: {
|
4157
|
+
# bucket: "Bucket", # required
|
4158
|
+
# key: "Key",
|
4159
|
+
# },
|
4160
|
+
# table_name: "DatabaseTableName", # required
|
4161
|
+
# },
|
4162
|
+
# overwrite: false,
|
4163
|
+
# },
|
4164
|
+
# ],
|
3961
4165
|
# role_arn: "Arn", # required
|
3962
4166
|
# timeout: 1,
|
3963
4167
|
# }
|
@@ -3970,7 +4174,7 @@ module Aws::GlueDataBrew
|
|
3970
4174
|
# @!attribute [rw] encryption_mode
|
3971
4175
|
# The encryption mode for the job, which can be one of the following:
|
3972
4176
|
#
|
3973
|
-
# * `SSE-KMS` - Server-side encryption with keys managed by
|
4177
|
+
# * `SSE-KMS` - Server-side encryption with keys managed by KMS.
|
3974
4178
|
#
|
3975
4179
|
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
3976
4180
|
# @return [String]
|
@@ -3999,9 +4203,14 @@ module Aws::GlueDataBrew
|
|
3999
4203
|
# job.
|
4000
4204
|
# @return [Array<Types::Output>]
|
4001
4205
|
#
|
4206
|
+
# @!attribute [rw] data_catalog_outputs
|
4207
|
+
# One or more artifacts that represent the AWS Glue Data Catalog
|
4208
|
+
# output from running the job.
|
4209
|
+
# @return [Array<Types::DataCatalogOutput>]
|
4210
|
+
#
|
4002
4211
|
# @!attribute [rw] role_arn
|
4003
|
-
# The Amazon Resource Name (ARN) of the
|
4004
|
-
#
|
4212
|
+
# The Amazon Resource Name (ARN) of the Identity and Access Management
|
4213
|
+
# (IAM) role to be assumed when DataBrew runs the job.
|
4005
4214
|
# @return [String]
|
4006
4215
|
#
|
4007
4216
|
# @!attribute [rw] timeout
|
@@ -4019,6 +4228,7 @@ module Aws::GlueDataBrew
|
|
4019
4228
|
:max_capacity,
|
4020
4229
|
:max_retries,
|
4021
4230
|
:outputs,
|
4231
|
+
:data_catalog_outputs,
|
4022
4232
|
:role_arn,
|
4023
4233
|
:timeout)
|
4024
4234
|
SENSITIVE = []
|
@@ -4113,8 +4323,8 @@ module Aws::GlueDataBrew
|
|
4113
4323
|
#
|
4114
4324
|
# @!attribute [rw] cron_expression
|
4115
4325
|
# The date or dates and time or times when the jobs are to be run. For
|
4116
|
-
# more information, see [Cron expressions][1] in the *
|
4117
|
-
#
|
4326
|
+
# more information, see [Cron expressions][1] in the *Glue DataBrew
|
4327
|
+
# Developer Guide*.
|
4118
4328
|
#
|
4119
4329
|
#
|
4120
4330
|
#
|