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

Inherits:

Struct

• Object
• Struct
• Aws::GlueDataBrew::Types::Job

Defined in:

gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb

Overview

Represents all of the attributes of a DataBrew job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  The ID of the Amazon Web Services account that owns the job.

• #create_date ⇒ Time

  The date and time that the job was created.

• #created_by ⇒ String

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

• #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.

• #dataset_name ⇒ String

  A dataset that the job is to process.

• #encryption_key_arn ⇒ String

  The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.

• #encryption_mode ⇒ String

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

• #job_sample ⇒ Types::JobSample

  A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.

• #last_modified_by ⇒ String

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

• #last_modified_date ⇒ Time

  The modification date and time of the job.

• #log_subscription ⇒ String

  The current status of Amazon CloudWatch logging for the job.

• #max_capacity ⇒ Integer

  The maximum number of nodes that can be consumed 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 unique name of the job.

• #outputs ⇒ Array<Types::Output>

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

• #project_name ⇒ String

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

• #recipe_reference ⇒ Types::RecipeReference

  A set of steps that the job runs.

• #resource_arn ⇒ String

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

• #role_arn ⇒ String

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

• #tags ⇒ Hash<String,String>

  Metadata tags that have been applied to the job.

• #timeout ⇒ Integer

  The job's timeout in minutes.

• #type ⇒ String

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

• #validation_configurations ⇒ Array<Types::ValidationConfiguration>

  List of validation configurations that are applied to the profile job.

Instance Attribute Details

#account_id ⇒ String

The ID of the Amazon Web Services account that owns the job.

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#create_date ⇒ Time

The date and time that the job was created.

Returns:

• (Time)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#data_catalog_outputs ⇒ Array<Types::DataCatalogOutput>

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

Returns:

• (Array<Types::DataCatalogOutput>)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  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.

Returns:

• (Array<Types::DatabaseOutput>)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_name ⇒ String

A dataset that the job is to process.

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  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 output. For more information, see Encrypting data written by DataBrew jobs

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  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.

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#job_sample ⇒ Types::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:

• (Types::JobSample)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_by ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Time

The modification date and time of the job.

Returns:

• (Time)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#log_subscription ⇒ String

The current status of Amazon CloudWatch logging for the job.

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacity ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#max_retries ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The unique name of the job.

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#outputs ⇒ Array<Types::Output>

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

Returns:

• (Array<Types::Output>)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#project_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#recipe_reference ⇒ Types::RecipeReference

A set of steps that the job runs.

Returns:

• (Types::RecipeReference)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Metadata tags that have been applied to the job.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  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.

Returns:

• (Integer)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#validation_configurations ⇒ Array<Types::ValidationConfiguration>

List of validation configurations that are applied to the profile job.

Returns:

• (Array<Types::ValidationConfiguration>)

# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 2912

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,
  :data_catalog_outputs,
  :database_outputs,
  :project_name,
  :recipe_reference,
  :resource_arn,
  :role_arn,
  :timeout,
  :tags,
  :job_sample,
  :validation_configurations)
  SENSITIVE = []
  include Aws::Structure
end