Class: Aws::GlueDataBrew::Types::UpdateRecipeJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::GlueDataBrew::Types::UpdateRecipeJobRequest
- Defined in:
- gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb
Overview
When making an API call, you may pass UpdateRecipeJobRequest data as a hash:
{
encryption_key_arn: "EncryptionKeyArn",
encryption_mode: "SSE-KMS", # accepts SSE-KMS, SSE-S3
name: "JobName", # required
log_subscription: "ENABLE", # accepts ENABLE, DISABLE
max_capacity: 1,
max_retries: 1,
outputs: [
{
compression_format: "GZIP", # accepts GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB
format: "CSV", # accepts CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML, TABLEAUHYPER
partition_columns: ["ColumnName"],
location: { # required
bucket: "Bucket", # required
key: "Key",
bucket_owner: "BucketOwner",
},
overwrite: false,
format_options: {
csv: {
delimiter: "Delimiter",
},
},
max_output_files: 1,
},
],
data_catalog_outputs: [
{
catalog_id: "CatalogId",
database_name: "DatabaseName", # required
table_name: "TableName", # required
s3_options: {
location: { # required
bucket: "Bucket", # required
key: "Key",
bucket_owner: "BucketOwner",
},
},
database_options: {
temp_directory: {
bucket: "Bucket", # required
key: "Key",
bucket_owner: "BucketOwner",
},
table_name: "DatabaseTableName", # required
},
overwrite: false,
},
],
database_outputs: [
{
glue_connection_name: "GlueConnectionName", # required
database_options: { # required
temp_directory: {
bucket: "Bucket", # required
key: "Key",
bucket_owner: "BucketOwner",
},
table_name: "DatabaseTableName", # required
},
database_output_mode: "NEW_TABLE", # accepts NEW_TABLE
},
],
role_arn: "Arn", # required
timeout: 1,
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#data_catalog_outputs ⇒ Array<Types::DataCatalogOutput>
One or more artifacts that represent the Glue Data Catalog output from running the job.
-
#database_outputs ⇒ Array<Types::DatabaseOutput>
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
-
#encryption_key_arn ⇒ String
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
-
#encryption_mode ⇒ String
The encryption mode for the job, which can be one of the following:.
-
#log_subscription ⇒ String
Enables or disables Amazon CloudWatch logging for the job.
-
#max_capacity ⇒ Integer
The maximum number of nodes that DataBrew can consume when the job processes data.
-
#max_retries ⇒ Integer
The maximum number of times to retry the job after a job run fails.
-
#name ⇒ String
The name of the job to update.
-
#outputs ⇒ Array<Types::Output>
One or more artifacts that represent the output from running the job.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
-
#timeout ⇒ Integer
The job's timeout in minutes.
Instance Attribute Details
#data_catalog_outputs ⇒ Array<Types::DataCatalogOutput>
One or more artifacts that represent the Glue Data Catalog output from running the job.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |
#database_outputs ⇒ Array<Types::DatabaseOutput>
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |
#encryption_key_arn ⇒ String
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |
#encryption_mode ⇒ String
The encryption mode for the job, which can be one of the following:
SSE-KMS
- Server-side encryption with keys managed by KMS.SSE-S3
- Server-side encryption with keys managed by Amazon S3.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |
#log_subscription ⇒ String
Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |
#max_capacity ⇒ Integer
The maximum number of nodes that DataBrew can consume when the job processes data.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |
#max_retries ⇒ Integer
The maximum number of times to retry the job after a job run fails.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the job to update.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |
#outputs ⇒ Array<Types::Output>
One or more artifacts that represent the output from running the job.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |
#timeout ⇒ Integer
The job's timeout in minutes. A job that attempts to run longer
than this timeout period ends with a status of TIMEOUT
.
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 5374 class UpdateRecipeJobRequest < Struct.new( :encryption_key_arn, :encryption_mode, :name, :log_subscription, :max_capacity, :max_retries, :outputs, :data_catalog_outputs, :database_outputs, :role_arn, :timeout) SENSITIVE = [] include Aws::Structure end |