aws-sdk-glue 1.292.0 → 1.294.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/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-glue/client.rb +747 -6
- data/lib/aws-sdk-glue/client_api.rb +255 -0
- data/lib/aws-sdk-glue/types.rb +979 -30
- data/lib/aws-sdk-glue.rb +1 -1
- data/sig/client.rbs +129 -48
- data/sig/params.rbs +98 -20
- data/sig/types.rbs +184 -0
- metadata +3 -3
data/lib/aws-sdk-glue/types.rb
CHANGED
|
@@ -6024,6 +6024,176 @@ module Aws::Glue
|
|
|
6024
6024
|
include Aws::Structure
|
|
6025
6025
|
end
|
|
6026
6026
|
|
|
6027
|
+
# @!attribute [rw] name
|
|
6028
|
+
# A name for the data quality evaluation configuration. The name must
|
|
6029
|
+
# be unique within your account.
|
|
6030
|
+
# @return [String]
|
|
6031
|
+
#
|
|
6032
|
+
# @!attribute [rw] level
|
|
6033
|
+
# The Glue Data Catalog hierarchical level that the configuration
|
|
6034
|
+
# applies to. Valid values are `CATALOG`, `DATABASE`, and `TABLE`.
|
|
6035
|
+
# @return [String]
|
|
6036
|
+
#
|
|
6037
|
+
# @!attribute [rw] data_source
|
|
6038
|
+
# The catalog, database, or table that the configuration applies to,
|
|
6039
|
+
# as specified by `Level`.
|
|
6040
|
+
# @return [Types::DataQualityEvaluationConfigDataSource]
|
|
6041
|
+
#
|
|
6042
|
+
# @!attribute [rw] ruleset_name
|
|
6043
|
+
# The name of a Data Quality Definition Language (DQDL) ruleset,
|
|
6044
|
+
# containing analyzers, rules, or both, to evaluate tables with. You
|
|
6045
|
+
# create the ruleset using the `CreateDataQualityRuleset` API. Specify
|
|
6046
|
+
# either `RulesetName` or `ManagedRulesetName`, not both.
|
|
6047
|
+
# @return [String]
|
|
6048
|
+
#
|
|
6049
|
+
# @!attribute [rw] managed_ruleset_name
|
|
6050
|
+
# A built-in ruleset that profiles each table, used when `RulesetName`
|
|
6051
|
+
# is not set. The default is `SIMPLE`. Choose from the following
|
|
6052
|
+
# built-in rulesets:
|
|
6053
|
+
#
|
|
6054
|
+
# SIMPLE
|
|
6055
|
+
#
|
|
6056
|
+
# : Row count and column count, completeness, minimum, and maximum for
|
|
6057
|
+
# every column, mean, sum, and standard deviation for numeric
|
|
6058
|
+
# columns, and column length for string columns.
|
|
6059
|
+
#
|
|
6060
|
+
# ADVANCED
|
|
6061
|
+
#
|
|
6062
|
+
# : Every statistic in `SIMPLE`, plus distribution, uniqueness, and
|
|
6063
|
+
# distinct values count.
|
|
6064
|
+
# @return [String]
|
|
6065
|
+
#
|
|
6066
|
+
# @!attribute [rw] triggers
|
|
6067
|
+
# When the configuration evaluates tables. You can choose one or more
|
|
6068
|
+
# triggers, and each table is evaluated at most once an hour. The
|
|
6069
|
+
# default is `ONCE`. Choose from the following triggers:
|
|
6070
|
+
#
|
|
6071
|
+
# ONCE
|
|
6072
|
+
#
|
|
6073
|
+
# : Evaluates each table one time, including when tables are added to
|
|
6074
|
+
# a database or catalog.
|
|
6075
|
+
#
|
|
6076
|
+
# SCHEDULE
|
|
6077
|
+
#
|
|
6078
|
+
# : Evaluates each table on the cron or rate expression in
|
|
6079
|
+
# `ScheduleExpression`, between the optional `StartAt` and `EndAt`
|
|
6080
|
+
# times.
|
|
6081
|
+
#
|
|
6082
|
+
# METADATA\_CHANGE
|
|
6083
|
+
#
|
|
6084
|
+
# : Evaluates a table whenever its Glue Data Catalog metadata changes,
|
|
6085
|
+
# such as a schema change or an Apache Iceberg commit.
|
|
6086
|
+
# @return [Array<String>]
|
|
6087
|
+
#
|
|
6088
|
+
# @!attribute [rw] schedule_expression
|
|
6089
|
+
# A cron or rate expression, in UTC, for the `SCHEDULE` trigger, for
|
|
6090
|
+
# example `cron(0 6 * * ? *)`. The schedule can run at most once an
|
|
6091
|
+
# hour.
|
|
6092
|
+
# @return [String]
|
|
6093
|
+
#
|
|
6094
|
+
# @!attribute [rw] start_at
|
|
6095
|
+
# The time from which the schedule runs, inclusive.
|
|
6096
|
+
# @return [Time]
|
|
6097
|
+
#
|
|
6098
|
+
# @!attribute [rw] end_at
|
|
6099
|
+
# The time at which the schedule stops running, exclusive.
|
|
6100
|
+
# @return [Time]
|
|
6101
|
+
#
|
|
6102
|
+
# @!attribute [rw] role
|
|
6103
|
+
# The IAM role that evaluations assume. You can specify the role name
|
|
6104
|
+
# or the role Amazon Resource Name (ARN).
|
|
6105
|
+
#
|
|
6106
|
+
# The role must allow the `glue.amazonaws.com` service principal to
|
|
6107
|
+
# assume it, and needs permissions to read the catalog
|
|
6108
|
+
# (`glue:GetCatalog`, `glue:GetDatabase`, `glue:GetTable`,
|
|
6109
|
+
# `glue:SearchTables`, and `glue:GetPartitions`), read and create
|
|
6110
|
+
# rulesets (`glue:GetDataQualityRuleset` and
|
|
6111
|
+
# `glue:CreateDataQualityRuleset`), start evaluations
|
|
6112
|
+
# (`glue:StartDataQualityRulesetEvaluationRun`,
|
|
6113
|
+
# `glue:PublishDataQuality`, and `iam:PassRole` on the role itself),
|
|
6114
|
+
# read the tables' data in Amazon S3, and write logs to Amazon
|
|
6115
|
+
# CloudWatch Logs. If a catalog-level or database-level configuration
|
|
6116
|
+
# applies to an Amazon S3 Tables catalog, the role also needs
|
|
6117
|
+
# `s3tables:ListTableBuckets` and `s3tables:ListTables`. If you use
|
|
6118
|
+
# Lake Formation, the role needs the `DESCRIBE` permission on the
|
|
6119
|
+
# tables.
|
|
6120
|
+
# @return [String]
|
|
6121
|
+
#
|
|
6122
|
+
# @!attribute [rw] number_of_workers
|
|
6123
|
+
# The number of `G.1X` workers to be used in the run. The default is
|
|
6124
|
+
# 5.
|
|
6125
|
+
# @return [Integer]
|
|
6126
|
+
#
|
|
6127
|
+
# @!attribute [rw] timeout
|
|
6128
|
+
# The timeout for a run in minutes. This is the maximum time that a
|
|
6129
|
+
# run can consume resources before it is terminated and enters
|
|
6130
|
+
# `TIMEOUT` status. The default is 2,880 minutes (48 hours).
|
|
6131
|
+
# @return [Integer]
|
|
6132
|
+
#
|
|
6133
|
+
# @!attribute [rw] additional_run_options
|
|
6134
|
+
# Additional run options you can specify for an evaluation run.
|
|
6135
|
+
# @return [Types::DataQualityEvaluationConfigAdditionalRunOptions]
|
|
6136
|
+
#
|
|
6137
|
+
# @!attribute [rw] additional_data_sources
|
|
6138
|
+
# A map of reference strings to additional data sources you can
|
|
6139
|
+
# specify for an evaluation run.
|
|
6140
|
+
# @return [Hash<String,Types::DataSource>]
|
|
6141
|
+
#
|
|
6142
|
+
# @!attribute [rw] tags
|
|
6143
|
+
# A list of tags applied to the data quality evaluation configuration.
|
|
6144
|
+
# @return [Hash<String,String>]
|
|
6145
|
+
#
|
|
6146
|
+
# @!attribute [rw] client_token
|
|
6147
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
6148
|
+
# operation completes no more than one time. If this token matches a
|
|
6149
|
+
# previous request, the service ignores the request, but does not
|
|
6150
|
+
# return an error.
|
|
6151
|
+
#
|
|
6152
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
6153
|
+
# not need to pass this option.
|
|
6154
|
+
# @return [String]
|
|
6155
|
+
#
|
|
6156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/CreateDataQualityEvaluationConfigRequest AWS API Documentation
|
|
6157
|
+
#
|
|
6158
|
+
class CreateDataQualityEvaluationConfigRequest < Struct.new(
|
|
6159
|
+
:name,
|
|
6160
|
+
:level,
|
|
6161
|
+
:data_source,
|
|
6162
|
+
:ruleset_name,
|
|
6163
|
+
:managed_ruleset_name,
|
|
6164
|
+
:triggers,
|
|
6165
|
+
:schedule_expression,
|
|
6166
|
+
:start_at,
|
|
6167
|
+
:end_at,
|
|
6168
|
+
:role,
|
|
6169
|
+
:number_of_workers,
|
|
6170
|
+
:timeout,
|
|
6171
|
+
:additional_run_options,
|
|
6172
|
+
:additional_data_sources,
|
|
6173
|
+
:tags,
|
|
6174
|
+
:client_token)
|
|
6175
|
+
SENSITIVE = []
|
|
6176
|
+
include Aws::Structure
|
|
6177
|
+
end
|
|
6178
|
+
|
|
6179
|
+
# @!attribute [rw] name
|
|
6180
|
+
# The name of the data quality evaluation configuration.
|
|
6181
|
+
# @return [String]
|
|
6182
|
+
#
|
|
6183
|
+
# @!attribute [rw] evaluation_run_mode
|
|
6184
|
+
# The evaluation run mode of the configuration's results, which is
|
|
6185
|
+
# `EVALUATION_CONFIG`.
|
|
6186
|
+
# @return [String]
|
|
6187
|
+
#
|
|
6188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/CreateDataQualityEvaluationConfigResponse AWS API Documentation
|
|
6189
|
+
#
|
|
6190
|
+
class CreateDataQualityEvaluationConfigResponse < Struct.new(
|
|
6191
|
+
:name,
|
|
6192
|
+
:evaluation_run_mode)
|
|
6193
|
+
SENSITIVE = []
|
|
6194
|
+
include Aws::Structure
|
|
6195
|
+
end
|
|
6196
|
+
|
|
6027
6197
|
# A request to create a data quality ruleset.
|
|
6028
6198
|
#
|
|
6029
6199
|
# @!attribute [rw] name
|
|
@@ -8948,6 +9118,246 @@ module Aws::Glue
|
|
|
8948
9118
|
include Aws::Structure
|
|
8949
9119
|
end
|
|
8950
9120
|
|
|
9121
|
+
# Additional run options for each evaluation of a data quality
|
|
9122
|
+
# evaluation configuration.
|
|
9123
|
+
#
|
|
9124
|
+
# @!attribute [rw] cloud_watch_metrics_enabled
|
|
9125
|
+
# Specifies whether to enable CloudWatch metrics.
|
|
9126
|
+
# @return [Boolean]
|
|
9127
|
+
#
|
|
9128
|
+
# @!attribute [rw] results_s3_prefix
|
|
9129
|
+
# Prefix for Amazon S3 to store results.
|
|
9130
|
+
# @return [String]
|
|
9131
|
+
#
|
|
9132
|
+
# @!attribute [rw] composite_rule_evaluation_method
|
|
9133
|
+
# Set the evaluation method for composite rules in the ruleset to
|
|
9134
|
+
# ROW/COLUMN
|
|
9135
|
+
# @return [String]
|
|
9136
|
+
#
|
|
9137
|
+
# @!attribute [rw] row_level_results
|
|
9138
|
+
# The configuration for writing row-level evaluation results to a Glue
|
|
9139
|
+
# Data Catalog table.
|
|
9140
|
+
# @return [Types::RowLevelResultsOptions]
|
|
9141
|
+
#
|
|
9142
|
+
# @!attribute [rw] profiling_results
|
|
9143
|
+
# The configuration for writing profiling results to a Glue Data
|
|
9144
|
+
# Catalog table.
|
|
9145
|
+
# @return [Types::ProfilingResultsOptions]
|
|
9146
|
+
#
|
|
9147
|
+
# @!attribute [rw] observation_scope
|
|
9148
|
+
# The scope of the observation for the evaluation run. Specifies
|
|
9149
|
+
# whether anomaly detection is enabled or disabled.
|
|
9150
|
+
# @return [String]
|
|
9151
|
+
#
|
|
9152
|
+
# @!attribute [rw] observation_mode
|
|
9153
|
+
# The observation mode for the evaluation run. Specifies how anomaly
|
|
9154
|
+
# detection bounds are calculated.
|
|
9155
|
+
# @return [String]
|
|
9156
|
+
#
|
|
9157
|
+
# @!attribute [rw] data_quality_rule_results
|
|
9158
|
+
# The configuration for writing rule results to a Glue Data Catalog
|
|
9159
|
+
# table.
|
|
9160
|
+
# @return [Types::DataQualityRuleResultsOptions]
|
|
9161
|
+
#
|
|
9162
|
+
# @!attribute [rw] observation_results
|
|
9163
|
+
# The configuration for writing observation results to a Glue Data
|
|
9164
|
+
# Catalog table.
|
|
9165
|
+
# @return [Types::ObservationResultsOptions]
|
|
9166
|
+
#
|
|
9167
|
+
# @!attribute [rw] custom_log_group_prefix
|
|
9168
|
+
# A custom prefix for the CloudWatch log group names. When specified,
|
|
9169
|
+
# evaluation run logs are written to `<CustomLogGroupPrefix>/error`
|
|
9170
|
+
# and `<CustomLogGroupPrefix>/output` instead of the default
|
|
9171
|
+
# `/aws-glue/data-quality/error` and `/aws-glue/data-quality/output`
|
|
9172
|
+
# log groups.
|
|
9173
|
+
# @return [String]
|
|
9174
|
+
#
|
|
9175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/DataQualityEvaluationConfigAdditionalRunOptions AWS API Documentation
|
|
9176
|
+
#
|
|
9177
|
+
class DataQualityEvaluationConfigAdditionalRunOptions < Struct.new(
|
|
9178
|
+
:cloud_watch_metrics_enabled,
|
|
9179
|
+
:results_s3_prefix,
|
|
9180
|
+
:composite_rule_evaluation_method,
|
|
9181
|
+
:row_level_results,
|
|
9182
|
+
:profiling_results,
|
|
9183
|
+
:observation_scope,
|
|
9184
|
+
:observation_mode,
|
|
9185
|
+
:data_quality_rule_results,
|
|
9186
|
+
:observation_results,
|
|
9187
|
+
:custom_log_group_prefix)
|
|
9188
|
+
SENSITIVE = []
|
|
9189
|
+
include Aws::Structure
|
|
9190
|
+
end
|
|
9191
|
+
|
|
9192
|
+
# The data source that a data quality evaluation configuration applies
|
|
9193
|
+
# to.
|
|
9194
|
+
#
|
|
9195
|
+
# @!attribute [rw] glue_tables
|
|
9196
|
+
# The Glue Data Catalog tables that the configuration applies to.
|
|
9197
|
+
# @return [Types::DataQualityEvaluationConfigGlueTables]
|
|
9198
|
+
#
|
|
9199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/DataQualityEvaluationConfigDataSource AWS API Documentation
|
|
9200
|
+
#
|
|
9201
|
+
class DataQualityEvaluationConfigDataSource < Struct.new(
|
|
9202
|
+
:glue_tables)
|
|
9203
|
+
SENSITIVE = []
|
|
9204
|
+
include Aws::Structure
|
|
9205
|
+
end
|
|
9206
|
+
|
|
9207
|
+
# Identifies the Glue Data Catalog tables that a data quality evaluation
|
|
9208
|
+
# configuration applies to.
|
|
9209
|
+
#
|
|
9210
|
+
# @!attribute [rw] catalog_id
|
|
9211
|
+
# A unique identifier for the Glue Data Catalog.
|
|
9212
|
+
# @return [String]
|
|
9213
|
+
#
|
|
9214
|
+
# @!attribute [rw] database_name
|
|
9215
|
+
# A database name in the Glue Data Catalog.
|
|
9216
|
+
# @return [String]
|
|
9217
|
+
#
|
|
9218
|
+
# @!attribute [rw] table_name_pattern
|
|
9219
|
+
# For the `CATALOG` and `DATABASE` levels, a glob pattern, such as
|
|
9220
|
+
# `orders_*`, that selects tables. If you don't specify a pattern,
|
|
9221
|
+
# every table at the level is in scope. For the `TABLE` level, the
|
|
9222
|
+
# name of the table.
|
|
9223
|
+
# @return [String]
|
|
9224
|
+
#
|
|
9225
|
+
# @!attribute [rw] pre_processing_query
|
|
9226
|
+
# SQL Query of SparkSQL format that can be used to pre-process the
|
|
9227
|
+
# data for the table in Glue Data Catalog, before running the Data
|
|
9228
|
+
# Quality Operation.
|
|
9229
|
+
#
|
|
9230
|
+
# For the `CATALOG` and `DATABASE` levels, use the `{{DATABASE_NAME}}`
|
|
9231
|
+
# and `{{TABLE_NAME}}` placeholders, which are filled in for each
|
|
9232
|
+
# table.
|
|
9233
|
+
# @return [String]
|
|
9234
|
+
#
|
|
9235
|
+
# @!attribute [rw] connection_name
|
|
9236
|
+
# The name of the connection to the Glue Data Catalog.
|
|
9237
|
+
# @return [String]
|
|
9238
|
+
#
|
|
9239
|
+
# @!attribute [rw] additional_options
|
|
9240
|
+
# Options for reading the table. The following keys are supported:
|
|
9241
|
+
#
|
|
9242
|
+
# * `pushDownPredicate`: to filter on partitions without having to
|
|
9243
|
+
# list and read all the files in your dataset.
|
|
9244
|
+
#
|
|
9245
|
+
# * `catalogPartitionPredicate`: to use server-side partition pruning
|
|
9246
|
+
# using partition indexes in the Glue Data Catalog.
|
|
9247
|
+
# @return [Hash<String,String>]
|
|
9248
|
+
#
|
|
9249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/DataQualityEvaluationConfigGlueTables AWS API Documentation
|
|
9250
|
+
#
|
|
9251
|
+
class DataQualityEvaluationConfigGlueTables < Struct.new(
|
|
9252
|
+
:catalog_id,
|
|
9253
|
+
:database_name,
|
|
9254
|
+
:table_name_pattern,
|
|
9255
|
+
:pre_processing_query,
|
|
9256
|
+
:connection_name,
|
|
9257
|
+
:additional_options)
|
|
9258
|
+
SENSITIVE = []
|
|
9259
|
+
include Aws::Structure
|
|
9260
|
+
end
|
|
9261
|
+
|
|
9262
|
+
# The data source that a data quality evaluation configuration applies
|
|
9263
|
+
# to.
|
|
9264
|
+
#
|
|
9265
|
+
# @!attribute [rw] glue_tables
|
|
9266
|
+
# The Glue Data Catalog tables that the configuration applies to.
|
|
9267
|
+
# @return [Types::DataQualityEvaluationConfigListGlueTables]
|
|
9268
|
+
#
|
|
9269
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/DataQualityEvaluationConfigListDataSource AWS API Documentation
|
|
9270
|
+
#
|
|
9271
|
+
class DataQualityEvaluationConfigListDataSource < Struct.new(
|
|
9272
|
+
:glue_tables)
|
|
9273
|
+
SENSITIVE = []
|
|
9274
|
+
include Aws::Structure
|
|
9275
|
+
end
|
|
9276
|
+
|
|
9277
|
+
# Describes a data quality evaluation configuration.
|
|
9278
|
+
#
|
|
9279
|
+
# @!attribute [rw] name
|
|
9280
|
+
# The name of the data quality evaluation configuration.
|
|
9281
|
+
# @return [String]
|
|
9282
|
+
#
|
|
9283
|
+
# @!attribute [rw] evaluation_run_mode
|
|
9284
|
+
# The evaluation run mode of the configuration's results, which is
|
|
9285
|
+
# `EVALUATION_CONFIG`.
|
|
9286
|
+
# @return [String]
|
|
9287
|
+
#
|
|
9288
|
+
# @!attribute [rw] created_on
|
|
9289
|
+
# The time when the configuration was created.
|
|
9290
|
+
# @return [Time]
|
|
9291
|
+
#
|
|
9292
|
+
# @!attribute [rw] last_modified_on
|
|
9293
|
+
# The time when the configuration was last modified.
|
|
9294
|
+
# @return [Time]
|
|
9295
|
+
#
|
|
9296
|
+
# @!attribute [rw] level
|
|
9297
|
+
# The Glue Data Catalog hierarchical level that the configuration
|
|
9298
|
+
# applies to.
|
|
9299
|
+
# @return [String]
|
|
9300
|
+
#
|
|
9301
|
+
# @!attribute [rw] data_source
|
|
9302
|
+
# The catalog, database, or table that the configuration applies to.
|
|
9303
|
+
# @return [Types::DataQualityEvaluationConfigListDataSource]
|
|
9304
|
+
#
|
|
9305
|
+
# @!attribute [rw] ruleset_name
|
|
9306
|
+
# The name of the data quality ruleset that tables are evaluated with.
|
|
9307
|
+
# @return [String]
|
|
9308
|
+
#
|
|
9309
|
+
# @!attribute [rw] managed_ruleset_name
|
|
9310
|
+
# The built-in ruleset that tables are evaluated with.
|
|
9311
|
+
# @return [String]
|
|
9312
|
+
#
|
|
9313
|
+
# @!attribute [rw] pause_runs
|
|
9314
|
+
# Specifies whether evaluations are paused.
|
|
9315
|
+
# @return [Boolean]
|
|
9316
|
+
#
|
|
9317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/DataQualityEvaluationConfigListDetails AWS API Documentation
|
|
9318
|
+
#
|
|
9319
|
+
class DataQualityEvaluationConfigListDetails < Struct.new(
|
|
9320
|
+
:name,
|
|
9321
|
+
:evaluation_run_mode,
|
|
9322
|
+
:created_on,
|
|
9323
|
+
:last_modified_on,
|
|
9324
|
+
:level,
|
|
9325
|
+
:data_source,
|
|
9326
|
+
:ruleset_name,
|
|
9327
|
+
:managed_ruleset_name,
|
|
9328
|
+
:pause_runs)
|
|
9329
|
+
SENSITIVE = []
|
|
9330
|
+
include Aws::Structure
|
|
9331
|
+
end
|
|
9332
|
+
|
|
9333
|
+
# Identifies the Glue Data Catalog tables that a data quality evaluation
|
|
9334
|
+
# configuration applies to.
|
|
9335
|
+
#
|
|
9336
|
+
# @!attribute [rw] catalog_id
|
|
9337
|
+
# A unique identifier for the Glue Data Catalog.
|
|
9338
|
+
# @return [String]
|
|
9339
|
+
#
|
|
9340
|
+
# @!attribute [rw] database_name
|
|
9341
|
+
# A database name in the Glue Data Catalog.
|
|
9342
|
+
# @return [String]
|
|
9343
|
+
#
|
|
9344
|
+
# @!attribute [rw] table_name_pattern
|
|
9345
|
+
# For the `CATALOG` and `DATABASE` levels, a glob pattern, such as
|
|
9346
|
+
# `orders_*`, that selects tables. If you don't specify a pattern,
|
|
9347
|
+
# every table at the level is in scope. For the `TABLE` level, the
|
|
9348
|
+
# name of the table.
|
|
9349
|
+
# @return [String]
|
|
9350
|
+
#
|
|
9351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/DataQualityEvaluationConfigListGlueTables AWS API Documentation
|
|
9352
|
+
#
|
|
9353
|
+
class DataQualityEvaluationConfigListGlueTables < Struct.new(
|
|
9354
|
+
:catalog_id,
|
|
9355
|
+
:database_name,
|
|
9356
|
+
:table_name_pattern)
|
|
9357
|
+
SENSITIVE = []
|
|
9358
|
+
include Aws::Structure
|
|
9359
|
+
end
|
|
9360
|
+
|
|
8951
9361
|
# Additional run options you can specify for an evaluation run.
|
|
8952
9362
|
#
|
|
8953
9363
|
# @!attribute [rw] cloud_watch_metrics_enabled
|
|
@@ -9127,6 +9537,20 @@ module Aws::Glue
|
|
|
9127
9537
|
# A unique result ID for the data quality result.
|
|
9128
9538
|
# @return [String]
|
|
9129
9539
|
#
|
|
9540
|
+
# @!attribute [rw] evaluation_run_mode
|
|
9541
|
+
# How the evaluation run that produced the result started: `ON_DEMAND`
|
|
9542
|
+
# for a run started by `StartDataQualityRulesetEvaluationRun`, or
|
|
9543
|
+
# `EVALUATION_CONFIG` for a run started by a data quality evaluation
|
|
9544
|
+
# configuration. Not returned for results that no evaluation run
|
|
9545
|
+
# produced, such as results from any ETL job.
|
|
9546
|
+
# @return [String]
|
|
9547
|
+
#
|
|
9548
|
+
# @!attribute [rw] data_quality_evaluation_config
|
|
9549
|
+
# The name of the data quality evaluation configuration that started
|
|
9550
|
+
# the evaluation run, returned when `EvaluationRunMode` is
|
|
9551
|
+
# `EVALUATION_CONFIG`.
|
|
9552
|
+
# @return [String]
|
|
9553
|
+
#
|
|
9130
9554
|
# @!attribute [rw] profile_id
|
|
9131
9555
|
# The Profile ID for the data quality result.
|
|
9132
9556
|
# @return [String]
|
|
@@ -9198,6 +9622,8 @@ module Aws::Glue
|
|
|
9198
9622
|
#
|
|
9199
9623
|
class DataQualityResult < Struct.new(
|
|
9200
9624
|
:result_id,
|
|
9625
|
+
:evaluation_run_mode,
|
|
9626
|
+
:data_quality_evaluation_config,
|
|
9201
9627
|
:profile_id,
|
|
9202
9628
|
:score,
|
|
9203
9629
|
:data_source,
|
|
@@ -9222,6 +9648,20 @@ module Aws::Glue
|
|
|
9222
9648
|
# The unique result ID for this data quality result.
|
|
9223
9649
|
# @return [String]
|
|
9224
9650
|
#
|
|
9651
|
+
# @!attribute [rw] evaluation_run_mode
|
|
9652
|
+
# How the evaluation run that produced the result started: `ON_DEMAND`
|
|
9653
|
+
# for a run started by `StartDataQualityRulesetEvaluationRun`, or
|
|
9654
|
+
# `EVALUATION_CONFIG` for a run started by a data quality evaluation
|
|
9655
|
+
# configuration. Not returned for results that no evaluation run
|
|
9656
|
+
# produced, such as results from any ETL job.
|
|
9657
|
+
# @return [String]
|
|
9658
|
+
#
|
|
9659
|
+
# @!attribute [rw] data_quality_evaluation_config
|
|
9660
|
+
# The name of the data quality evaluation configuration that started
|
|
9661
|
+
# the evaluation run, returned when `EvaluationRunMode` is
|
|
9662
|
+
# `EVALUATION_CONFIG`.
|
|
9663
|
+
# @return [String]
|
|
9664
|
+
#
|
|
9225
9665
|
# @!attribute [rw] data_source
|
|
9226
9666
|
# The table name associated with the data quality result.
|
|
9227
9667
|
# @return [Types::DataSource]
|
|
@@ -9242,6 +9682,8 @@ module Aws::Glue
|
|
|
9242
9682
|
#
|
|
9243
9683
|
class DataQualityResultDescription < Struct.new(
|
|
9244
9684
|
:result_id,
|
|
9685
|
+
:evaluation_run_mode,
|
|
9686
|
+
:data_quality_evaluation_config,
|
|
9245
9687
|
:data_source,
|
|
9246
9688
|
:job_name,
|
|
9247
9689
|
:job_run_id,
|
|
@@ -9273,6 +9715,17 @@ module Aws::Glue
|
|
|
9273
9715
|
# Filter results by runs that started before this time.
|
|
9274
9716
|
# @return [Time]
|
|
9275
9717
|
#
|
|
9718
|
+
# @!attribute [rw] evaluation_run_mode
|
|
9719
|
+
# Filter results by how their evaluation run started: `ON_DEMAND` or
|
|
9720
|
+
# `EVALUATION_CONFIG`. Results that no evaluation run produced match
|
|
9721
|
+
# neither value.
|
|
9722
|
+
# @return [String]
|
|
9723
|
+
#
|
|
9724
|
+
# @!attribute [rw] data_quality_evaluation_config
|
|
9725
|
+
# Filter results by the evaluation configuration name which started
|
|
9726
|
+
# the evaluation run.
|
|
9727
|
+
# @return [String]
|
|
9728
|
+
#
|
|
9276
9729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/DataQualityResultFilterCriteria AWS API Documentation
|
|
9277
9730
|
#
|
|
9278
9731
|
class DataQualityResultFilterCriteria < Struct.new(
|
|
@@ -9280,7 +9733,9 @@ module Aws::Glue
|
|
|
9280
9733
|
:job_name,
|
|
9281
9734
|
:job_run_id,
|
|
9282
9735
|
:started_after,
|
|
9283
|
-
:started_before
|
|
9736
|
+
:started_before,
|
|
9737
|
+
:evaluation_run_mode,
|
|
9738
|
+
:data_quality_evaluation_config)
|
|
9284
9739
|
SENSITIVE = []
|
|
9285
9740
|
include Aws::Structure
|
|
9286
9741
|
end
|
|
@@ -9292,6 +9747,20 @@ module Aws::Glue
|
|
|
9292
9747
|
# A unique result ID for the data quality result.
|
|
9293
9748
|
# @return [String]
|
|
9294
9749
|
#
|
|
9750
|
+
# @!attribute [rw] evaluation_run_mode
|
|
9751
|
+
# How the evaluation run that produced the result started: `ON_DEMAND`
|
|
9752
|
+
# for a run started by `StartDataQualityRulesetEvaluationRun`, or
|
|
9753
|
+
# `EVALUATION_CONFIG` for a run started by a data quality evaluation
|
|
9754
|
+
# configuration. Not returned for results that no evaluation run
|
|
9755
|
+
# produced, such as results from any ETL job.
|
|
9756
|
+
# @return [String]
|
|
9757
|
+
#
|
|
9758
|
+
# @!attribute [rw] data_quality_evaluation_config
|
|
9759
|
+
# The name of the data quality evaluation configuration that started
|
|
9760
|
+
# the evaluation run, returned when `EvaluationRunMode` is
|
|
9761
|
+
# `EVALUATION_CONFIG`.
|
|
9762
|
+
# @return [String]
|
|
9763
|
+
#
|
|
9295
9764
|
# @!attribute [rw] data_source
|
|
9296
9765
|
# The table associated with the data quality result, if any.
|
|
9297
9766
|
# @return [Types::DataSource]
|
|
@@ -9365,6 +9834,8 @@ module Aws::Glue
|
|
|
9365
9834
|
#
|
|
9366
9835
|
class DataQualityResultV2Item < Struct.new(
|
|
9367
9836
|
:result_id,
|
|
9837
|
+
:evaluation_run_mode,
|
|
9838
|
+
:data_quality_evaluation_config,
|
|
9368
9839
|
:data_source,
|
|
9369
9840
|
:dimensions,
|
|
9370
9841
|
:tags,
|
|
@@ -9390,6 +9861,20 @@ module Aws::Glue
|
|
|
9390
9861
|
# The unique result ID for this data quality result.
|
|
9391
9862
|
# @return [String]
|
|
9392
9863
|
#
|
|
9864
|
+
# @!attribute [rw] evaluation_run_mode
|
|
9865
|
+
# How the evaluation run that produced the result started: `ON_DEMAND`
|
|
9866
|
+
# for a run started by `StartDataQualityRulesetEvaluationRun`, or
|
|
9867
|
+
# `EVALUATION_CONFIG` for a run started by a data quality evaluation
|
|
9868
|
+
# configuration. Not returned for results that no evaluation run
|
|
9869
|
+
# produced, such as results from any ETL job.
|
|
9870
|
+
# @return [String]
|
|
9871
|
+
#
|
|
9872
|
+
# @!attribute [rw] data_quality_evaluation_config
|
|
9873
|
+
# The name of the data quality evaluation configuration that started
|
|
9874
|
+
# the evaluation run, returned when `EvaluationRunMode` is
|
|
9875
|
+
# `EVALUATION_CONFIG`.
|
|
9876
|
+
# @return [String]
|
|
9877
|
+
#
|
|
9393
9878
|
# @!attribute [rw] data_source
|
|
9394
9879
|
# The table associated with the data quality result, if any.
|
|
9395
9880
|
# @return [Types::DataSource]
|
|
@@ -9420,6 +9905,8 @@ module Aws::Glue
|
|
|
9420
9905
|
#
|
|
9421
9906
|
class DataQualityResultsV2Description < Struct.new(
|
|
9422
9907
|
:result_id,
|
|
9908
|
+
:evaluation_run_mode,
|
|
9909
|
+
:data_quality_evaluation_config,
|
|
9423
9910
|
:data_source,
|
|
9424
9911
|
:result_published_on,
|
|
9425
9912
|
:dimensions,
|
|
@@ -9459,6 +9946,17 @@ module Aws::Glue
|
|
|
9459
9946
|
# The evaluation context to filter results by.
|
|
9460
9947
|
# @return [String]
|
|
9461
9948
|
#
|
|
9949
|
+
# @!attribute [rw] evaluation_run_mode
|
|
9950
|
+
# Filter results by how their evaluation run started: `ON_DEMAND` or
|
|
9951
|
+
# `EVALUATION_CONFIG`. Results that no evaluation run produced match
|
|
9952
|
+
# neither value.
|
|
9953
|
+
# @return [String]
|
|
9954
|
+
#
|
|
9955
|
+
# @!attribute [rw] data_quality_evaluation_config
|
|
9956
|
+
# Filter results by the evaluation configuration name which started
|
|
9957
|
+
# the evaluation run.
|
|
9958
|
+
# @return [String]
|
|
9959
|
+
#
|
|
9462
9960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/DataQualityResultsV2FilterCriteria AWS API Documentation
|
|
9463
9961
|
#
|
|
9464
9962
|
class DataQualityResultsV2FilterCriteria < Struct.new(
|
|
@@ -9466,7 +9964,9 @@ module Aws::Glue
|
|
|
9466
9964
|
:published_after,
|
|
9467
9965
|
:published_before,
|
|
9468
9966
|
:dimensions,
|
|
9469
|
-
:evaluation_context
|
|
9967
|
+
:evaluation_context,
|
|
9968
|
+
:evaluation_run_mode,
|
|
9969
|
+
:data_quality_evaluation_config)
|
|
9470
9970
|
SENSITIVE = []
|
|
9471
9971
|
include Aws::Structure
|
|
9472
9972
|
end
|
|
@@ -10513,6 +11013,22 @@ module Aws::Glue
|
|
|
10513
11013
|
include Aws::Structure
|
|
10514
11014
|
end
|
|
10515
11015
|
|
|
11016
|
+
# @!attribute [rw] name
|
|
11017
|
+
# The name of the data quality evaluation configuration to delete.
|
|
11018
|
+
# @return [String]
|
|
11019
|
+
#
|
|
11020
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/DeleteDataQualityEvaluationConfigRequest AWS API Documentation
|
|
11021
|
+
#
|
|
11022
|
+
class DeleteDataQualityEvaluationConfigRequest < Struct.new(
|
|
11023
|
+
:name)
|
|
11024
|
+
SENSITIVE = []
|
|
11025
|
+
include Aws::Structure
|
|
11026
|
+
end
|
|
11027
|
+
|
|
11028
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/DeleteDataQualityEvaluationConfigResponse AWS API Documentation
|
|
11029
|
+
#
|
|
11030
|
+
class DeleteDataQualityEvaluationConfigResponse < Aws::EmptyStructure; end
|
|
11031
|
+
|
|
10516
11032
|
# @!attribute [rw] name
|
|
10517
11033
|
# A name for the data quality ruleset.
|
|
10518
11034
|
# @return [String]
|
|
@@ -14400,48 +14916,179 @@ module Aws::Glue
|
|
|
14400
14916
|
|
|
14401
14917
|
# @api private
|
|
14402
14918
|
#
|
|
14403
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetDataCatalogExportConfigurationInput AWS API Documentation
|
|
14919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetDataCatalogExportConfigurationInput AWS API Documentation
|
|
14920
|
+
#
|
|
14921
|
+
class GetDataCatalogExportConfigurationInput < Aws::EmptyStructure; end
|
|
14922
|
+
|
|
14923
|
+
# The export configuration returned by the
|
|
14924
|
+
# `GetDataCatalogExportConfiguration` operation.
|
|
14925
|
+
#
|
|
14926
|
+
# @!attribute [rw] export_setting
|
|
14927
|
+
# The export setting for the data catalog. Valid values are `ENABLED`
|
|
14928
|
+
# and `DISABLED`.
|
|
14929
|
+
# @return [String]
|
|
14930
|
+
#
|
|
14931
|
+
# @!attribute [rw] status
|
|
14932
|
+
# The current status of the export. Valid values are `ENABLING`,
|
|
14933
|
+
# `ENABLED`, `DISABLING`, `DISABLED`, and `FAILED`.
|
|
14934
|
+
# @return [String]
|
|
14935
|
+
#
|
|
14936
|
+
# @!attribute [rw] encryption_configuration
|
|
14937
|
+
# The encryption configuration for the exported data.
|
|
14938
|
+
# @return [Types::ExportEncryptionConfiguration]
|
|
14939
|
+
#
|
|
14940
|
+
# @!attribute [rw] s3_table_bucket_arn
|
|
14941
|
+
# The ARN of the S3 Tables bucket where catalog metadata is exported.
|
|
14942
|
+
# @return [String]
|
|
14943
|
+
#
|
|
14944
|
+
# @!attribute [rw] created_at
|
|
14945
|
+
# The timestamp at which the export configuration was created.
|
|
14946
|
+
# @return [Time]
|
|
14947
|
+
#
|
|
14948
|
+
# @!attribute [rw] updated_at
|
|
14949
|
+
# The timestamp at which the export configuration was last updated.
|
|
14950
|
+
# @return [Time]
|
|
14951
|
+
#
|
|
14952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetDataCatalogExportConfigurationOutput AWS API Documentation
|
|
14953
|
+
#
|
|
14954
|
+
class GetDataCatalogExportConfigurationOutput < Struct.new(
|
|
14955
|
+
:export_setting,
|
|
14956
|
+
:status,
|
|
14957
|
+
:encryption_configuration,
|
|
14958
|
+
:s3_table_bucket_arn,
|
|
14959
|
+
:created_at,
|
|
14960
|
+
:updated_at)
|
|
14961
|
+
SENSITIVE = []
|
|
14962
|
+
include Aws::Structure
|
|
14963
|
+
end
|
|
14964
|
+
|
|
14965
|
+
# @!attribute [rw] name
|
|
14966
|
+
# The name of the data quality evaluation configuration.
|
|
14967
|
+
# @return [String]
|
|
14968
|
+
#
|
|
14969
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetDataQualityEvaluationConfigRequest AWS API Documentation
|
|
14970
|
+
#
|
|
14971
|
+
class GetDataQualityEvaluationConfigRequest < Struct.new(
|
|
14972
|
+
:name)
|
|
14973
|
+
SENSITIVE = []
|
|
14974
|
+
include Aws::Structure
|
|
14975
|
+
end
|
|
14976
|
+
|
|
14977
|
+
# @!attribute [rw] name
|
|
14978
|
+
# The name of the data quality evaluation configuration.
|
|
14979
|
+
# @return [String]
|
|
14980
|
+
#
|
|
14981
|
+
# @!attribute [rw] evaluation_run_mode
|
|
14982
|
+
# The evaluation run mode of the configuration's results, which is
|
|
14983
|
+
# `EVALUATION_CONFIG`.
|
|
14984
|
+
# @return [String]
|
|
14985
|
+
#
|
|
14986
|
+
# @!attribute [rw] created_on
|
|
14987
|
+
# The time when the configuration was created.
|
|
14988
|
+
# @return [Time]
|
|
14989
|
+
#
|
|
14990
|
+
# @!attribute [rw] last_modified_on
|
|
14991
|
+
# The time when the configuration was last modified.
|
|
14992
|
+
# @return [Time]
|
|
14993
|
+
#
|
|
14994
|
+
# @!attribute [rw] level
|
|
14995
|
+
# The Glue Data Catalog hierarchical level that the configuration
|
|
14996
|
+
# applies to.
|
|
14997
|
+
# @return [String]
|
|
14404
14998
|
#
|
|
14405
|
-
|
|
14406
|
-
|
|
14407
|
-
#
|
|
14408
|
-
# `GetDataCatalogExportConfiguration` operation.
|
|
14999
|
+
# @!attribute [rw] data_source
|
|
15000
|
+
# The catalog, database, or table that the configuration applies to.
|
|
15001
|
+
# @return [Types::DataQualityEvaluationConfigDataSource]
|
|
14409
15002
|
#
|
|
14410
|
-
# @!attribute [rw]
|
|
14411
|
-
# The
|
|
14412
|
-
# and `DISABLED`.
|
|
15003
|
+
# @!attribute [rw] ruleset_name
|
|
15004
|
+
# The name of the data quality ruleset that tables are evaluated with.
|
|
14413
15005
|
# @return [String]
|
|
14414
15006
|
#
|
|
14415
|
-
# @!attribute [rw]
|
|
14416
|
-
# The
|
|
14417
|
-
# `ENABLED`, `DISABLING`, `DISABLED`, and `FAILED`.
|
|
15007
|
+
# @!attribute [rw] managed_ruleset_name
|
|
15008
|
+
# The built-in ruleset that tables are evaluated with.
|
|
14418
15009
|
# @return [String]
|
|
14419
15010
|
#
|
|
14420
|
-
# @!attribute [rw]
|
|
14421
|
-
#
|
|
14422
|
-
# @return [Types::ExportEncryptionConfiguration]
|
|
15011
|
+
# @!attribute [rw] triggers
|
|
15012
|
+
# When the configuration evaluates tables:
|
|
14423
15013
|
#
|
|
14424
|
-
#
|
|
14425
|
-
#
|
|
15014
|
+
# ONCE
|
|
15015
|
+
#
|
|
15016
|
+
# : Each table is evaluated one time, including when tables are added
|
|
15017
|
+
# to a database or catalog.
|
|
15018
|
+
#
|
|
15019
|
+
# SCHEDULE
|
|
15020
|
+
#
|
|
15021
|
+
# : Each table is evaluated on the cron or rate expression in
|
|
15022
|
+
# `ScheduleExpression`.
|
|
15023
|
+
#
|
|
15024
|
+
# METADATA\_CHANGE
|
|
15025
|
+
#
|
|
15026
|
+
# : A table is evaluated whenever its Glue Data Catalog metadata
|
|
15027
|
+
# changes.
|
|
15028
|
+
# @return [Array<String>]
|
|
15029
|
+
#
|
|
15030
|
+
# @!attribute [rw] schedule_expression
|
|
15031
|
+
# The cron or rate expression, in UTC, for the `SCHEDULE` trigger.
|
|
14426
15032
|
# @return [String]
|
|
14427
15033
|
#
|
|
14428
|
-
# @!attribute [rw]
|
|
14429
|
-
# The
|
|
15034
|
+
# @!attribute [rw] start_at
|
|
15035
|
+
# The time from which the schedule runs, inclusive.
|
|
14430
15036
|
# @return [Time]
|
|
14431
15037
|
#
|
|
14432
|
-
# @!attribute [rw]
|
|
14433
|
-
# The
|
|
15038
|
+
# @!attribute [rw] end_at
|
|
15039
|
+
# The time at which the schedule stops running, exclusive.
|
|
14434
15040
|
# @return [Time]
|
|
14435
15041
|
#
|
|
14436
|
-
#
|
|
15042
|
+
# @!attribute [rw] pause_runs
|
|
15043
|
+
# Specifies whether evaluations are paused.
|
|
15044
|
+
# @return [Boolean]
|
|
14437
15045
|
#
|
|
14438
|
-
|
|
14439
|
-
|
|
14440
|
-
|
|
14441
|
-
|
|
14442
|
-
|
|
14443
|
-
|
|
14444
|
-
|
|
15046
|
+
# @!attribute [rw] role
|
|
15047
|
+
# The Amazon Resource Name (ARN) of the IAM role that evaluation runs
|
|
15048
|
+
# assume.
|
|
15049
|
+
# @return [String]
|
|
15050
|
+
#
|
|
15051
|
+
# @!attribute [rw] number_of_workers
|
|
15052
|
+
# The number of `G.1X` workers to be used in the run. The default is
|
|
15053
|
+
# 5.
|
|
15054
|
+
# @return [Integer]
|
|
15055
|
+
#
|
|
15056
|
+
# @!attribute [rw] timeout
|
|
15057
|
+
# The timeout for a run in minutes. This is the maximum time that a
|
|
15058
|
+
# run can consume resources before it is terminated and enters
|
|
15059
|
+
# `TIMEOUT` status. The default is 2,880 minutes (48 hours).
|
|
15060
|
+
# @return [Integer]
|
|
15061
|
+
#
|
|
15062
|
+
# @!attribute [rw] additional_run_options
|
|
15063
|
+
# Additional run options you can specify for an evaluation run.
|
|
15064
|
+
# @return [Types::DataQualityEvaluationConfigAdditionalRunOptions]
|
|
15065
|
+
#
|
|
15066
|
+
# @!attribute [rw] additional_data_sources
|
|
15067
|
+
# A map of reference strings to additional data sources you can
|
|
15068
|
+
# specify for an evaluation run.
|
|
15069
|
+
# @return [Hash<String,Types::DataSource>]
|
|
15070
|
+
#
|
|
15071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetDataQualityEvaluationConfigResponse AWS API Documentation
|
|
15072
|
+
#
|
|
15073
|
+
class GetDataQualityEvaluationConfigResponse < Struct.new(
|
|
15074
|
+
:name,
|
|
15075
|
+
:evaluation_run_mode,
|
|
15076
|
+
:created_on,
|
|
15077
|
+
:last_modified_on,
|
|
15078
|
+
:level,
|
|
15079
|
+
:data_source,
|
|
15080
|
+
:ruleset_name,
|
|
15081
|
+
:managed_ruleset_name,
|
|
15082
|
+
:triggers,
|
|
15083
|
+
:schedule_expression,
|
|
15084
|
+
:start_at,
|
|
15085
|
+
:end_at,
|
|
15086
|
+
:pause_runs,
|
|
15087
|
+
:role,
|
|
15088
|
+
:number_of_workers,
|
|
15089
|
+
:timeout,
|
|
15090
|
+
:additional_run_options,
|
|
15091
|
+
:additional_data_sources)
|
|
14445
15092
|
SENSITIVE = []
|
|
14446
15093
|
include Aws::Structure
|
|
14447
15094
|
end
|
|
@@ -14542,6 +15189,20 @@ module Aws::Glue
|
|
|
14542
15189
|
# A unique result ID for the data quality result.
|
|
14543
15190
|
# @return [String]
|
|
14544
15191
|
#
|
|
15192
|
+
# @!attribute [rw] evaluation_run_mode
|
|
15193
|
+
# How the evaluation run that produced the result started: `ON_DEMAND`
|
|
15194
|
+
# for a run started by `StartDataQualityRulesetEvaluationRun`, or
|
|
15195
|
+
# `EVALUATION_CONFIG` for a run started by a data quality evaluation
|
|
15196
|
+
# configuration. Not returned for results that no evaluation run
|
|
15197
|
+
# produced, such as results from any ETL job.
|
|
15198
|
+
# @return [String]
|
|
15199
|
+
#
|
|
15200
|
+
# @!attribute [rw] data_quality_evaluation_config
|
|
15201
|
+
# The name of the data quality evaluation configuration that started
|
|
15202
|
+
# the evaluation run, returned when `EvaluationRunMode` is
|
|
15203
|
+
# `EVALUATION_CONFIG`.
|
|
15204
|
+
# @return [String]
|
|
15205
|
+
#
|
|
14545
15206
|
# @!attribute [rw] profile_id
|
|
14546
15207
|
# The Profile ID for the data quality result.
|
|
14547
15208
|
# @return [String]
|
|
@@ -14613,6 +15274,8 @@ module Aws::Glue
|
|
|
14613
15274
|
#
|
|
14614
15275
|
class GetDataQualityResultResponse < Struct.new(
|
|
14615
15276
|
:result_id,
|
|
15277
|
+
:evaluation_run_mode,
|
|
15278
|
+
:data_quality_evaluation_config,
|
|
14616
15279
|
:profile_id,
|
|
14617
15280
|
:score,
|
|
14618
15281
|
:data_source,
|
|
@@ -14647,6 +15310,20 @@ module Aws::Glue
|
|
|
14647
15310
|
# A unique result ID for the data quality result.
|
|
14648
15311
|
# @return [String]
|
|
14649
15312
|
#
|
|
15313
|
+
# @!attribute [rw] evaluation_run_mode
|
|
15314
|
+
# How the evaluation run that produced the result started: `ON_DEMAND`
|
|
15315
|
+
# for a run started by `StartDataQualityRulesetEvaluationRun`, or
|
|
15316
|
+
# `EVALUATION_CONFIG` for a run started by a data quality evaluation
|
|
15317
|
+
# configuration. Not returned for results that no evaluation run
|
|
15318
|
+
# produced, such as results from any ETL job.
|
|
15319
|
+
# @return [String]
|
|
15320
|
+
#
|
|
15321
|
+
# @!attribute [rw] data_quality_evaluation_config
|
|
15322
|
+
# The name of the data quality evaluation configuration that started
|
|
15323
|
+
# the evaluation run, returned when `EvaluationRunMode` is
|
|
15324
|
+
# `EVALUATION_CONFIG`.
|
|
15325
|
+
# @return [String]
|
|
15326
|
+
#
|
|
14650
15327
|
# @!attribute [rw] data_source
|
|
14651
15328
|
# The table associated with the data quality result, if any.
|
|
14652
15329
|
# @return [Types::DataSource]
|
|
@@ -14724,6 +15401,8 @@ module Aws::Glue
|
|
|
14724
15401
|
#
|
|
14725
15402
|
class GetDataQualityResultV2Response < Struct.new(
|
|
14726
15403
|
:result_id,
|
|
15404
|
+
:evaluation_run_mode,
|
|
15405
|
+
:data_quality_evaluation_config,
|
|
14727
15406
|
:data_source,
|
|
14728
15407
|
:profile_id,
|
|
14729
15408
|
:dimensions,
|
|
@@ -22385,6 +23064,47 @@ module Aws::Glue
|
|
|
22385
23064
|
include Aws::Structure
|
|
22386
23065
|
end
|
|
22387
23066
|
|
|
23067
|
+
# @!attribute [rw] level
|
|
23068
|
+
# Lists only the configurations that apply to this level.
|
|
23069
|
+
# @return [String]
|
|
23070
|
+
#
|
|
23071
|
+
# @!attribute [rw] max_results
|
|
23072
|
+
# The maximum number of results to return.
|
|
23073
|
+
# @return [Integer]
|
|
23074
|
+
#
|
|
23075
|
+
# @!attribute [rw] next_token
|
|
23076
|
+
# A paginated token to offset the results. If you don't specify a
|
|
23077
|
+
# token, the operation returns results starting from the beginning of
|
|
23078
|
+
# the list.
|
|
23079
|
+
# @return [String]
|
|
23080
|
+
#
|
|
23081
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/ListDataQualityEvaluationConfigsRequest AWS API Documentation
|
|
23082
|
+
#
|
|
23083
|
+
class ListDataQualityEvaluationConfigsRequest < Struct.new(
|
|
23084
|
+
:level,
|
|
23085
|
+
:max_results,
|
|
23086
|
+
:next_token)
|
|
23087
|
+
SENSITIVE = []
|
|
23088
|
+
include Aws::Structure
|
|
23089
|
+
end
|
|
23090
|
+
|
|
23091
|
+
# @!attribute [rw] data_quality_evaluation_configs
|
|
23092
|
+
# A list of `DataQualityEvaluationConfigListDetails` objects.
|
|
23093
|
+
# @return [Array<Types::DataQualityEvaluationConfigListDetails>]
|
|
23094
|
+
#
|
|
23095
|
+
# @!attribute [rw] next_token
|
|
23096
|
+
# A pagination token, if more results are available.
|
|
23097
|
+
# @return [String]
|
|
23098
|
+
#
|
|
23099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/ListDataQualityEvaluationConfigsResponse AWS API Documentation
|
|
23100
|
+
#
|
|
23101
|
+
class ListDataQualityEvaluationConfigsResponse < Struct.new(
|
|
23102
|
+
:data_quality_evaluation_configs,
|
|
23103
|
+
:next_token)
|
|
23104
|
+
SENSITIVE = []
|
|
23105
|
+
include Aws::Structure
|
|
23106
|
+
end
|
|
23107
|
+
|
|
22388
23108
|
# @!attribute [rw] filter
|
|
22389
23109
|
# The filter criteria.
|
|
22390
23110
|
# @return [Types::DataQualityResultFilterCriteria]
|
|
@@ -33522,6 +34242,235 @@ module Aws::Glue
|
|
|
33522
34242
|
include Aws::Structure
|
|
33523
34243
|
end
|
|
33524
34244
|
|
|
34245
|
+
# @!attribute [rw] name
|
|
34246
|
+
# The name of the data quality evaluation configuration to update.
|
|
34247
|
+
# @return [String]
|
|
34248
|
+
#
|
|
34249
|
+
# @!attribute [rw] data_source
|
|
34250
|
+
# The database or table that the configuration applies to. Replaces
|
|
34251
|
+
# the current data source.
|
|
34252
|
+
# @return [Types::DataQualityEvaluationConfigDataSource]
|
|
34253
|
+
#
|
|
34254
|
+
# @!attribute [rw] ruleset_name
|
|
34255
|
+
# The name of a Data Quality Definition Language (DQDL) ruleset,
|
|
34256
|
+
# containing analyzers, rules, or both, to evaluate tables with. You
|
|
34257
|
+
# create the ruleset using the `CreateDataQualityRuleset` API. Specify
|
|
34258
|
+
# either `RulesetName` or `ManagedRulesetName`, not both.
|
|
34259
|
+
# @return [String]
|
|
34260
|
+
#
|
|
34261
|
+
# @!attribute [rw] managed_ruleset_name
|
|
34262
|
+
# A built-in ruleset, `SIMPLE` or `ADVANCED`, that profiles each
|
|
34263
|
+
# table.
|
|
34264
|
+
# @return [String]
|
|
34265
|
+
#
|
|
34266
|
+
# @!attribute [rw] triggers
|
|
34267
|
+
# When the configuration evaluates tables. Replaces the current
|
|
34268
|
+
# triggers. Choose from the following triggers:
|
|
34269
|
+
#
|
|
34270
|
+
# ONCE
|
|
34271
|
+
#
|
|
34272
|
+
# : Evaluates each table one time, including when tables are added to
|
|
34273
|
+
# a database or catalog.
|
|
34274
|
+
#
|
|
34275
|
+
# SCHEDULE
|
|
34276
|
+
#
|
|
34277
|
+
# : Evaluates each table on the cron or rate expression in
|
|
34278
|
+
# `ScheduleExpression`, between the optional `StartAt` and `EndAt`
|
|
34279
|
+
# times.
|
|
34280
|
+
#
|
|
34281
|
+
# METADATA\_CHANGE
|
|
34282
|
+
#
|
|
34283
|
+
# : Evaluates a table whenever its Glue Data Catalog metadata changes,
|
|
34284
|
+
# such as a schema change or an Apache Iceberg commit.
|
|
34285
|
+
# @return [Array<String>]
|
|
34286
|
+
#
|
|
34287
|
+
# @!attribute [rw] schedule_expression
|
|
34288
|
+
# A cron or rate expression, in UTC, for the `SCHEDULE` trigger, for
|
|
34289
|
+
# example `cron(0 6 * * ? *)`. The schedule can run at most once an
|
|
34290
|
+
# hour.
|
|
34291
|
+
# @return [String]
|
|
34292
|
+
#
|
|
34293
|
+
# @!attribute [rw] start_at
|
|
34294
|
+
# The time from which the schedule runs, inclusive.
|
|
34295
|
+
# @return [Time]
|
|
34296
|
+
#
|
|
34297
|
+
# @!attribute [rw] end_at
|
|
34298
|
+
# The time at which the schedule stops running, exclusive.
|
|
34299
|
+
# @return [Time]
|
|
34300
|
+
#
|
|
34301
|
+
# @!attribute [rw] pause_runs
|
|
34302
|
+
# Specifies whether to pause the configuration. While paused, the
|
|
34303
|
+
# configuration evaluates nothing, including tables added to the
|
|
34304
|
+
# catalog or database.
|
|
34305
|
+
# @return [Boolean]
|
|
34306
|
+
#
|
|
34307
|
+
# @!attribute [rw] role
|
|
34308
|
+
# The IAM role that evaluations assume. You can specify the role name
|
|
34309
|
+
# or the role Amazon Resource Name (ARN). The role needs the trust
|
|
34310
|
+
# policy and permissions described for
|
|
34311
|
+
# `CreateDataQualityEvaluationConfig`.
|
|
34312
|
+
# @return [String]
|
|
34313
|
+
#
|
|
34314
|
+
# @!attribute [rw] number_of_workers
|
|
34315
|
+
# The number of `G.1X` workers to be used in the run. The default is
|
|
34316
|
+
# 5.
|
|
34317
|
+
# @return [Integer]
|
|
34318
|
+
#
|
|
34319
|
+
# @!attribute [rw] timeout
|
|
34320
|
+
# The timeout for a run in minutes. This is the maximum time that a
|
|
34321
|
+
# run can consume resources before it is terminated and enters
|
|
34322
|
+
# `TIMEOUT` status. The default is 2,880 minutes (48 hours).
|
|
34323
|
+
# @return [Integer]
|
|
34324
|
+
#
|
|
34325
|
+
# @!attribute [rw] additional_run_options
|
|
34326
|
+
# Additional run options you can specify for an evaluation run.
|
|
34327
|
+
# @return [Types::DataQualityEvaluationConfigAdditionalRunOptions]
|
|
34328
|
+
#
|
|
34329
|
+
# @!attribute [rw] additional_data_sources
|
|
34330
|
+
# A map of reference strings to additional data sources you can
|
|
34331
|
+
# specify for an evaluation run.
|
|
34332
|
+
# @return [Hash<String,Types::DataSource>]
|
|
34333
|
+
#
|
|
34334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/UpdateDataQualityEvaluationConfigRequest AWS API Documentation
|
|
34335
|
+
#
|
|
34336
|
+
class UpdateDataQualityEvaluationConfigRequest < Struct.new(
|
|
34337
|
+
:name,
|
|
34338
|
+
:data_source,
|
|
34339
|
+
:ruleset_name,
|
|
34340
|
+
:managed_ruleset_name,
|
|
34341
|
+
:triggers,
|
|
34342
|
+
:schedule_expression,
|
|
34343
|
+
:start_at,
|
|
34344
|
+
:end_at,
|
|
34345
|
+
:pause_runs,
|
|
34346
|
+
:role,
|
|
34347
|
+
:number_of_workers,
|
|
34348
|
+
:timeout,
|
|
34349
|
+
:additional_run_options,
|
|
34350
|
+
:additional_data_sources)
|
|
34351
|
+
SENSITIVE = []
|
|
34352
|
+
include Aws::Structure
|
|
34353
|
+
end
|
|
34354
|
+
|
|
34355
|
+
# @!attribute [rw] name
|
|
34356
|
+
# The name of the data quality evaluation configuration.
|
|
34357
|
+
# @return [String]
|
|
34358
|
+
#
|
|
34359
|
+
# @!attribute [rw] evaluation_run_mode
|
|
34360
|
+
# The evaluation run mode of the configuration's results, which is
|
|
34361
|
+
# `EVALUATION_CONFIG`.
|
|
34362
|
+
# @return [String]
|
|
34363
|
+
#
|
|
34364
|
+
# @!attribute [rw] created_on
|
|
34365
|
+
# The time when the configuration was created.
|
|
34366
|
+
# @return [Time]
|
|
34367
|
+
#
|
|
34368
|
+
# @!attribute [rw] last_modified_on
|
|
34369
|
+
# The time when the configuration was last modified.
|
|
34370
|
+
# @return [Time]
|
|
34371
|
+
#
|
|
34372
|
+
# @!attribute [rw] level
|
|
34373
|
+
# The Glue Data Catalog hierarchical level that the configuration
|
|
34374
|
+
# applies to.
|
|
34375
|
+
# @return [String]
|
|
34376
|
+
#
|
|
34377
|
+
# @!attribute [rw] data_source
|
|
34378
|
+
# The catalog, database, or table that the configuration applies to.
|
|
34379
|
+
# @return [Types::DataQualityEvaluationConfigDataSource]
|
|
34380
|
+
#
|
|
34381
|
+
# @!attribute [rw] ruleset_name
|
|
34382
|
+
# The name of the data quality ruleset that tables are evaluated with.
|
|
34383
|
+
# @return [String]
|
|
34384
|
+
#
|
|
34385
|
+
# @!attribute [rw] managed_ruleset_name
|
|
34386
|
+
# The built-in ruleset that tables are evaluated with.
|
|
34387
|
+
# @return [String]
|
|
34388
|
+
#
|
|
34389
|
+
# @!attribute [rw] triggers
|
|
34390
|
+
# When the configuration evaluates tables:
|
|
34391
|
+
#
|
|
34392
|
+
# ONCE
|
|
34393
|
+
#
|
|
34394
|
+
# : Each table is evaluated one time, including when tables are added
|
|
34395
|
+
# to a database or catalog.
|
|
34396
|
+
#
|
|
34397
|
+
# SCHEDULE
|
|
34398
|
+
#
|
|
34399
|
+
# : Each table is evaluated on the cron or rate expression in
|
|
34400
|
+
# `ScheduleExpression`.
|
|
34401
|
+
#
|
|
34402
|
+
# METADATA\_CHANGE
|
|
34403
|
+
#
|
|
34404
|
+
# : A table is evaluated whenever its Glue Data Catalog metadata
|
|
34405
|
+
# changes.
|
|
34406
|
+
# @return [Array<String>]
|
|
34407
|
+
#
|
|
34408
|
+
# @!attribute [rw] schedule_expression
|
|
34409
|
+
# The cron or rate expression, in UTC, for the `SCHEDULE` trigger.
|
|
34410
|
+
# @return [String]
|
|
34411
|
+
#
|
|
34412
|
+
# @!attribute [rw] start_at
|
|
34413
|
+
# The time from which the schedule runs, inclusive.
|
|
34414
|
+
# @return [Time]
|
|
34415
|
+
#
|
|
34416
|
+
# @!attribute [rw] end_at
|
|
34417
|
+
# The time at which the schedule stops running, exclusive.
|
|
34418
|
+
# @return [Time]
|
|
34419
|
+
#
|
|
34420
|
+
# @!attribute [rw] pause_runs
|
|
34421
|
+
# Specifies whether evaluations are paused.
|
|
34422
|
+
# @return [Boolean]
|
|
34423
|
+
#
|
|
34424
|
+
# @!attribute [rw] role
|
|
34425
|
+
# The Amazon Resource Name (ARN) of the IAM role that evaluation runs
|
|
34426
|
+
# assume.
|
|
34427
|
+
# @return [String]
|
|
34428
|
+
#
|
|
34429
|
+
# @!attribute [rw] number_of_workers
|
|
34430
|
+
# The number of `G.1X` workers to be used in the run. The default is
|
|
34431
|
+
# 5.
|
|
34432
|
+
# @return [Integer]
|
|
34433
|
+
#
|
|
34434
|
+
# @!attribute [rw] timeout
|
|
34435
|
+
# The timeout for a run in minutes. This is the maximum time that a
|
|
34436
|
+
# run can consume resources before it is terminated and enters
|
|
34437
|
+
# `TIMEOUT` status. The default is 2,880 minutes (48 hours).
|
|
34438
|
+
# @return [Integer]
|
|
34439
|
+
#
|
|
34440
|
+
# @!attribute [rw] additional_run_options
|
|
34441
|
+
# Additional run options you can specify for an evaluation run.
|
|
34442
|
+
# @return [Types::DataQualityEvaluationConfigAdditionalRunOptions]
|
|
34443
|
+
#
|
|
34444
|
+
# @!attribute [rw] additional_data_sources
|
|
34445
|
+
# A map of reference strings to additional data sources you can
|
|
34446
|
+
# specify for an evaluation run.
|
|
34447
|
+
# @return [Hash<String,Types::DataSource>]
|
|
34448
|
+
#
|
|
34449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/UpdateDataQualityEvaluationConfigResponse AWS API Documentation
|
|
34450
|
+
#
|
|
34451
|
+
class UpdateDataQualityEvaluationConfigResponse < Struct.new(
|
|
34452
|
+
:name,
|
|
34453
|
+
:evaluation_run_mode,
|
|
34454
|
+
:created_on,
|
|
34455
|
+
:last_modified_on,
|
|
34456
|
+
:level,
|
|
34457
|
+
:data_source,
|
|
34458
|
+
:ruleset_name,
|
|
34459
|
+
:managed_ruleset_name,
|
|
34460
|
+
:triggers,
|
|
34461
|
+
:schedule_expression,
|
|
34462
|
+
:start_at,
|
|
34463
|
+
:end_at,
|
|
34464
|
+
:pause_runs,
|
|
34465
|
+
:role,
|
|
34466
|
+
:number_of_workers,
|
|
34467
|
+
:timeout,
|
|
34468
|
+
:additional_run_options,
|
|
34469
|
+
:additional_data_sources)
|
|
34470
|
+
SENSITIVE = []
|
|
34471
|
+
include Aws::Structure
|
|
34472
|
+
end
|
|
34473
|
+
|
|
33525
34474
|
# @!attribute [rw] name
|
|
33526
34475
|
# The name of the data quality ruleset.
|
|
33527
34476
|
# @return [String]
|