Class: Aws::GlueDataBrew::Types::Job

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb

Overview

Represents all of the attributes of a DataBrew job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The ID of the AWS account that owns the job.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#create_dateTime

The date and time that the job was created.

Returns:

  • (Time)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#created_byString

The Amazon Resource Name (ARN) of the user who created the job.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_nameString

A dataset that the job is to process.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_key_arnString

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_modeString

The encryption mode for the job, which can be one of the following:

  • SSE-KMS - Server-side encryption with keys managed by AWS KMS.

  • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#job_sampleTypes::JobSample

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

Returns:



2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_byString

The Amazon Resource Name (ARN) of the user who last modified the job.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_dateTime

The modification date and time of the job.

Returns:

  • (Time)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#log_subscriptionString

The current status of Amazon CloudWatch logging for the job.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacityInteger

The maximum number of nodes that can be consumed when the job processes data.

Returns:

  • (Integer)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#max_retriesInteger

The maximum number of times to retry the job after a job run fails.

Returns:

  • (Integer)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The unique name of the job.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#outputsArray<Types::Output>

One or more artifacts that represent output from running the job.

Returns:



2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#project_nameString

The name of the project that the job is associated with.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#recipe_referenceTypes::RecipeReference

A set of steps that the job runs.



2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

The unique Amazon Resource Name (ARN) for the job.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the role to be assumed for this job.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

Metadata tags that have been applied to the job.

Returns:

  • (Hash<String,String>)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#timeoutInteger

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Returns:

  • (Integer)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The job type of the job, which must be one of the following:

  • PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.

  • RECIPE - A job to apply one or more transformations to a dataset.

Returns:

  • (String)


2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2175

class Job < Struct.new(
  :account_id,
  :created_by,
  :create_date,
  :dataset_name,
  :encryption_key_arn,
  :encryption_mode,
  :name,
  :type,
  :last_modified_by,
  :last_modified_date,
  :log_subscription,
  :max_capacity,
  :max_retries,
  :outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample)
  SENSITIVE = []
  include Aws::Structure
end