Class: Aws::Glue::Types::GetDataQualityRuleRecommendationRunResponse

Inherits:

Struct

• Object
• Struct
• Aws::Glue::Types::GetDataQualityRuleRecommendationRunResponse

Defined in:

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

Overview

The response for the Data Quality rule recommendation run.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_run_options ⇒ Types::DataQualityRuleRecommendationRunAdditionalRunOptions

  Additional run options you can specify for a recommendation run.

• #completed_on ⇒ Time

  The date and time when this run was completed.

• #created_ruleset_name ⇒ String

  The name of the ruleset that was created by the run.

• #data_quality_security_configuration ⇒ String

  The name of the security configuration created with the data quality encryption option.

• #data_source ⇒ Types::DataSource

  The data source (an Glue table) associated with this run.

• #error_string ⇒ String

  The error strings that are associated with the run.

• #execution_time ⇒ Integer

  The amount of time (in seconds) that the run consumed resources.

• #last_modified_on ⇒ Time

  A timestamp.

• #number_of_workers ⇒ Integer

  The number of G.1X workers to be used in the run.

• #recommendation_mode ⇒ String

  The mode that Glue Data Quality uses to recommend rules.

• #recommended_ruleset ⇒ String

  When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules).

• #role ⇒ String

  The IAM role that Glue assumes to access resources for the run.

• #run_id ⇒ String

  The unique run identifier associated with this run.

• #started_on ⇒ Time

  The date and time when this run started.

• #status ⇒ String

  The status for this run.

• #timeout ⇒ Integer

  The timeout for a run in minutes.

Instance Attribute Details

#additional_run_options ⇒ Types::DataQualityRuleRecommendationRunAdditionalRunOptions

Additional run options you can specify for a recommendation run.

Returns:

• (Types::DataQualityRuleRecommendationRunAdditionalRunOptions)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#completed_on ⇒ Time

The date and time when this run was completed.

Returns:

• (Time)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#created_ruleset_name ⇒ String

The name of the ruleset that was created by the run.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#data_quality_security_configuration ⇒ String

The name of the security configuration created with the data quality encryption option.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#data_source ⇒ Types::DataSource

The data source (an Glue table) associated with this run.

Returns:

• (Types::DataSource)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#error_string ⇒ String

The error strings that are associated with the run.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#execution_time ⇒ Integer

The amount of time (in seconds) that the run consumed resources.

Returns:

• (Integer)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_on ⇒ Time

A timestamp. The last point in time when this data quality rule recommendation run was modified.

Returns:

• (Time)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_workers ⇒ Integer

The number of G.1X workers to be used in the run. The default is 5.

Returns:

• (Integer)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#recommendation_mode ⇒ String

The mode that Glue Data Quality uses to recommend rules.

The default is BASIC.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#recommended_ruleset ⇒ String

When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ String

The IAM role that Glue assumes to access resources for the run.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#run_id ⇒ String

The unique run identifier associated with this run.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#started_on ⇒ Time

The date and time when this run started.

Returns:

• (Time)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status for this run.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ Integer

The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

Returns:

• (Integer)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 14278

class GetDataQualityRuleRecommendationRunResponse < Struct.new(
  :run_id,
  :data_source,
  :role,
  :number_of_workers,
  :timeout,
  :status,
  :error_string,
  :started_on,
  :last_modified_on,
  :completed_on,
  :execution_time,
  :recommended_ruleset,
  :created_ruleset_name,
  :data_quality_security_configuration,
  :additional_run_options,
  :recommendation_mode)
  SENSITIVE = []
  include Aws::Structure
end