aws-sdk-gluedatabrew 1.0.0 → 1.5.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 +299 -134
- data/lib/aws-sdk-gluedatabrew/client_api.rb +94 -0
- data/lib/aws-sdk-gluedatabrew/types.rb +557 -172
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 511e98419a5208c4a5b26a5e8a15e3003616ef9d397d8e0020bfcf5c068c8819
|
4
|
+
data.tar.gz: 56225935d6dc9549438a0c876867411ef4282613567ea919b1f94e0a0254ea6d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 82c04d5d87a729404100300ce95b6daee496ae8409cbf47bb1e389c2e6f4603ce4a923b1a75655b08e847334efe316ba981ba4f55171c92c893a2f83747a42b0
|
7
|
+
data.tar.gz: 18e03cf8ed7061bf6284049d868374b4bf9c9a0257f57fbf4f6a368be11b2b8ec9229e6124565714921b72c2d913e38a74a8309b60fed1f990aef96ef8136204
|
data/lib/aws-sdk-gluedatabrew.rb
CHANGED
@@ -329,11 +329,40 @@ module Aws::GlueDataBrew
|
|
329
329
|
|
330
330
|
# Deletes one or more versions of a recipe at a time.
|
331
331
|
#
|
332
|
+
# The entire request will be rejected if:
|
333
|
+
#
|
334
|
+
# * The recipe does not exist.
|
335
|
+
#
|
336
|
+
# * There is an invalid version identifier in the list of versions.
|
337
|
+
#
|
338
|
+
# * The version list is empty.
|
339
|
+
#
|
340
|
+
# * The version list size exceeds 50.
|
341
|
+
#
|
342
|
+
# * The version list contains duplicate entries.
|
343
|
+
#
|
344
|
+
# The request will complete successfully, but with partial failures, if:
|
345
|
+
#
|
346
|
+
# * A version does not exist.
|
347
|
+
#
|
348
|
+
# * A version is being used by a job.
|
349
|
+
#
|
350
|
+
# * You specify `LATEST_WORKING`, but it's being used by a project.
|
351
|
+
#
|
352
|
+
# * The version fails to be deleted.
|
353
|
+
#
|
354
|
+
# The `LATEST_WORKING` version will only be deleted if the recipe has no
|
355
|
+
# other versions. If you try to delete `LATEST_WORKING` while other
|
356
|
+
# versions exist (or if they can't be deleted), then `LATEST_WORKING`
|
357
|
+
# will be listed as partial failure in the response.
|
358
|
+
#
|
332
359
|
# @option params [required, String] :name
|
333
|
-
# The name of the recipe to be
|
360
|
+
# The name of the recipe whose versions are to be deleted.
|
334
361
|
#
|
335
362
|
# @option params [required, Array<String>] :recipe_versions
|
336
|
-
# An array of version identifiers to be
|
363
|
+
# An array of version identifiers, for the recipe versions to be
|
364
|
+
# deleted. You can specify numeric versions (`X.Y`) or `LATEST_WORKING`.
|
365
|
+
# `LATEST_PUBLISHED` is not supported.
|
337
366
|
#
|
338
367
|
# @return [Types::BatchDeleteRecipeVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
339
368
|
#
|
@@ -364,18 +393,22 @@ module Aws::GlueDataBrew
|
|
364
393
|
req.send_request(options)
|
365
394
|
end
|
366
395
|
|
367
|
-
# Creates a new
|
396
|
+
# Creates a new DataBrew dataset.
|
368
397
|
#
|
369
398
|
# @option params [required, String] :name
|
370
|
-
# The name of the dataset to be created.
|
399
|
+
# The name of the dataset to be created. Valid characters are
|
400
|
+
# alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
|
401
|
+
#
|
402
|
+
# @option params [String] :format
|
403
|
+
# Specifies the file format of a dataset created from an S3 file or
|
404
|
+
# folder.
|
371
405
|
#
|
372
406
|
# @option params [Types::FormatOptions] :format_options
|
373
|
-
# Options that define
|
374
|
-
# DataBrew.
|
407
|
+
# Options that define the structure of either Csv, Excel, or JSON input.
|
375
408
|
#
|
376
409
|
# @option params [required, Types::Input] :input
|
377
|
-
# Information on how
|
378
|
-
#
|
410
|
+
# Information on how DataBrew can find data, in either the AWS Glue Data
|
411
|
+
# Catalog or Amazon S3.
|
379
412
|
#
|
380
413
|
# @option params [Hash<String,String>] :tags
|
381
414
|
# Metadata tags to apply to this dataset.
|
@@ -388,6 +421,7 @@ module Aws::GlueDataBrew
|
|
388
421
|
#
|
389
422
|
# resp = client.create_dataset({
|
390
423
|
# name: "DatasetName", # required
|
424
|
+
# format: "CSV", # accepts CSV, JSON, PARQUET, EXCEL
|
391
425
|
# format_options: {
|
392
426
|
# json: {
|
393
427
|
# multi_line: false,
|
@@ -395,6 +429,11 @@ module Aws::GlueDataBrew
|
|
395
429
|
# excel: {
|
396
430
|
# sheet_names: ["SheetName"],
|
397
431
|
# sheet_indexes: [1],
|
432
|
+
# header_row: false,
|
433
|
+
# },
|
434
|
+
# csv: {
|
435
|
+
# delimiter: "Delimiter",
|
436
|
+
# header_row: false,
|
398
437
|
# },
|
399
438
|
# },
|
400
439
|
# input: { # required
|
@@ -430,8 +469,7 @@ module Aws::GlueDataBrew
|
|
430
469
|
req.send_request(options)
|
431
470
|
end
|
432
471
|
|
433
|
-
# Creates a new job to
|
434
|
-
# in the current AWS account.
|
472
|
+
# Creates a new job to analyze a dataset and create its data profile.
|
435
473
|
#
|
436
474
|
# @option params [required, String] :dataset_name
|
437
475
|
# The name of the dataset that this job is to act upon.
|
@@ -443,18 +481,18 @@ module Aws::GlueDataBrew
|
|
443
481
|
# @option params [String] :encryption_mode
|
444
482
|
# The encryption mode for the job, which can be one of the following:
|
445
483
|
#
|
446
|
-
# * `SSE-KMS` -
|
447
|
-
#
|
484
|
+
# * `SSE-KMS` - `SSE-KMS` - Server-side encryption with AWS KMS-managed
|
485
|
+
# keys.
|
448
486
|
#
|
449
487
|
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
450
488
|
#
|
451
489
|
# @option params [required, String] :name
|
452
|
-
# The name of the job to be created.
|
490
|
+
# The name of the job to be created. Valid characters are alphanumeric
|
491
|
+
# (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
|
453
492
|
#
|
454
493
|
# @option params [String] :log_subscription
|
455
|
-
#
|
456
|
-
#
|
457
|
-
# stream for each job run.
|
494
|
+
# Enables or disables Amazon CloudWatch logging for the job. If logging
|
495
|
+
# is enabled, CloudWatch writes one log stream for each job run.
|
458
496
|
#
|
459
497
|
# @option params [Integer] :max_capacity
|
460
498
|
# The maximum number of nodes that DataBrew can use when the job
|
@@ -469,7 +507,7 @@ module Aws::GlueDataBrew
|
|
469
507
|
#
|
470
508
|
# @option params [required, String] :role_arn
|
471
509
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
472
|
-
# Management (IAM) role to be assumed
|
510
|
+
# Management (IAM) role to be assumed when DataBrew runs the job.
|
473
511
|
#
|
474
512
|
# @option params [Hash<String,String>] :tags
|
475
513
|
# Metadata tags to apply to this job.
|
@@ -478,6 +516,12 @@ module Aws::GlueDataBrew
|
|
478
516
|
# The job's timeout in minutes. A job that attempts to run longer than
|
479
517
|
# this timeout period ends with a status of `TIMEOUT`.
|
480
518
|
#
|
519
|
+
# @option params [Types::JobSample] :job_sample
|
520
|
+
# Sample configuration for profile jobs only. Determines the number of
|
521
|
+
# rows on which the profile job will be executed. If a JobSample value
|
522
|
+
# is not provided, the default value will be used. The default value is
|
523
|
+
# CUSTOM\_ROWS for the mode parameter and 20000 for the size parameter.
|
524
|
+
#
|
481
525
|
# @return [Types::CreateProfileJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
482
526
|
#
|
483
527
|
# * {Types::CreateProfileJobResponse#name #name} => String
|
@@ -501,6 +545,10 @@ module Aws::GlueDataBrew
|
|
501
545
|
# "TagKey" => "TagValue",
|
502
546
|
# },
|
503
547
|
# timeout: 1,
|
548
|
+
# job_sample: {
|
549
|
+
# mode: "FULL_DATASET", # accepts FULL_DATASET, CUSTOM_ROWS
|
550
|
+
# size: 1,
|
551
|
+
# },
|
504
552
|
# })
|
505
553
|
#
|
506
554
|
# @example Response structure
|
@@ -516,20 +564,21 @@ module Aws::GlueDataBrew
|
|
516
564
|
req.send_request(options)
|
517
565
|
end
|
518
566
|
|
519
|
-
# Creates a new
|
567
|
+
# Creates a new DataBrew project.
|
520
568
|
#
|
521
569
|
# @option params [required, String] :dataset_name
|
522
|
-
# The name of
|
570
|
+
# The name of an existing dataset to associate this project with.
|
523
571
|
#
|
524
572
|
# @option params [required, String] :name
|
525
|
-
# A unique name for the new project.
|
573
|
+
# A unique name for the new project. Valid characters are alphanumeric
|
574
|
+
# (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
|
526
575
|
#
|
527
576
|
# @option params [required, String] :recipe_name
|
528
577
|
# The name of an existing recipe to associate with the project.
|
529
578
|
#
|
530
579
|
# @option params [Types::Sample] :sample
|
531
|
-
# Represents the sample size and sampling type for
|
532
|
-
#
|
580
|
+
# Represents the sample size and sampling type for DataBrew to use for
|
581
|
+
# interactive data analysis.
|
533
582
|
#
|
534
583
|
# @option params [required, String] :role_arn
|
535
584
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
@@ -571,13 +620,14 @@ module Aws::GlueDataBrew
|
|
571
620
|
req.send_request(options)
|
572
621
|
end
|
573
622
|
|
574
|
-
# Creates a new
|
623
|
+
# Creates a new DataBrew recipe.
|
575
624
|
#
|
576
625
|
# @option params [String] :description
|
577
626
|
# A description for the recipe.
|
578
627
|
#
|
579
628
|
# @option params [required, String] :name
|
580
|
-
# A unique name for the recipe.
|
629
|
+
# A unique name for the recipe. Valid characters are alphanumeric (A-Z,
|
630
|
+
# a-z, 0-9), hyphen (-), period (.), and space.
|
581
631
|
#
|
582
632
|
# @option params [required, Array<Types::RecipeStep>] :steps
|
583
633
|
# An array containing the steps to be performed by the recipe. Each
|
@@ -631,9 +681,8 @@ module Aws::GlueDataBrew
|
|
631
681
|
req.send_request(options)
|
632
682
|
end
|
633
683
|
|
634
|
-
# Creates a new job
|
635
|
-
#
|
636
|
-
# project, or a combination of a recipe and a dataset.
|
684
|
+
# Creates a new job to transform input data, using steps defined in an
|
685
|
+
# existing AWS Glue DataBrew recipe
|
637
686
|
#
|
638
687
|
# @option params [String] :dataset_name
|
639
688
|
# The name of the dataset that this job processes.
|
@@ -645,17 +694,17 @@ module Aws::GlueDataBrew
|
|
645
694
|
# @option params [String] :encryption_mode
|
646
695
|
# The encryption mode for the job, which can be one of the following:
|
647
696
|
#
|
648
|
-
# * `SSE-KMS` - Server-side encryption with AWS KMS
|
697
|
+
# * `SSE-KMS` - Server-side encryption with keys managed by AWS KMS.
|
649
698
|
#
|
650
699
|
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
651
700
|
#
|
652
701
|
# @option params [required, String] :name
|
653
|
-
# A unique name for the job.
|
702
|
+
# A unique name for the job. Valid characters are alphanumeric (A-Z,
|
703
|
+
# a-z, 0-9), hyphen (-), period (.), and space.
|
654
704
|
#
|
655
705
|
# @option params [String] :log_subscription
|
656
|
-
#
|
657
|
-
#
|
658
|
-
# stream for each job run.
|
706
|
+
# Enables or disables Amazon CloudWatch logging for the job. If logging
|
707
|
+
# is enabled, CloudWatch writes one log stream for each job run.
|
659
708
|
#
|
660
709
|
# @option params [Integer] :max_capacity
|
661
710
|
# The maximum number of nodes that DataBrew can consume when the job
|
@@ -672,14 +721,14 @@ module Aws::GlueDataBrew
|
|
672
721
|
# and a dataset to associate with the recipe.
|
673
722
|
#
|
674
723
|
# @option params [Types::RecipeReference] :recipe_reference
|
675
|
-
# Represents
|
724
|
+
# Represents the name and version of a DataBrew recipe.
|
676
725
|
#
|
677
726
|
# @option params [required, String] :role_arn
|
678
727
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
679
|
-
# Management (IAM) role to be assumed
|
728
|
+
# Management (IAM) role to be assumed when DataBrew runs the job.
|
680
729
|
#
|
681
730
|
# @option params [Hash<String,String>] :tags
|
682
|
-
# Metadata tags to apply to this job
|
731
|
+
# Metadata tags to apply to this job.
|
683
732
|
#
|
684
733
|
# @option params [Integer] :timeout
|
685
734
|
# The job's timeout in minutes. A job that attempts to run longer than
|
@@ -709,6 +758,11 @@ module Aws::GlueDataBrew
|
|
709
758
|
# key: "Key",
|
710
759
|
# },
|
711
760
|
# overwrite: false,
|
761
|
+
# format_options: {
|
762
|
+
# csv: {
|
763
|
+
# delimiter: "Delimiter",
|
764
|
+
# },
|
765
|
+
# },
|
712
766
|
# },
|
713
767
|
# ],
|
714
768
|
# project_name: "ProjectName",
|
@@ -736,21 +790,27 @@ module Aws::GlueDataBrew
|
|
736
790
|
req.send_request(options)
|
737
791
|
end
|
738
792
|
|
739
|
-
# Creates a new schedule for one or more
|
740
|
-
#
|
793
|
+
# Creates a new schedule for one or more DataBrew jobs. Jobs can be run
|
794
|
+
# at a specific date and time, or at regular intervals.
|
741
795
|
#
|
742
796
|
# @option params [Array<String>] :job_names
|
743
797
|
# The name or names of one or more jobs to be run.
|
744
798
|
#
|
745
799
|
# @option params [required, String] :cron_expression
|
746
|
-
# The date or dates and time or times
|
747
|
-
#
|
800
|
+
# The date or dates and time or times when the jobs are to be run. For
|
801
|
+
# more information, see [Cron expressions][1] in the *AWS Glue DataBrew
|
802
|
+
# Developer Guide*.
|
803
|
+
#
|
804
|
+
#
|
805
|
+
#
|
806
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html
|
748
807
|
#
|
749
808
|
# @option params [Hash<String,String>] :tags
|
750
809
|
# Metadata tags to apply to this schedule.
|
751
810
|
#
|
752
811
|
# @option params [required, String] :name
|
753
|
-
# A unique name for the schedule.
|
812
|
+
# A unique name for the schedule. Valid characters are alphanumeric
|
813
|
+
# (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
|
754
814
|
#
|
755
815
|
# @return [Types::CreateScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
756
816
|
#
|
@@ -780,7 +840,7 @@ module Aws::GlueDataBrew
|
|
780
840
|
req.send_request(options)
|
781
841
|
end
|
782
842
|
|
783
|
-
# Deletes a dataset from
|
843
|
+
# Deletes a dataset from DataBrew.
|
784
844
|
#
|
785
845
|
# @option params [required, String] :name
|
786
846
|
# The name of the dataset to be deleted.
|
@@ -808,8 +868,7 @@ module Aws::GlueDataBrew
|
|
808
868
|
req.send_request(options)
|
809
869
|
end
|
810
870
|
|
811
|
-
# Deletes the specified
|
812
|
-
# account. The job can be for a recipe or for a profile.
|
871
|
+
# Deletes the specified DataBrew job.
|
813
872
|
#
|
814
873
|
# @option params [required, String] :name
|
815
874
|
# The name of the job to be deleted.
|
@@ -837,8 +896,7 @@ module Aws::GlueDataBrew
|
|
837
896
|
req.send_request(options)
|
838
897
|
end
|
839
898
|
|
840
|
-
# Deletes an existing
|
841
|
-
# account.
|
899
|
+
# Deletes an existing DataBrew project.
|
842
900
|
#
|
843
901
|
# @option params [required, String] :name
|
844
902
|
# The name of the project to be deleted.
|
@@ -866,13 +924,15 @@ module Aws::GlueDataBrew
|
|
866
924
|
req.send_request(options)
|
867
925
|
end
|
868
926
|
|
869
|
-
# Deletes a single version of
|
927
|
+
# Deletes a single version of a DataBrew recipe.
|
870
928
|
#
|
871
929
|
# @option params [required, String] :name
|
872
|
-
# The name of the recipe
|
930
|
+
# The name of the recipe.
|
873
931
|
#
|
874
932
|
# @option params [required, String] :recipe_version
|
875
|
-
# The version of the recipe to be deleted.
|
933
|
+
# The version of the recipe to be deleted. You can specify a numeric
|
934
|
+
# versions (`X.Y`) or `LATEST_WORKING`. `LATEST_PUBLISHED` is not
|
935
|
+
# supported.
|
876
936
|
#
|
877
937
|
# @return [Types::DeleteRecipeVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
878
938
|
#
|
@@ -900,8 +960,7 @@ module Aws::GlueDataBrew
|
|
900
960
|
req.send_request(options)
|
901
961
|
end
|
902
962
|
|
903
|
-
# Deletes the specified
|
904
|
-
# account.
|
963
|
+
# Deletes the specified DataBrew schedule.
|
905
964
|
#
|
906
965
|
# @option params [required, String] :name
|
907
966
|
# The name of the schedule to be deleted.
|
@@ -929,8 +988,7 @@ module Aws::GlueDataBrew
|
|
929
988
|
req.send_request(options)
|
930
989
|
end
|
931
990
|
|
932
|
-
# Returns the definition of a specific
|
933
|
-
# in the current AWS account.
|
991
|
+
# Returns the definition of a specific DataBrew dataset.
|
934
992
|
#
|
935
993
|
# @option params [required, String] :name
|
936
994
|
# The name of the dataset to be described.
|
@@ -940,6 +998,7 @@ module Aws::GlueDataBrew
|
|
940
998
|
# * {Types::DescribeDatasetResponse#created_by #created_by} => String
|
941
999
|
# * {Types::DescribeDatasetResponse#create_date #create_date} => Time
|
942
1000
|
# * {Types::DescribeDatasetResponse#name #name} => String
|
1001
|
+
# * {Types::DescribeDatasetResponse#format #format} => String
|
943
1002
|
# * {Types::DescribeDatasetResponse#format_options #format_options} => Types::FormatOptions
|
944
1003
|
# * {Types::DescribeDatasetResponse#input #input} => Types::Input
|
945
1004
|
# * {Types::DescribeDatasetResponse#last_modified_date #last_modified_date} => Time
|
@@ -959,11 +1018,15 @@ module Aws::GlueDataBrew
|
|
959
1018
|
# resp.created_by #=> String
|
960
1019
|
# resp.create_date #=> Time
|
961
1020
|
# resp.name #=> String
|
1021
|
+
# resp.format #=> String, one of "CSV", "JSON", "PARQUET", "EXCEL"
|
962
1022
|
# resp.format_options.json.multi_line #=> Boolean
|
963
1023
|
# resp.format_options.excel.sheet_names #=> Array
|
964
1024
|
# resp.format_options.excel.sheet_names[0] #=> String
|
965
1025
|
# resp.format_options.excel.sheet_indexes #=> Array
|
966
1026
|
# resp.format_options.excel.sheet_indexes[0] #=> Integer
|
1027
|
+
# resp.format_options.excel.header_row #=> Boolean
|
1028
|
+
# resp.format_options.csv.delimiter #=> String
|
1029
|
+
# resp.format_options.csv.header_row #=> Boolean
|
967
1030
|
# resp.input.s3_input_definition.bucket #=> String
|
968
1031
|
# resp.input.s3_input_definition.key #=> String
|
969
1032
|
# resp.input.data_catalog_input_definition.catalog_id #=> String
|
@@ -987,8 +1050,7 @@ module Aws::GlueDataBrew
|
|
987
1050
|
req.send_request(options)
|
988
1051
|
end
|
989
1052
|
|
990
|
-
# Returns the definition of a specific
|
991
|
-
# the current AWS account.
|
1053
|
+
# Returns the definition of a specific DataBrew job.
|
992
1054
|
#
|
993
1055
|
# @option params [required, String] :name
|
994
1056
|
# The name of the job to be described.
|
@@ -1014,6 +1076,7 @@ module Aws::GlueDataBrew
|
|
1014
1076
|
# * {Types::DescribeJobResponse#role_arn #role_arn} => String
|
1015
1077
|
# * {Types::DescribeJobResponse#tags #tags} => Hash<String,String>
|
1016
1078
|
# * {Types::DescribeJobResponse#timeout #timeout} => Integer
|
1079
|
+
# * {Types::DescribeJobResponse#job_sample #job_sample} => Types::JobSample
|
1017
1080
|
#
|
1018
1081
|
# @example Request syntax with placeholder values
|
1019
1082
|
#
|
@@ -1043,6 +1106,7 @@ module Aws::GlueDataBrew
|
|
1043
1106
|
# resp.outputs[0].location.bucket #=> String
|
1044
1107
|
# resp.outputs[0].location.key #=> String
|
1045
1108
|
# resp.outputs[0].overwrite #=> Boolean
|
1109
|
+
# resp.outputs[0].format_options.csv.delimiter #=> String
|
1046
1110
|
# resp.project_name #=> String
|
1047
1111
|
# resp.recipe_reference.name #=> String
|
1048
1112
|
# resp.recipe_reference.recipe_version #=> String
|
@@ -1051,6 +1115,8 @@ module Aws::GlueDataBrew
|
|
1051
1115
|
# resp.tags #=> Hash
|
1052
1116
|
# resp.tags["TagKey"] #=> String
|
1053
1117
|
# resp.timeout #=> Integer
|
1118
|
+
# resp.job_sample.mode #=> String, one of "FULL_DATASET", "CUSTOM_ROWS"
|
1119
|
+
# resp.job_sample.size #=> Integer
|
1054
1120
|
#
|
1055
1121
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeJob AWS API Documentation
|
1056
1122
|
#
|
@@ -1061,8 +1127,77 @@ module Aws::GlueDataBrew
|
|
1061
1127
|
req.send_request(options)
|
1062
1128
|
end
|
1063
1129
|
|
1064
|
-
#
|
1065
|
-
#
|
1130
|
+
# Represents one run of a DataBrew job.
|
1131
|
+
#
|
1132
|
+
# @option params [required, String] :name
|
1133
|
+
# The name of the job being processed during this run.
|
1134
|
+
#
|
1135
|
+
# @option params [required, String] :run_id
|
1136
|
+
# The unique identifier of the job run.
|
1137
|
+
#
|
1138
|
+
# @return [Types::DescribeJobRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1139
|
+
#
|
1140
|
+
# * {Types::DescribeJobRunResponse#attempt #attempt} => Integer
|
1141
|
+
# * {Types::DescribeJobRunResponse#completed_on #completed_on} => Time
|
1142
|
+
# * {Types::DescribeJobRunResponse#dataset_name #dataset_name} => String
|
1143
|
+
# * {Types::DescribeJobRunResponse#error_message #error_message} => String
|
1144
|
+
# * {Types::DescribeJobRunResponse#execution_time #execution_time} => Integer
|
1145
|
+
# * {Types::DescribeJobRunResponse#job_name #job_name} => String
|
1146
|
+
# * {Types::DescribeJobRunResponse#run_id #run_id} => String
|
1147
|
+
# * {Types::DescribeJobRunResponse#state #state} => String
|
1148
|
+
# * {Types::DescribeJobRunResponse#log_subscription #log_subscription} => String
|
1149
|
+
# * {Types::DescribeJobRunResponse#log_group_name #log_group_name} => String
|
1150
|
+
# * {Types::DescribeJobRunResponse#outputs #outputs} => Array<Types::Output>
|
1151
|
+
# * {Types::DescribeJobRunResponse#recipe_reference #recipe_reference} => Types::RecipeReference
|
1152
|
+
# * {Types::DescribeJobRunResponse#started_by #started_by} => String
|
1153
|
+
# * {Types::DescribeJobRunResponse#started_on #started_on} => Time
|
1154
|
+
# * {Types::DescribeJobRunResponse#job_sample #job_sample} => Types::JobSample
|
1155
|
+
#
|
1156
|
+
# @example Request syntax with placeholder values
|
1157
|
+
#
|
1158
|
+
# resp = client.describe_job_run({
|
1159
|
+
# name: "JobName", # required
|
1160
|
+
# run_id: "JobRunId", # required
|
1161
|
+
# })
|
1162
|
+
#
|
1163
|
+
# @example Response structure
|
1164
|
+
#
|
1165
|
+
# resp.attempt #=> Integer
|
1166
|
+
# resp.completed_on #=> Time
|
1167
|
+
# resp.dataset_name #=> String
|
1168
|
+
# resp.error_message #=> String
|
1169
|
+
# resp.execution_time #=> Integer
|
1170
|
+
# resp.job_name #=> String
|
1171
|
+
# resp.run_id #=> String
|
1172
|
+
# resp.state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED", "TIMEOUT"
|
1173
|
+
# resp.log_subscription #=> String, one of "ENABLE", "DISABLE"
|
1174
|
+
# resp.log_group_name #=> String
|
1175
|
+
# resp.outputs #=> Array
|
1176
|
+
# resp.outputs[0].compression_format #=> String, one of "GZIP", "LZ4", "SNAPPY", "BZIP2", "DEFLATE", "LZO", "BROTLI", "ZSTD", "ZLIB"
|
1177
|
+
# resp.outputs[0].format #=> String, one of "CSV", "JSON", "PARQUET", "GLUEPARQUET", "AVRO", "ORC", "XML"
|
1178
|
+
# resp.outputs[0].partition_columns #=> Array
|
1179
|
+
# resp.outputs[0].partition_columns[0] #=> String
|
1180
|
+
# resp.outputs[0].location.bucket #=> String
|
1181
|
+
# resp.outputs[0].location.key #=> String
|
1182
|
+
# resp.outputs[0].overwrite #=> Boolean
|
1183
|
+
# resp.outputs[0].format_options.csv.delimiter #=> String
|
1184
|
+
# resp.recipe_reference.name #=> String
|
1185
|
+
# resp.recipe_reference.recipe_version #=> String
|
1186
|
+
# resp.started_by #=> String
|
1187
|
+
# resp.started_on #=> Time
|
1188
|
+
# resp.job_sample.mode #=> String, one of "FULL_DATASET", "CUSTOM_ROWS"
|
1189
|
+
# resp.job_sample.size #=> Integer
|
1190
|
+
#
|
1191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeJobRun AWS API Documentation
|
1192
|
+
#
|
1193
|
+
# @overload describe_job_run(params = {})
|
1194
|
+
# @param [Hash] params ({})
|
1195
|
+
def describe_job_run(params = {}, options = {})
|
1196
|
+
req = build_request(:describe_job_run, params)
|
1197
|
+
req.send_request(options)
|
1198
|
+
end
|
1199
|
+
|
1200
|
+
# Returns the definition of a specific DataBrew project.
|
1066
1201
|
#
|
1067
1202
|
# @option params [required, String] :name
|
1068
1203
|
# The name of the project to be described.
|
@@ -1118,8 +1253,8 @@ module Aws::GlueDataBrew
|
|
1118
1253
|
req.send_request(options)
|
1119
1254
|
end
|
1120
1255
|
|
1121
|
-
# Returns the definition of a specific
|
1122
|
-
#
|
1256
|
+
# Returns the definition of a specific DataBrew recipe corresponding to
|
1257
|
+
# a particular version.
|
1123
1258
|
#
|
1124
1259
|
# @option params [required, String] :name
|
1125
1260
|
# The name of the recipe to be described.
|
@@ -1184,8 +1319,7 @@ module Aws::GlueDataBrew
|
|
1184
1319
|
req.send_request(options)
|
1185
1320
|
end
|
1186
1321
|
|
1187
|
-
# Returns the definition of a specific
|
1188
|
-
# is in the current AWS account.
|
1322
|
+
# Returns the definition of a specific DataBrew schedule.
|
1189
1323
|
#
|
1190
1324
|
# @option params [required, String] :name
|
1191
1325
|
# The name of the schedule to be described.
|
@@ -1231,17 +1365,14 @@ module Aws::GlueDataBrew
|
|
1231
1365
|
req.send_request(options)
|
1232
1366
|
end
|
1233
1367
|
|
1234
|
-
# Lists all of the
|
1235
|
-
# account.
|
1368
|
+
# Lists all of the DataBrew datasets.
|
1236
1369
|
#
|
1237
1370
|
# @option params [Integer] :max_results
|
1238
1371
|
# The maximum number of results to return in this request.
|
1239
1372
|
#
|
1240
1373
|
# @option params [String] :next_token
|
1241
|
-
#
|
1242
|
-
#
|
1243
|
-
# pages, pass in the NextToken value from the response object of the
|
1244
|
-
# previous page call.
|
1374
|
+
# The token returned by a previous call to retrieve the next set of
|
1375
|
+
# results.
|
1245
1376
|
#
|
1246
1377
|
# @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1247
1378
|
#
|
@@ -1264,11 +1395,15 @@ module Aws::GlueDataBrew
|
|
1264
1395
|
# resp.datasets[0].created_by #=> String
|
1265
1396
|
# resp.datasets[0].create_date #=> Time
|
1266
1397
|
# resp.datasets[0].name #=> String
|
1398
|
+
# resp.datasets[0].format #=> String, one of "CSV", "JSON", "PARQUET", "EXCEL"
|
1267
1399
|
# resp.datasets[0].format_options.json.multi_line #=> Boolean
|
1268
1400
|
# resp.datasets[0].format_options.excel.sheet_names #=> Array
|
1269
1401
|
# resp.datasets[0].format_options.excel.sheet_names[0] #=> String
|
1270
1402
|
# resp.datasets[0].format_options.excel.sheet_indexes #=> Array
|
1271
1403
|
# resp.datasets[0].format_options.excel.sheet_indexes[0] #=> Integer
|
1404
|
+
# resp.datasets[0].format_options.excel.header_row #=> Boolean
|
1405
|
+
# resp.datasets[0].format_options.csv.delimiter #=> String
|
1406
|
+
# resp.datasets[0].format_options.csv.header_row #=> Boolean
|
1272
1407
|
# resp.datasets[0].input.s3_input_definition.bucket #=> String
|
1273
1408
|
# resp.datasets[0].input.s3_input_definition.key #=> String
|
1274
1409
|
# resp.datasets[0].input.data_catalog_input_definition.catalog_id #=> String
|
@@ -1293,8 +1428,7 @@ module Aws::GlueDataBrew
|
|
1293
1428
|
req.send_request(options)
|
1294
1429
|
end
|
1295
1430
|
|
1296
|
-
# Lists all of the previous runs of a particular
|
1297
|
-
# in the current AWS account.
|
1431
|
+
# Lists all of the previous runs of a particular DataBrew job.
|
1298
1432
|
#
|
1299
1433
|
# @option params [required, String] :name
|
1300
1434
|
# The name of the job.
|
@@ -1303,10 +1437,8 @@ module Aws::GlueDataBrew
|
|
1303
1437
|
# The maximum number of results to return in this request.
|
1304
1438
|
#
|
1305
1439
|
# @option params [String] :next_token
|
1306
|
-
#
|
1307
|
-
#
|
1308
|
-
# next set of pages, pass in the NextToken value from the response
|
1309
|
-
# object of the previous page call.
|
1440
|
+
# The token returned by a previous call to retrieve the next set of
|
1441
|
+
# results.
|
1310
1442
|
#
|
1311
1443
|
# @return [Types::ListJobRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1312
1444
|
#
|
@@ -1344,10 +1476,13 @@ module Aws::GlueDataBrew
|
|
1344
1476
|
# resp.job_runs[0].outputs[0].location.bucket #=> String
|
1345
1477
|
# resp.job_runs[0].outputs[0].location.key #=> String
|
1346
1478
|
# resp.job_runs[0].outputs[0].overwrite #=> Boolean
|
1479
|
+
# resp.job_runs[0].outputs[0].format_options.csv.delimiter #=> String
|
1347
1480
|
# resp.job_runs[0].recipe_reference.name #=> String
|
1348
1481
|
# resp.job_runs[0].recipe_reference.recipe_version #=> String
|
1349
1482
|
# resp.job_runs[0].started_by #=> String
|
1350
1483
|
# resp.job_runs[0].started_on #=> Time
|
1484
|
+
# resp.job_runs[0].job_sample.mode #=> String, one of "FULL_DATASET", "CUSTOM_ROWS"
|
1485
|
+
# resp.job_runs[0].job_sample.size #=> Integer
|
1351
1486
|
# resp.next_token #=> String
|
1352
1487
|
#
|
1353
1488
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobRuns AWS API Documentation
|
@@ -1359,7 +1494,7 @@ module Aws::GlueDataBrew
|
|
1359
1494
|
req.send_request(options)
|
1360
1495
|
end
|
1361
1496
|
|
1362
|
-
# Lists
|
1497
|
+
# Lists all of the DataBrew jobs that are defined.
|
1363
1498
|
#
|
1364
1499
|
# @option params [String] :dataset_name
|
1365
1500
|
# The name of a dataset. Using this parameter indicates to return only
|
@@ -1418,6 +1553,7 @@ module Aws::GlueDataBrew
|
|
1418
1553
|
# resp.jobs[0].outputs[0].location.bucket #=> String
|
1419
1554
|
# resp.jobs[0].outputs[0].location.key #=> String
|
1420
1555
|
# resp.jobs[0].outputs[0].overwrite #=> Boolean
|
1556
|
+
# resp.jobs[0].outputs[0].format_options.csv.delimiter #=> String
|
1421
1557
|
# resp.jobs[0].project_name #=> String
|
1422
1558
|
# resp.jobs[0].recipe_reference.name #=> String
|
1423
1559
|
# resp.jobs[0].recipe_reference.recipe_version #=> String
|
@@ -1426,6 +1562,8 @@ module Aws::GlueDataBrew
|
|
1426
1562
|
# resp.jobs[0].timeout #=> Integer
|
1427
1563
|
# resp.jobs[0].tags #=> Hash
|
1428
1564
|
# resp.jobs[0].tags["TagKey"] #=> String
|
1565
|
+
# resp.jobs[0].job_sample.mode #=> String, one of "FULL_DATASET", "CUSTOM_ROWS"
|
1566
|
+
# resp.jobs[0].job_sample.size #=> Integer
|
1429
1567
|
# resp.next_token #=> String
|
1430
1568
|
#
|
1431
1569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListJobs AWS API Documentation
|
@@ -1437,10 +1575,11 @@ module Aws::GlueDataBrew
|
|
1437
1575
|
req.send_request(options)
|
1438
1576
|
end
|
1439
1577
|
|
1440
|
-
# Lists all of the DataBrew projects
|
1578
|
+
# Lists all of the DataBrew projects that are defined.
|
1441
1579
|
#
|
1442
1580
|
# @option params [String] :next_token
|
1443
|
-
#
|
1581
|
+
# The token returned by a previous call to retrieve the next set of
|
1582
|
+
# results.
|
1444
1583
|
#
|
1445
1584
|
# @option params [Integer] :max_results
|
1446
1585
|
# The maximum number of results to return in this request.
|
@@ -1489,14 +1628,15 @@ module Aws::GlueDataBrew
|
|
1489
1628
|
req.send_request(options)
|
1490
1629
|
end
|
1491
1630
|
|
1492
|
-
# Lists
|
1493
|
-
#
|
1631
|
+
# Lists the versions of a particular DataBrew recipe, except for
|
1632
|
+
# `LATEST_WORKING`.
|
1494
1633
|
#
|
1495
1634
|
# @option params [Integer] :max_results
|
1496
1635
|
# The maximum number of results to return in this request.
|
1497
1636
|
#
|
1498
1637
|
# @option params [String] :next_token
|
1499
|
-
#
|
1638
|
+
# The token returned by a previous call to retrieve the next set of
|
1639
|
+
# results.
|
1500
1640
|
#
|
1501
1641
|
# @option params [required, String] :name
|
1502
1642
|
# The name of the recipe for which to return version information.
|
@@ -1551,17 +1691,21 @@ module Aws::GlueDataBrew
|
|
1551
1691
|
req.send_request(options)
|
1552
1692
|
end
|
1553
1693
|
|
1554
|
-
# Lists all of the
|
1694
|
+
# Lists all of the DataBrew recipes that are defined.
|
1555
1695
|
#
|
1556
1696
|
# @option params [Integer] :max_results
|
1557
1697
|
# The maximum number of results to return in this request.
|
1558
1698
|
#
|
1559
1699
|
# @option params [String] :next_token
|
1560
|
-
#
|
1700
|
+
# The token returned by a previous call to retrieve the next set of
|
1701
|
+
# results.
|
1561
1702
|
#
|
1562
1703
|
# @option params [String] :recipe_version
|
1563
|
-
#
|
1564
|
-
#
|
1704
|
+
# Return only those recipes with a version identifier of
|
1705
|
+
# `LATEST_WORKING` or `LATEST_PUBLISHED`. If `RecipeVersion` is omitted,
|
1706
|
+
# `ListRecipes` returns all of the `LATEST_PUBLISHED` recipe versions.
|
1707
|
+
#
|
1708
|
+
# Valid values: `LATEST_WORKING` \| `LATEST_PUBLISHED`
|
1565
1709
|
#
|
1566
1710
|
# @return [Types::ListRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1567
1711
|
#
|
@@ -1613,7 +1757,7 @@ module Aws::GlueDataBrew
|
|
1613
1757
|
req.send_request(options)
|
1614
1758
|
end
|
1615
1759
|
|
1616
|
-
# Lists the
|
1760
|
+
# Lists the DataBrew schedules that are defined.
|
1617
1761
|
#
|
1618
1762
|
# @option params [String] :job_name
|
1619
1763
|
# The name of the job that these schedules apply to.
|
@@ -1622,7 +1766,8 @@ module Aws::GlueDataBrew
|
|
1622
1766
|
# The maximum number of results to return in this request.
|
1623
1767
|
#
|
1624
1768
|
# @option params [String] :next_token
|
1625
|
-
#
|
1769
|
+
# The token returned by a previous call to retrieve the next set of
|
1770
|
+
# results.
|
1626
1771
|
#
|
1627
1772
|
# @return [Types::ListSchedulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1628
1773
|
#
|
@@ -1665,7 +1810,7 @@ module Aws::GlueDataBrew
|
|
1665
1810
|
req.send_request(options)
|
1666
1811
|
end
|
1667
1812
|
|
1668
|
-
# Lists all the tags for
|
1813
|
+
# Lists all the tags for a DataBrew resource.
|
1669
1814
|
#
|
1670
1815
|
# @option params [required, String] :resource_arn
|
1671
1816
|
# The Amazon Resource Name (ARN) string that uniquely identifies the
|
@@ -1695,8 +1840,7 @@ module Aws::GlueDataBrew
|
|
1695
1840
|
req.send_request(options)
|
1696
1841
|
end
|
1697
1842
|
|
1698
|
-
# Publishes a new
|
1699
|
-
# exists in the current AWS account.
|
1843
|
+
# Publishes a new version of a DataBrew recipe.
|
1700
1844
|
#
|
1701
1845
|
# @option params [String] :description
|
1702
1846
|
# A description of the recipe to be published, for this version of the
|
@@ -1729,19 +1873,18 @@ module Aws::GlueDataBrew
|
|
1729
1873
|
req.send_request(options)
|
1730
1874
|
end
|
1731
1875
|
|
1732
|
-
# Performs a recipe step within an interactive
|
1733
|
-
#
|
1876
|
+
# Performs a recipe step within an interactive DataBrew session that's
|
1877
|
+
# currently open.
|
1734
1878
|
#
|
1735
1879
|
# @option params [Boolean] :preview
|
1736
|
-
#
|
1737
|
-
#
|
1880
|
+
# If true, the result of the recipe step will be returned, but not
|
1881
|
+
# applied.
|
1738
1882
|
#
|
1739
1883
|
# @option params [required, String] :name
|
1740
1884
|
# The name of the project to apply the action to.
|
1741
1885
|
#
|
1742
1886
|
# @option params [Types::RecipeStep] :recipe_step
|
1743
|
-
# Represents a single step
|
1744
|
-
# recipe.
|
1887
|
+
# Represents a single step from a DataBrew recipe to be performed.
|
1745
1888
|
#
|
1746
1889
|
# @option params [Integer] :step_index
|
1747
1890
|
# The index from which to preview a step. This index is used to preview
|
@@ -1753,8 +1896,7 @@ module Aws::GlueDataBrew
|
|
1753
1896
|
# and ready for work. The action will be performed on this session.
|
1754
1897
|
#
|
1755
1898
|
# @option params [Types::ViewFrame] :view_frame
|
1756
|
-
# Represents the data being being transformed during an
|
1757
|
-
# DataBrew project session.
|
1899
|
+
# Represents the data being being transformed during an action.
|
1758
1900
|
#
|
1759
1901
|
# @return [Types::SendProjectSessionActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1760
1902
|
#
|
@@ -1806,7 +1948,7 @@ module Aws::GlueDataBrew
|
|
1806
1948
|
req.send_request(options)
|
1807
1949
|
end
|
1808
1950
|
|
1809
|
-
# Runs
|
1951
|
+
# Runs a DataBrew job.
|
1810
1952
|
#
|
1811
1953
|
# @option params [required, String] :name
|
1812
1954
|
# The name of the job to be run.
|
@@ -1834,7 +1976,7 @@ module Aws::GlueDataBrew
|
|
1834
1976
|
req.send_request(options)
|
1835
1977
|
end
|
1836
1978
|
|
1837
|
-
# Creates an interactive session, enabling you to manipulate
|
1979
|
+
# Creates an interactive session, enabling you to manipulate data in a
|
1838
1980
|
# DataBrew project.
|
1839
1981
|
#
|
1840
1982
|
# @option params [required, String] :name
|
@@ -1870,7 +2012,7 @@ module Aws::GlueDataBrew
|
|
1870
2012
|
req.send_request(options)
|
1871
2013
|
end
|
1872
2014
|
|
1873
|
-
# Stops
|
2015
|
+
# Stops a particular run of a job.
|
1874
2016
|
#
|
1875
2017
|
# @option params [required, String] :name
|
1876
2018
|
# The name of the job to be stopped.
|
@@ -1902,8 +2044,8 @@ module Aws::GlueDataBrew
|
|
1902
2044
|
req.send_request(options)
|
1903
2045
|
end
|
1904
2046
|
|
1905
|
-
# Adds metadata tags to
|
1906
|
-
#
|
2047
|
+
# Adds metadata tags to a DataBrew resource, such as a dataset, project,
|
2048
|
+
# recipe, job, or schedule.
|
1907
2049
|
#
|
1908
2050
|
# @option params [required, String] :resource_arn
|
1909
2051
|
# The DataBrew resource to which tags should be added. The value for
|
@@ -1933,10 +2075,10 @@ module Aws::GlueDataBrew
|
|
1933
2075
|
req.send_request(options)
|
1934
2076
|
end
|
1935
2077
|
|
1936
|
-
# Removes metadata tags from
|
2078
|
+
# Removes metadata tags from a DataBrew resource.
|
1937
2079
|
#
|
1938
2080
|
# @option params [required, String] :resource_arn
|
1939
|
-
#
|
2081
|
+
# A DataBrew resource from which you want to remove a tag or tags. The
|
1940
2082
|
# value for this parameter is an Amazon Resource Name (ARN).
|
1941
2083
|
#
|
1942
2084
|
# @option params [required, Array<String>] :tag_keys
|
@@ -1960,19 +2102,21 @@ module Aws::GlueDataBrew
|
|
1960
2102
|
req.send_request(options)
|
1961
2103
|
end
|
1962
2104
|
|
1963
|
-
# Modifies the definition of an existing
|
1964
|
-
# the current AWS account.
|
2105
|
+
# Modifies the definition of an existing DataBrew dataset.
|
1965
2106
|
#
|
1966
2107
|
# @option params [required, String] :name
|
1967
2108
|
# The name of the dataset to be updated.
|
1968
2109
|
#
|
2110
|
+
# @option params [String] :format
|
2111
|
+
# Specifies the file format of a dataset created from an S3 file or
|
2112
|
+
# folder.
|
2113
|
+
#
|
1969
2114
|
# @option params [Types::FormatOptions] :format_options
|
1970
|
-
# Options that define
|
1971
|
-
# DataBrew.
|
2115
|
+
# Options that define the structure of either Csv, Excel, or JSON input.
|
1972
2116
|
#
|
1973
2117
|
# @option params [required, Types::Input] :input
|
1974
|
-
# Information on how
|
1975
|
-
#
|
2118
|
+
# Information on how DataBrew can find data, in either the AWS Glue Data
|
2119
|
+
# Catalog or Amazon S3.
|
1976
2120
|
#
|
1977
2121
|
# @return [Types::UpdateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1978
2122
|
#
|
@@ -1982,6 +2126,7 @@ module Aws::GlueDataBrew
|
|
1982
2126
|
#
|
1983
2127
|
# resp = client.update_dataset({
|
1984
2128
|
# name: "DatasetName", # required
|
2129
|
+
# format: "CSV", # accepts CSV, JSON, PARQUET, EXCEL
|
1985
2130
|
# format_options: {
|
1986
2131
|
# json: {
|
1987
2132
|
# multi_line: false,
|
@@ -1989,6 +2134,11 @@ module Aws::GlueDataBrew
|
|
1989
2134
|
# excel: {
|
1990
2135
|
# sheet_names: ["SheetName"],
|
1991
2136
|
# sheet_indexes: [1],
|
2137
|
+
# header_row: false,
|
2138
|
+
# },
|
2139
|
+
# csv: {
|
2140
|
+
# delimiter: "Delimiter",
|
2141
|
+
# header_row: false,
|
1992
2142
|
# },
|
1993
2143
|
# },
|
1994
2144
|
# input: { # required
|
@@ -2021,8 +2171,7 @@ module Aws::GlueDataBrew
|
|
2021
2171
|
req.send_request(options)
|
2022
2172
|
end
|
2023
2173
|
|
2024
|
-
# Modifies the definition of an existing
|
2025
|
-
# current AWS account.
|
2174
|
+
# Modifies the definition of an existing profile job.
|
2026
2175
|
#
|
2027
2176
|
# @option params [String] :encryption_key_arn
|
2028
2177
|
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
@@ -2031,7 +2180,7 @@ module Aws::GlueDataBrew
|
|
2031
2180
|
# @option params [String] :encryption_mode
|
2032
2181
|
# The encryption mode for the job, which can be one of the following:
|
2033
2182
|
#
|
2034
|
-
# * `SSE-KMS` - Server-side encryption with AWS KMS
|
2183
|
+
# * `SSE-KMS` - Server-side encryption with keys managed by AWS KMS.
|
2035
2184
|
#
|
2036
2185
|
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
2037
2186
|
#
|
@@ -2039,12 +2188,11 @@ module Aws::GlueDataBrew
|
|
2039
2188
|
# The name of the job to be updated.
|
2040
2189
|
#
|
2041
2190
|
# @option params [String] :log_subscription
|
2042
|
-
#
|
2043
|
-
#
|
2044
|
-
# stream for each job run.
|
2191
|
+
# Enables or disables Amazon CloudWatch logging for the job. If logging
|
2192
|
+
# is enabled, CloudWatch writes one log stream for each job run.
|
2045
2193
|
#
|
2046
2194
|
# @option params [Integer] :max_capacity
|
2047
|
-
# The maximum number of nodes that DataBrew can use when the job
|
2195
|
+
# The maximum number of compute nodes that DataBrew can use when the job
|
2048
2196
|
# processes data.
|
2049
2197
|
#
|
2050
2198
|
# @option params [Integer] :max_retries
|
@@ -2056,12 +2204,19 @@ module Aws::GlueDataBrew
|
|
2056
2204
|
#
|
2057
2205
|
# @option params [required, String] :role_arn
|
2058
2206
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
2059
|
-
# Management (IAM) role to be assumed
|
2207
|
+
# Management (IAM) role to be assumed when DataBrew runs the job.
|
2060
2208
|
#
|
2061
2209
|
# @option params [Integer] :timeout
|
2062
2210
|
# The job's timeout in minutes. A job that attempts to run longer than
|
2063
2211
|
# this timeout period ends with a status of `TIMEOUT`.
|
2064
2212
|
#
|
2213
|
+
# @option params [Types::JobSample] :job_sample
|
2214
|
+
# Sample configuration for Profile Jobs only. Determines the number of
|
2215
|
+
# rows on which the Profile job will be executed. If a JobSample value
|
2216
|
+
# is not provided for profile jobs, the default value will be used. The
|
2217
|
+
# default value is CUSTOM\_ROWS for the mode parameter and 20000 for the
|
2218
|
+
# size parameter.
|
2219
|
+
#
|
2065
2220
|
# @return [Types::UpdateProfileJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2066
2221
|
#
|
2067
2222
|
# * {Types::UpdateProfileJobResponse#name #name} => String
|
@@ -2081,6 +2236,10 @@ module Aws::GlueDataBrew
|
|
2081
2236
|
# },
|
2082
2237
|
# role_arn: "Arn", # required
|
2083
2238
|
# timeout: 1,
|
2239
|
+
# job_sample: {
|
2240
|
+
# mode: "FULL_DATASET", # accepts FULL_DATASET, CUSTOM_ROWS
|
2241
|
+
# size: 1,
|
2242
|
+
# },
|
2084
2243
|
# })
|
2085
2244
|
#
|
2086
2245
|
# @example Response structure
|
@@ -2096,12 +2255,11 @@ module Aws::GlueDataBrew
|
|
2096
2255
|
req.send_request(options)
|
2097
2256
|
end
|
2098
2257
|
|
2099
|
-
# Modifies the definition of an existing
|
2100
|
-
# the current AWS account.
|
2258
|
+
# Modifies the definition of an existing DataBrew project.
|
2101
2259
|
#
|
2102
2260
|
# @option params [Types::Sample] :sample
|
2103
|
-
# Represents the sample size and sampling type for
|
2104
|
-
#
|
2261
|
+
# Represents the sample size and sampling type for DataBrew to use for
|
2262
|
+
# interactive data analysis.
|
2105
2263
|
#
|
2106
2264
|
# @option params [required, String] :role_arn
|
2107
2265
|
# The Amazon Resource Name (ARN) of the IAM role to be assumed for this
|
@@ -2140,8 +2298,8 @@ module Aws::GlueDataBrew
|
|
2140
2298
|
req.send_request(options)
|
2141
2299
|
end
|
2142
2300
|
|
2143
|
-
# Modifies the definition of the
|
2144
|
-
#
|
2301
|
+
# Modifies the definition of the `LATEST_WORKING` version of a DataBrew
|
2302
|
+
# recipe.
|
2145
2303
|
#
|
2146
2304
|
# @option params [String] :description
|
2147
2305
|
# A description of the recipe.
|
@@ -2194,8 +2352,7 @@ module Aws::GlueDataBrew
|
|
2194
2352
|
req.send_request(options)
|
2195
2353
|
end
|
2196
2354
|
|
2197
|
-
# Modifies the definition of an existing
|
2198
|
-
# the current AWS account.
|
2355
|
+
# Modifies the definition of an existing DataBrew recipe job.
|
2199
2356
|
#
|
2200
2357
|
# @option params [String] :encryption_key_arn
|
2201
2358
|
# The Amazon Resource Name (ARN) of an encryption key that is used to
|
@@ -2204,7 +2361,7 @@ module Aws::GlueDataBrew
|
|
2204
2361
|
# @option params [String] :encryption_mode
|
2205
2362
|
# The encryption mode for the job, which can be one of the following:
|
2206
2363
|
#
|
2207
|
-
# * `SSE-KMS` - Server-side encryption with AWS KMS
|
2364
|
+
# * `SSE-KMS` - Server-side encryption with keys managed by AWS KMS.
|
2208
2365
|
#
|
2209
2366
|
# * `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
|
2210
2367
|
#
|
@@ -2212,9 +2369,8 @@ module Aws::GlueDataBrew
|
|
2212
2369
|
# The name of the job to update.
|
2213
2370
|
#
|
2214
2371
|
# @option params [String] :log_subscription
|
2215
|
-
#
|
2216
|
-
#
|
2217
|
-
# stream for each job run.
|
2372
|
+
# Enables or disables Amazon CloudWatch logging for the job. If logging
|
2373
|
+
# is enabled, CloudWatch writes one log stream for each job run.
|
2218
2374
|
#
|
2219
2375
|
# @option params [Integer] :max_capacity
|
2220
2376
|
# The maximum number of nodes that DataBrew can consume when the job
|
@@ -2228,7 +2384,7 @@ module Aws::GlueDataBrew
|
|
2228
2384
|
#
|
2229
2385
|
# @option params [required, String] :role_arn
|
2230
2386
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
2231
|
-
# Management (IAM) role to be assumed
|
2387
|
+
# Management (IAM) role to be assumed when DataBrew runs the job.
|
2232
2388
|
#
|
2233
2389
|
# @option params [Integer] :timeout
|
2234
2390
|
# The job's timeout in minutes. A job that attempts to run longer than
|
@@ -2257,6 +2413,11 @@ module Aws::GlueDataBrew
|
|
2257
2413
|
# key: "Key",
|
2258
2414
|
# },
|
2259
2415
|
# overwrite: false,
|
2416
|
+
# format_options: {
|
2417
|
+
# csv: {
|
2418
|
+
# delimiter: "Delimiter",
|
2419
|
+
# },
|
2420
|
+
# },
|
2260
2421
|
# },
|
2261
2422
|
# ],
|
2262
2423
|
# role_arn: "Arn", # required
|
@@ -2276,15 +2437,19 @@ module Aws::GlueDataBrew
|
|
2276
2437
|
req.send_request(options)
|
2277
2438
|
end
|
2278
2439
|
|
2279
|
-
# Modifies the definition of an existing
|
2280
|
-
# the current AWS account.
|
2440
|
+
# Modifies the definition of an existing DataBrew schedule.
|
2281
2441
|
#
|
2282
2442
|
# @option params [Array<String>] :job_names
|
2283
2443
|
# The name or names of one or more jobs to be run for this schedule.
|
2284
2444
|
#
|
2285
2445
|
# @option params [required, String] :cron_expression
|
2286
|
-
# The date or dates and time or times
|
2287
|
-
#
|
2446
|
+
# The date or dates and time or times when the jobs are to be run. For
|
2447
|
+
# more information, see [Cron expressions][1] in the *AWS Glue DataBrew
|
2448
|
+
# Developer Guide*.
|
2449
|
+
#
|
2450
|
+
#
|
2451
|
+
#
|
2452
|
+
# [1]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html
|
2288
2453
|
#
|
2289
2454
|
# @option params [required, String] :name
|
2290
2455
|
# The name of the schedule to update.
|
@@ -2327,7 +2492,7 @@ module Aws::GlueDataBrew
|
|
2327
2492
|
params: params,
|
2328
2493
|
config: config)
|
2329
2494
|
context[:gem_name] = 'aws-sdk-gluedatabrew'
|
2330
|
-
context[:gem_version] = '1.
|
2495
|
+
context[:gem_version] = '1.5.0'
|
2331
2496
|
Seahorse::Client::Request.new(handlers, context)
|
2332
2497
|
end
|
2333
2498
|
|