翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
データ品質 API
Data Quality は、データ品質のデータ型をAPI記述し、データ品質ルールセット、実行、評価を作成、削除、更新APIするための が含まれています。
データ型
DataSource 構造
データ品質結果が必要なデータソース ( AWS Glue テーブル)。
フィールド
-
GlueTable
– 必須: GlueTable オブジェクト。AWS Glue テーブル。
DataQualityRulesetListDetails 構造
GetDataQualityRuleset
によって返されるデータ品質ルールセットを記述します。
フィールド
-
Name
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質ルールセットの名前。
-
Description
– 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。データ品質ルールセットの説明。
-
CreatedOn
– タイムスタンプ。データ品質ルールセットの作成日時。
-
LastModifiedOn
– タイムスタンプ。データ品質ルールセットの最終変更日時。
-
TargetTable
– DataQualityTargetTable オブジェクト。AWS Glue テーブルを表すオブジェクト。
-
RecommendationRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。推奨実行からルールセットが作成されると、この 2 つをリンクさせるためにこの実行 ID が生成されます。
-
RuleCount
– 数値 (整数)。ルールセット内のルールの数。
DataQualityTargetTable 構造
AWS Glue テーブルを表すオブジェクト。
フィールド
-
TableName
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。AWS Glue テーブルの名前。
-
DatabaseName
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。AWS Glue テーブルが存在するデータベースの名前。
-
CatalogId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。AWS Glue テーブルが存在するカタログ ID。
DataQualityRulesetEvaluationRunDescription 構造
データ品質ルールセットの評価実行の結果を記述します。
フィールド
-
RunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
-
Status
– UTF-8 文字列 (有効な値:STARTING
|RUNNING
| |STOPPING
|STOPPED
SUCCEEDED
|FAILED
|TIMEOUT
)。この実行のステータス。
-
StartedOn
– タイムスタンプ。実行が開始された日時。
-
DataSource
– DataSource オブジェクト。実行に関連付けられたデータソース ( AWS Glue テーブル)。
DataQualityRulesetEvaluationRunFilter 構造
フィルタリング基準。
フィールド
-
DataSource
– 必須: DataSource オブジェクト。実行に関連付けられたデータソース ( AWS Glue テーブル) に基づいてフィルタリングします。
-
StartedBefore
– タイムスタンプ。この時刻より前に開始された実行で結果をフィルタリングします。
-
StartedAfter
– タイムスタンプ。この時刻以降に開始された実行で結果をフィルタリングします。
DataQualityEvaluationRunAdditionalRunOptions 構造
評価実行で指定できるその他の実行オプション。
フィールド
-
CloudWatchMetricsEnabled
– ブール。CloudWatch メトリクスを有効にするかどうか。
-
ResultsS3Prefix
– UTF-8 文字列。結果を保存する Amazon S3 のプレフィックス。
-
CompositeRuleEvaluationMethod
– UTF-8 文字列 (有効な値:COLUMN
|ROW
)。ルールセットの複合ルールの評価方法を ROW/ に設定します。COLUMN
DataQualityRuleRecommendationRunDescription 構造
データ品質ルールの推奨実行の結果を記述します。
フィールド
-
RunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
-
Status
– UTF-8 文字列 (有効な値:STARTING
|RUNNING
| |STOPPING
|STOPPED
SUCCEEDED
|FAILED
|TIMEOUT
)。この実行のステータス。
-
StartedOn
– タイムスタンプ。この実行の開始日時。
-
DataSource
– DataSource オブジェクト。レコメンデーション実行に関連付けられたデータソース (AWS Glue テーブル)。
DataQualityRuleRecommendationRunFilter 構造
データ品質の推奨実行を一覧表示するためのフィルター。
フィールド
-
DataSource
– 必須: DataSource オブジェクト。指定されたデータソース (AWS Glue テーブル) に基づいてフィルタリングします。
-
StartedBefore
– タイムスタンプ。指定した時刻より前に開始された結果の場合、時刻に基づいてフィルタリングします。
-
StartedAfter
– タイムスタンプ。指定した時刻以降に開始された結果の場合、時刻に基づいてフィルタリングします。
DataQualityResult 構造
データ品質結果を記述します。
フィールド
-
ResultId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に対する一意の結果 ID。
-
ProfileId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果のプロファイル ID。
-
Score
– 数値 (double)。1.0 以下。集計されたデータ品質のスコア。ルールの合計数に対する合格ルールの比率を表します。
-
DataSource
– DataSource オブジェクト。データ品質結果に関連付けられたテーブル (存在する場合)。
-
RulesetName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたルールセットの名前。
-
EvaluationContext
– UTF-8 文字列。AWS Glue Studio のジョブのコンテキストでは、キャンバス内の各ノードには通常、何らかの名前が割り当てられ、データ品質ノードには名前が割り当てられます。複数のノードの場合、
evaluationContext
でノードを区別できます。 -
StartedOn
– タイムスタンプ。このデータ品質の実行の開始日時。
-
CompletedOn
– タイムスタンプ。このデータ品質の実行の完了日時。
-
JobName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたジョブ名 (存在する場合)。
-
JobRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたジョブ実行 ID (存在する場合)。
-
RulesetEvaluationRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。このデータ品質結果のルールセット評価に対する一意の実行 ID。
-
RuleResults
– DataQualityRuleResult オブジェクトの配列。構造 2000 個以下。各ルールの結果を表す
DataQualityRuleResult
オブジェクトのリスト。 -
AnalyzerResults
– DataQualityAnalyzerResult オブジェクトの配列。構造 2000 個以下。各アナライザーの結果を表す
DataQualityAnalyzerResult
オブジェクトのリスト。 -
Observations
– DataQualityObservation オブジェクトの配列。構造 50 個以下。DataQualityObservation
ルールとアナライザーを評価した後に生成された観測値を表すオブジェクトのリスト。
DataQualityAnalyzerResult 構造
データ品質アナライザーの評価の結果を説明します。
フィールド
-
Name
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質アナライザーの名前。
-
Description
– UTF-8 文字列、2048 バイト長以下、 に一致URI address multi-line string pattern。データ品質アナライザーの説明。
-
EvaluationMessage
– UTF-8 文字列、2048 バイト長以下、 に一致URI address multi-line string pattern。評価メッセージ。
-
EvaluatedMetrics
– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1~255 バイト長で、 と一致しますSingle-line string pattern。
各値は数値 (double) です。
アナライザーの評価に関連付けられているメトリクスのマップ。
DataQualityObservation 構造
ルールおよびアナライザーを評価した後に生成される観測値について説明します。
フィールド
-
Description
– UTF-8 文字列、2048 バイト長以下、 に一致URI address multi-line string pattern。データ品質観察の説明。
-
MetricBasedObservation
– MetricBasedObservation オブジェクト。評価されたデータ品質メトリクスに基づく観測値を表す
MetricBasedObservation
タイプのオブジェクト。
MetricBasedObservation 構造
評価されたデータ品質メトリクスに基づいて生成されたメトリクスベースの観測値について説明します。
フィールド
-
MetricName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。観測値を生成するために使用されるデータ品質メトリクスの名前。
-
StatisticId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。統計 ID。
-
MetricValues
– DataQualityMetricValues オブジェクト。データ品質メトリクス値の分析を表す
DataQualityMetricValues
タイプのオブジェクト。 -
NewRules
– UTF-8 文字列の配列。データ品質メトリクス値に基づく観測値の一部として生成された新しいデータ品質ルールのリスト。
DataQualityMetricValues 構造
履歴データの分析に基づくデータ品質メトリクス値を説明します。
フィールド
-
ActualValue
– 数値 (double)。データ品質メトリクスの実際の値。
-
ExpectedValue
– 数値 (double)。履歴データの分析に基づくデータ品質メトリクスの期待値。
-
LowerLimit
– 数値 (double)。履歴データの分析に基づくデータ品質メトリクスの下限値。
-
UpperLimit
– 数値 (double)。履歴データの分析に基づくデータ品質メトリクスの上限値。
DataQualityRuleResult 構造
データ品質ルールの評価の結果を記述します。
フィールド
-
Name
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質ルールの名前。
-
Description
– UTF-8 文字列、2048 バイト長以下、 に一致URI address multi-line string pattern。データ品質ルールの説明。
-
EvaluationMessage
– UTF-8 文字列、2048 バイト長以下、 に一致URI address multi-line string pattern。評価メッセージ。
-
Result
– UTF-8 文字列 (有効な値:PASS
|FAIL
|ERROR
)。ルールの合格または不合格のステータス。
-
EvaluatedMetrics
– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1~255 バイト長で、 と一致しますSingle-line string pattern。
各値は数値 (double) です。
ルールの評価に関連するメトリクスのマップ。
-
EvaluatedRule
– UTF-8 文字列、2048 バイト長以下、 に一致URI address multi-line string pattern。評価済みのルール。
DataQualityResultDescription 構造
データ品質結果を記述します。
フィールド
-
ResultId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。このデータ品質結果に対する一意の結果 ID。
-
DataSource
– DataSource オブジェクト。データ品質結果に関連付けられたテーブル名。
-
JobName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたジョブ名。
-
JobRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたジョブ実行 ID。
-
StartedOn
– タイムスタンプ。このデータ品質結果の実行が開始された時刻。
DataQualityResultFilterCriteria 構造
データ品質結果を返すために使用される基準。
フィールド
-
DataSource
– DataSource オブジェクト。指定したデータソースで結果をフィルタリングします。例えば、 AWS Glue テーブルのすべての結果を取得します。
-
JobName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。指定したジョブ名で結果をフィルタリングします。
-
JobRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。指定したジョブ実行 ID で結果をフィルタリングします。
-
StartedAfter
– タイムスタンプ。この時刻以降に開始された実行で結果をフィルタリングします。
-
StartedBefore
– タイムスタンプ。この時刻より前に開始された実行で結果をフィルタリングします。
DataQualityRulesetFilterCriteria 構造
データ品質ルールセットのフィルタリングに使用される基準。
フィールド
-
Name
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。ルールセットのフィルタリング基準の名前。
-
Description
– 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。ルールセットのフィルタリング基準の説明。
-
CreatedBefore
– タイムスタンプ。この日付より前に作成されたルールセットをフィルタリングします。
-
CreatedAfter
– タイムスタンプ。この日付以降に作成されたルールセットをフィルタリングします。
-
LastModifiedBefore
– タイムスタンプ。この日付より前に最終変更されたルールセットをフィルタリングします。
-
LastModifiedAfter
– タイムスタンプ。この日付より後に最終変更されたルールセットをフィルタリングします。
-
TargetTable
– DataQualityTargetTable オブジェクト。ターゲットテーブルの名前およびデータベース名。
StatisticAnnotation 構造
統計アノテーション。
フィールド
-
ProfileId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。プロファイル ID。
-
StatisticId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。統計 ID。
-
StatisticRecordedOn
– タイムスタンプ。注釈付き統計が記録されたタイムスタンプ。
-
InclusionAnnotation
– TimestampedInclusionAnnotation オブジェクト。統計に適用される包含注釈。
TimestampedInclusionAnnotation 構造
タイムスタンプ付きの包含注釈。
フィールド
-
Value
– UTF-8 文字列 (有効な値:INCLUDE
|EXCLUDE
)。包含注釈の値。
-
LastModifiedOn
– タイムスタンプ。包含アノテーションが最後に変更されたときのタイムスタンプ。
AnnotationError 構造
失敗した注釈。
フィールド
-
ProfileId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。失敗した注釈のプロファイル ID。
-
StatisticId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。失敗した注釈の統計 ID。
-
FailureReason
– 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。注釈が失敗した理由。
DatapointInclusionAnnotation 構造
包含アノテーション。
フィールド
-
ProfileId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。統計が属するデータ品質プロファイルの ID。
-
StatisticId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。統計 ID。
-
InclusionAnnotation
– UTF-8 文字列 (有効な値:INCLUDE
|EXCLUDE
)。統計に適用する包含注釈値。
StatisticSummaryList リスト
StatisticSummary
のリスト。
StatisticSummary オブジェクトの配列。
StatisticSummary
のリスト。
StatisticSummary 構造
統計に関する概要情報。
フィールド
-
StatisticId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。統計 ID。
-
ProfileId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。プロファイル ID。
-
RunIdentifier
– RunIdentifier オブジェクト。実行識別子
-
StatisticName
– UTF-8 文字列、1~255 バイト長、 に一致Custom string pattern #32。統計の名前。
-
DoubleValue
– 数値 (double)。統計の値。
-
EvaluationLevel
– UTF-8 文字列 (有効な値:Dataset="DATASET"
|Column="COLUMN"
|Multicolumn="MULTICOLUMN"
)。統計の評価レベル。指定できる値:
Dataset
、Column
、Multicolumn
。 -
ColumnsReferenced
– UTF-8 文字列の配列。統計によって参照される列のリスト。
-
ReferencedDatasets
– UTF-8 文字列の配列。統計によって参照されるデータセットのリスト。
-
StatisticProperties
– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1~255 バイト長で、 と一致しますSingle-line string pattern。
各値は説明文字列であり、2048 バイト長以下で、URI address multi-line string pattern に一致します。
NameString
とStatisticPropertiesMap
を含む 。DescriptionString
-
RecordedOn
– タイムスタンプ。統計が記録されたタイムスタンプ。
-
InclusionAnnotation
– TimestampedInclusionAnnotation オブジェクト。統計の包含注釈。
RunIdentifier 構造
実行識別子。
フィールド
-
RunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。実行 ID。
-
JobRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。ジョブ実行 ID。
StatisticModelResult 構造
統計モデルの結果。
フィールド
-
LowerBound
– 数値 (double)。下限。
-
UpperBound
– 数値 (double)。上限。
-
PredictedValue
– 数値 (double)。予測値。
-
ActualValue
– 数値 (double)。実際の値。
-
Date
– タイムスタンプ。日付。
-
InclusionAnnotation
– UTF-8 文字列 (有効な値:INCLUDE
|EXCLUDE
)。包含アノテーション。
操作
StartDataQualityRulesetEvaluationRun アクション (Python: start_data_quality_ruleset_evaluation_run )
CancelDataQualityRulesetEvaluationRun アクション (Python: cancel_data_quality_ruleset_evaluation_run )
GetDataQualityRulesetEvaluationRun アクション (Python: get_data_quality_ruleset_evaluation_run)
ListDataQualityRulesetEvaluationRuns アクション (Python: list_data_quality_ruleset_evaluation_runs )
StartDataQualityRuleRecommendationRun アクション (Python: start_data_quality_rule_recommendation_run )
CancelDataQualityRuleRecommendationRun アクション (Python: cancel_data_quality_rule_recommendation_run )
GetDataQualityRuleRecommendationRun アクション (Python: get_data_quality_rule_recommendation_run )
ListDataQualityRuleRecommendationRuns アクション (Python: list_data_quality_rule_recommendation_runs )
GetDataQualityResult アクション (Python: get_data_quality_result)
BatchGetDataQualityResult アクション (Python: batch_get_data_quality_result)
ListDataQualityResults アクション (Python: list_data_quality_results)
CreateDataQualityRuleset アクション (Python: create_data_quality_ruleset)
DeleteDataQualityRuleset アクション (Python: delete_data_quality_ruleset)
GetDataQualityRuleset アクション (Python: get_data_quality_ruleset)
ListDataQualityRulesets アクション (Python: list_data_quality_rulesets)
UpdateDataQualityRuleset アクション (Python: update_data_quality_ruleset)
ListDataQualityStatistics アクション (Python: list_data_quality_statistics)
BatchPutDataQualityStatisticAnnotation アクション (Python: batch_put_data_quality_statistic_annotation )
GetDataQualityModelResult アクション (Python: get_data_quality_model_result)
ListDataQualityStatisticAnnotations アクション (Python: list_data_quality_statistic_annotations)
PutDataQualityProfileAnnotation アクション (Python: put_data_quality_profile_annotation)
StartDataQualityRulesetEvaluationRun アクション (Python: start_data_quality_ruleset_evaluation_run )
ルールセット定義 (推奨または独自の) を取得したら、このオペレーションを呼び出して、データソース (AWS Glue テーブル) に対してルールセットを評価します。評価では、 で取得できる結果が計算されますGetDataQualityResult
API。
リクエスト
-
DataSource
– 必須: DataSource オブジェクト。この実行に関連付けられたデータソース (AWS Glue テーブル)。
-
Role
– 必須: UTF-8 文字列。実行の結果を暗号化するために提供される IAM ロール。
-
NumberOfWorkers
– 数値 (整数)。実行に使用される
G.1X
ワーカーの数。デフォルトは 5 です。 -
Timeout
- 数値 (整数)。1 以上。実行のタイムアウト (分)。これは、実行が終了済みになって
TIMEOUT
ステータスに入るまでに、その実行でリソースを消費できる最大時間です。デフォルト値は 2,880 分 (48 時間) です。 -
ClientToken
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。冪等性のために使用され、同じリソースの複数のインスタンスを作成または開始しないように、ランダム ID ( などUUID) に設定することをお勧めします。
-
AdditionalRunOptions
– DataQualityEvaluationRunAdditionalRunOptions オブジェクト。評価実行で指定できるその他の実行オプション。
-
RulesetNames
– 必須: UTF-8 個の文字列の配列。1~10 個の文字列。ルールセット名のリスト。
-
AdditionalDataSources
– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1~255 バイト長で、 と一致しますSingle-line string pattern。
各値は DataSource オブジェクトです。
評価実行で指定できる他のデータソースへの参照文字列のマップ。
レスポンス
-
RunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
エラー
InvalidInputException
EntityNotFoundException
OperationTimeoutException
InternalServiceException
ConflictException
CancelDataQualityRulesetEvaluationRun アクション (Python: cancel_data_quality_ruleset_evaluation_run )
ルールセットがデータソースに対して評価されている実行をキャンセルします。
リクエスト
-
RunId
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
レスポンス
応答パラメータはありません。
エラー
EntityNotFoundException
InvalidInputException
OperationTimeoutException
InternalServiceException
GetDataQualityRulesetEvaluationRun アクション (Python: get_data_quality_ruleset_evaluation_run)
ルールセットがデータソースに対して評価される特定の実行を取得します。
リクエスト
-
RunId
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
レスポンス
-
RunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
-
DataSource
– DataSource オブジェクト。この評価実行に関連付けられたデータソース ( AWS Glue テーブル)。
-
Role
– UTF-8 文字列。実行の結果を暗号化するために提供される IAM ロール。
-
NumberOfWorkers
– 数値 (整数)。実行に使用される
G.1X
ワーカーの数。デフォルトは 5 です。 -
Timeout
- 数値 (整数)。1 以上。実行のタイムアウト (分)。これは、実行が終了済みになって
TIMEOUT
ステータスに入るまでに、その実行でリソースを消費できる最大時間です。デフォルト値は 2,880 分 (48 時間) です。 -
AdditionalRunOptions
– DataQualityEvaluationRunAdditionalRunOptions オブジェクト。評価実行で指定できるその他の実行オプション。
-
Status
– UTF-8 文字列 (有効な値:STARTING
|RUNNING
| |STOPPING
|STOPPED
SUCCEEDED
|FAILED
|TIMEOUT
)。この実行のステータス。
-
ErrorString
– UTF-8 文字列。実行に関連付けられているエラー文字列。
-
StartedOn
– タイムスタンプ。この実行の開始日時。
-
LastModifiedOn
– タイムスタンプ。タイムスタンプ。このデータ品質ルールの推奨実行が変更された最後の時間ポイント。
-
CompletedOn
– タイムスタンプ。この実行の完了日時。
-
ExecutionTime
– 数値 (整数)。実行でリソースを消費した時間 (秒)。
-
RulesetNames
– UTF-8 個の文字列の配列。1~10 個の文字列。実行用のルールセット名のリスト。現在、このパラメータは 1 つのルールセット名しかとりません。
-
ResultIds
– UTF-8 個の文字列の配列。1~10 個の文字列。実行IDsのデータ品質結果の結果のリスト。
-
AdditionalDataSources
– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1~255 バイト長で、 と一致しますSingle-line string pattern。
各値は DataSource オブジェクトです。
評価実行で指定できる他のデータソースへの参照文字列のマップ。
エラー
EntityNotFoundException
InvalidInputException
OperationTimeoutException
InternalServiceException
ListDataQualityRulesetEvaluationRuns アクション (Python: list_data_quality_ruleset_evaluation_runs )
フィルタリング基準を満たすすべての実行が一覧表示され、ルールセットがデータソースに対して評価されます。
リクエスト
-
Filter
– DataQualityRulesetEvaluationRunFilter オブジェクト。フィルタリング基準。
-
NextToken
– UTF-8 文字列。結果をオフセットするページ分割されたトークン。
-
MaxResults
– 1~1000 の数値 (整数)。返される結果の最大数。
応答
-
Runs
– DataQualityRulesetEvaluationRunDescription オブジェクトの配列。データ品質ルールセットの実行を表す
DataQualityRulesetEvaluationRunDescription
オブジェクトのリスト。 -
NextToken
– UTF-8 文字列。ページ分割トークン (さらに結果がある場合)。
エラー
InvalidInputException
OperationTimeoutException
InternalServiceException
StartDataQualityRuleRecommendationRun アクション (Python: start_data_quality_rule_recommendation_run )
どのルールを書き込むべきかわからないときにルールを生成するために使用されるレコメンデーション実行を開始します。 AWS Glue Data Quality はデータを分析し、潜在的なルールセットのレコメンデーションを作成します。その後、ルールセットをトリアージし、生成されたルールセットを好みに合わせて変更できます。
推奨事項の実行は、実行から 90 日後に自動的に削除されます。
リクエスト
Data Quality ルールのレコメンデーションリクエストのリクエスト。
-
DataSource
– 必須: DataSource オブジェクト。この実行に関連付けられたデータソース (AWS Glue テーブル)。
-
Role
– 必須: UTF-8 文字列。実行の結果を暗号化するために提供される IAM ロール。
-
NumberOfWorkers
– 数値 (整数)。実行に使用される
G.1X
ワーカーの数。デフォルトは 5 です。 -
Timeout
- 数値 (整数)。1 以上。実行のタイムアウト (分)。これは、実行が終了済みになって
TIMEOUT
ステータスに入るまでに、その実行でリソースを消費できる最大時間です。デフォルト値は 2,880 分 (48 時間) です。 -
CreatedRulesetName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。ルールセットの名前。
-
DataQualitySecurityConfiguration
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質暗号化オプションを使用して作成されたセキュリティ設定の名前。
-
ClientToken
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。冪等性のために使用され、同じリソースの複数のインスタンスを作成または開始しないように、ランダム ID ( などUUID) に設定することをお勧めします。
レスポンス
-
RunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
エラー
InvalidInputException
OperationTimeoutException
InternalServiceException
ConflictException
CancelDataQualityRuleRecommendationRun アクション (Python: cancel_data_quality_rule_recommendation_run )
ルールの生成に使用されていた指定の推奨実行をキャンセルします。
リクエスト
-
RunId
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
レスポンス
応答パラメータはありません。
エラー
EntityNotFoundException
InvalidInputException
OperationTimeoutException
InternalServiceException
GetDataQualityRuleRecommendationRun アクション (Python: get_data_quality_rule_recommendation_run )
ルールの生成に使用された指定の推奨実行を取得します。
リクエスト
-
RunId
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
レスポンス
Data Quality ルールのレコメンデーション実行のレスポンス。
-
RunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
-
DataSource
– DataSource オブジェクト。この実行に関連付けられたデータソース ( AWS Glue テーブル)。
-
Role
– UTF-8 文字列。実行の結果を暗号化するために提供される IAM ロール。
-
NumberOfWorkers
– 数値 (整数)。実行に使用される
G.1X
ワーカーの数。デフォルトは 5 です。 -
Timeout
- 数値 (整数)。1 以上。実行のタイムアウト (分)。これは、実行が終了済みになって
TIMEOUT
ステータスに入るまでに、その実行でリソースを消費できる最大時間です。デフォルト値は 2,880 分 (48 時間) です。 -
Status
– UTF-8 文字列 (有効な値:STARTING
|RUNNING
| |STOPPING
|STOPPED
SUCCEEDED
|FAILED
|TIMEOUT
)。この実行のステータス。
-
ErrorString
– UTF-8 文字列。実行に関連付けられているエラー文字列。
-
StartedOn
– タイムスタンプ。この実行の開始日時。
-
LastModifiedOn
– タイムスタンプ。タイムスタンプ。このデータ品質ルールの推奨実行が変更された最後の時間ポイント。
-
CompletedOn
– タイムスタンプ。この実行の完了日時。
-
ExecutionTime
– 数値 (整数)。実行でリソースを消費した時間 (秒)。
-
RecommendedRuleset
– UTF-8 文字列、1~65536 バイト長。開始ルールの推奨実行が完了すると、推奨ルールセット (ルールのセット) が作成されます。このメンバーには、データ品質定義言語 (DQDL) 形式のルールがあります。
-
CreatedRulesetName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。実行によって作成されたルールセットの名前。
-
DataQualitySecurityConfiguration
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質暗号化オプションを使用して作成されたセキュリティ設定の名前。
エラー
EntityNotFoundException
InvalidInputException
OperationTimeoutException
InternalServiceException
ListDataQualityRuleRecommendationRuns アクション (Python: list_data_quality_rule_recommendation_runs )
フィルタリング基準を満たす推奨実行を一覧表示します。
リクエスト
-
Filter
– DataQualityRuleRecommendationRunFilter オブジェクト。フィルタリング基準。
-
NextToken
– UTF-8 文字列。結果をオフセットするページ分割されたトークン。
-
MaxResults
– 1~1000 の数値 (整数)。返される結果の最大数。
応答
-
Runs
– DataQualityRuleRecommendationRunDescription オブジェクトの配列。DataQualityRuleRecommendationRunDescription
オブジェクトのリスト。 -
NextToken
– UTF-8 文字列。ページ分割トークン (さらに結果がある場合)。
エラー
InvalidInputException
OperationTimeoutException
InternalServiceException
GetDataQualityResult アクション (Python: get_data_quality_result)
データ品質ルール評価の結果を取得します。
リクエスト
-
ResultId
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に対する一意の結果 ID。
レスポンス
データ品質結果のレスポンス。
-
ResultId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に対する一意の結果 ID。
-
ProfileId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果のプロファイル ID。
-
Score
– 数値 (double)。1.0 以下。集計されたデータ品質のスコア。ルールの合計数に対する合格ルールの比率を表します。
-
DataSource
– DataSource オブジェクト。データ品質結果に関連付けられたテーブル (存在する場合)。
-
RulesetName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたルールセットの名前。
-
EvaluationContext
– UTF-8 文字列。AWS Glue Studio のジョブのコンテキストでは、キャンバス内の各ノードには通常、何らかの名前が割り当てられ、データ品質ノードには名前が割り当てられます。複数のノードの場合、
evaluationContext
でノードを区別できます。 -
StartedOn
– タイムスタンプ。このデータ品質結果の実行が開始された日時。
-
CompletedOn
– タイムスタンプ。このデータ品質結果の実行が完了した日時。
-
JobName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたジョブ名 (存在する場合)。
-
JobRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたジョブ実行 ID (存在する場合)。
-
RulesetEvaluationRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。ルールセット評価に関連付けられた一意の実行 ID。
-
RuleResults
– DataQualityRuleResult オブジェクトの配列。構造 2000 個以下。各ルールの結果を表す
DataQualityRuleResult
オブジェクトのリスト。 -
AnalyzerResults
– DataQualityAnalyzerResult オブジェクトの配列。構造 2000 個以下。各アナライザーの結果を表す
DataQualityAnalyzerResult
オブジェクトのリスト。 -
Observations
– DataQualityObservation オブジェクトの配列。構造 50 個以下。DataQualityObservation
ルールとアナライザーを評価した後に生成された観測値を表すオブジェクトのリスト。
エラー
InvalidInputException
OperationTimeoutException
InternalServiceException
EntityNotFoundException
BatchGetDataQualityResult アクション (Python: batch_get_data_quality_result)
指定された結果 のデータ品質結果のリストを取得しますIDs。
リクエスト
-
ResultIds
– 必須: UTF-8 個の文字列の配列。1~100 個の文字列。データ品質結果IDsの一意の結果のリスト。
レスポンス
-
Results
– 必須: DataQualityResult オブジェクトの配列。データ品質結果を表す
DataQualityResult
オブジェクトのリスト。 -
ResultsNotFound
– UTF-8 個の文字列の配列。1~100 個の文字列。結果が見つからなかったIDs結果のリスト。
エラー
InvalidInputException
OperationTimeoutException
InternalServiceException
ListDataQualityResults アクション (Python: list_data_quality_results)
アカウントのすべてのデータ品質実行結果を返します。
リクエスト
-
Filter
– DataQualityResultFilterCriteria オブジェクト。フィルタリング基準。
-
NextToken
– UTF-8 文字列。結果をオフセットするページ分割されたトークン。
-
MaxResults
– 1~1000 の数値 (整数)。返される結果の最大数。
レスポンス
-
Results
– 必須: DataQualityResultDescription オブジェクトの配列。DataQualityResultDescription
オブジェクトのリスト。 -
NextToken
– UTF-8 文字列。ページ分割トークン (さらに結果がある場合)。
エラー
InvalidInputException
OperationTimeoutException
InternalServiceException
CreateDataQualityRuleset アクション (Python: create_data_quality_ruleset)
指定した AWS Glue テーブルに適用されるルールを使用して、データ品質DQDLルールセットを作成します。
データ品質定義言語 () を使用してルールセットを作成しますDQDL。詳細については、「 デ AWS Glue ベロッパーガイド」を参照してください。
リクエスト
データ品質ルールセットを作成するリクエスト。
-
Name
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質ルールセットに対する一意の名前。
-
Description
– 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。データ品質ルールセットの説明。
-
Ruleset
– 必須: UTF-8 文字列、1~65536 バイト長。データ品質定義言語 (DQDL) ルールセット。詳細については、「 デ AWS Glue ベロッパーガイド」を参照してください。
-
Tags
– キーと値のペアのマップ配列。50 ペア以下。各キーは UTF-8 文字列で、1~128 バイト長です。
各値は UTF-8 文字列で、256 バイト長以下です。
データ品質ルールセットに適用されるタグのリスト。
-
TargetTable
– DataQualityTargetTable オブジェクト。データ品質ルールセットに関連付けられたターゲットテーブル。
-
RecommendationRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。推奨実行に対する一意の実行 ID。
-
DataQualitySecurityConfiguration
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質暗号化オプションを使用して作成されたセキュリティ設定の名前。
-
ClientToken
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。冪等性のために使用され、同じリソースの複数のインスタンスを作成または開始しないように、ランダム ID ( などUUID) に設定することをお勧めします。
レスポンス
-
Name
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質ルールセットに対する一意の名前。
エラー
InvalidInputException
AlreadyExistsException
OperationTimeoutException
InternalServiceException
ResourceNumberLimitExceededException
DeleteDataQualityRuleset アクション (Python: delete_data_quality_ruleset)
データ品質ルールセットを削除します。
リクエスト
-
Name
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質ルールセットの名前。
レスポンス
応答パラメータはありません。
エラー
EntityNotFoundException
InvalidInputException
OperationTimeoutException
InternalServiceException
GetDataQualityRuleset アクション (Python: get_data_quality_ruleset)
既存のルールセットを識別子または名前で返します。
リクエスト
-
Name
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。ルールセットの名前。
レスポンス
データ品質ルールセットのレスポンスを返します。
-
Name
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。ルールセットの名前。
-
Description
– 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。ルールセットの説明。
-
Ruleset
– UTF-8 文字列、1~65536 バイト長。データ品質定義言語 (DQDL) ルールセット。詳細については、「 デ AWS Glue ベロッパーガイド」を参照してください。
-
TargetTable
– DataQualityTargetTable オブジェクト。ターゲットテーブルの名前およびデータベース名。
-
CreatedOn
– タイムスタンプ。タイムスタンプ。このデータ品質ルールセットが作成された日時。
-
LastModifiedOn
– タイムスタンプ。タイムスタンプ。このデータ品質ルールセットが変更された最後の時間ポイント。
-
RecommendationRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。推奨実行からルールセットが作成されると、この 2 つをリンクさせるためにこの実行 ID が生成されます。
-
DataQualitySecurityConfiguration
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質暗号化オプションを使用して作成されたセキュリティ設定の名前。
エラー
EntityNotFoundException
InvalidInputException
OperationTimeoutException
InternalServiceException
ListDataQualityRulesets アクション (Python: list_data_quality_rulesets)
指定された AWS Glue テーブルのリストのルールセットのページ分割されたリストを返します。
リクエスト
-
NextToken
– UTF-8 文字列。結果をオフセットするページ分割されたトークン。
-
MaxResults
– 1~1000 の数値 (整数)。返される結果の最大数。
-
Filter
– DataQualityRulesetFilterCriteria オブジェクト。フィルタリング基準。
-
Tags
– キーと値のペアのマップ配列。50 ペア以下。各キーは UTF-8 文字列で、1~128 バイト長です。
各値は UTF-8 文字列で、256 バイト長以下です。
キーと値のペアタグのリスト。
応答
-
Rulesets
– DataQualityRulesetListDetails オブジェクトの配列。指定された AWS Glue テーブルのリストのルールセットのページ分割されたリスト。
-
NextToken
– UTF-8 文字列。ページ分割トークン (さらに結果がある場合)。
エラー
EntityNotFoundException
InvalidInputException
OperationTimeoutException
InternalServiceException
UpdateDataQualityRuleset アクション (Python: update_data_quality_ruleset)
指定したデータ品質ルールセットを更新します。
リクエスト
-
Name
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質ルールセットの名前。
-
Description
– 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。ルールセットの説明。
-
Ruleset
– UTF-8 文字列、1~65536 バイト長。データ品質定義言語 (DQDL) ルールセット。詳細については、「 デ AWS Glue ベロッパーガイド」を参照してください。
レスポンス
-
Name
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質ルールセットの名前。
-
Description
– 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。ルールセットの説明。
-
Ruleset
– UTF-8 文字列、1~65536 バイト長。データ品質定義言語 (DQDL) ルールセット。詳細については、「 デ AWS Glue ベロッパーガイド」を参照してください。
エラー
EntityNotFoundException
AlreadyExistsException
IdempotentParameterMismatchException
InvalidInputException
OperationTimeoutException
InternalServiceException
ResourceNumberLimitExceededException
ListDataQualityStatistics アクション (Python: list_data_quality_statistics)
データ品質統計のリストを取得します。
リクエスト
-
StatisticId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。統計 ID。
-
ProfileId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。プロファイル ID。
-
TimestampFilter
– TimestampFilter オブジェクト。タイムスタンプフィルター。
-
MaxResults
– 1~1000 の数値 (整数)。このリクエストで返す結果の最大数。
-
NextToken
– UTF-8 文字列。結果の次のページをリクエストするためのページ割りトークン。
応答
-
Statistics
– StatisticSummary オブジェクトの配列。StatisticSummaryList
。 -
NextToken
– UTF-8 文字列。結果の次のページをリクエストするためのページ割りトークン。
エラー
EntityNotFoundException
InvalidInputException
InternalServiceException
TimestampFilter 構造
タイムスタンプフィルター。
フィールド
-
RecordedBefore
– タイムスタンプ。統計を結果に含める前のタイムスタンプ。
-
RecordedAfter
– タイムスタンプ。統計を結果に含める必要があるタイムスタンプ。
CreateDataQualityRulesetRequest 構造
データ品質ルールセットを作成するリクエスト。
フィールド
-
Name
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質ルールセットに対する一意の名前。
-
Description
– 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。データ品質ルールセットの説明。
-
Ruleset
– 必須: UTF-8 文字列、1~65536 バイト長。データ品質定義言語 (DQDL) ルールセット。詳細については、「 デ AWS Glue ベロッパーガイド」を参照してください。
-
Tags
– キーと値のペアのマップ配列。50 ペア以下。各キーは UTF-8 文字列で、1~128 バイト長です。
各値は UTF-8 文字列で、256 バイト長以下です。
データ品質ルールセットに適用されるタグのリスト。
-
TargetTable
– DataQualityTargetTable オブジェクト。データ品質ルールセットに関連付けられたターゲットテーブル。
-
RecommendationRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。推奨実行に対する一意の実行 ID。
-
DataQualitySecurityConfiguration
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質暗号化オプションを使用して作成されたセキュリティ設定の名前。
-
ClientToken
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。冪等性のために使用され、同じリソースの複数のインスタンスを作成または開始しないように、ランダム ID ( などUUID) に設定することをお勧めします。
GetDataQualityRulesetResponse 構造
データ品質ルールセットのレスポンスを返します。
フィールド
-
Name
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。ルールセットの名前。
-
Description
– 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。ルールセットの説明。
-
Ruleset
– UTF-8 文字列、1~65536 バイト長。データ品質定義言語 (DQDL) ルールセット。詳細については、「 デ AWS Glue ベロッパーガイド」を参照してください。
-
TargetTable
– DataQualityTargetTable オブジェクト。ターゲットテーブルの名前およびデータベース名。
-
CreatedOn
– タイムスタンプ。タイムスタンプ。このデータ品質ルールセットが作成された日時。
-
LastModifiedOn
– タイムスタンプ。タイムスタンプ。このデータ品質ルールセットが変更された最後の時間ポイント。
-
RecommendationRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。推奨実行からルールセットが作成されると、この 2 つをリンクさせるためにこの実行 ID が生成されます。
-
DataQualitySecurityConfiguration
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質暗号化オプションを使用して作成されたセキュリティ設定の名前。
GetDataQualityResultResponse 構造
データ品質結果のレスポンス。
フィールド
-
ResultId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に対する一意の結果 ID。
-
ProfileId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果のプロファイル ID。
-
Score
– 数値 (double)。1.0 以下。集計されたデータ品質のスコア。ルールの合計数に対する合格ルールの比率を表します。
-
DataSource
– DataSource オブジェクト。データ品質結果に関連付けられたテーブル (存在する場合)。
-
RulesetName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたルールセットの名前。
-
EvaluationContext
– UTF-8 文字列。AWS Glue Studio のジョブのコンテキストでは、キャンバス内の各ノードには通常、何らかの名前が割り当てられ、データ品質ノードには名前が割り当てられます。複数のノードの場合、
evaluationContext
でノードを区別できます。 -
StartedOn
– タイムスタンプ。このデータ品質結果の実行が開始された日時。
-
CompletedOn
– タイムスタンプ。このデータ品質結果の実行が完了した日時。
-
JobName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたジョブ名 (存在する場合)。
-
JobRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質結果に関連付けられたジョブ実行 ID (存在する場合)。
-
RulesetEvaluationRunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。ルールセット評価に関連付けられた一意の実行 ID。
-
RuleResults
– DataQualityRuleResult オブジェクトの配列。構造 2000 個以下。各ルールの結果を表す
DataQualityRuleResult
オブジェクトのリスト。 -
AnalyzerResults
– DataQualityAnalyzerResult オブジェクトの配列。構造 2000 個以下。各アナライザーの結果を表す
DataQualityAnalyzerResult
オブジェクトのリスト。 -
Observations
– DataQualityObservation オブジェクトの配列。構造 50 個以下。DataQualityObservation
ルールとアナライザーを評価した後に生成された観測値を表すオブジェクトのリスト。
StartDataQualityRuleRecommendationRunRequest 構造
Data Quality ルールのレコメンデーションリクエストのリクエスト。
フィールド
-
DataSource
– 必須: DataSource オブジェクト。この実行に関連付けられたデータソース (AWS Glue テーブル)。
-
Role
– 必須: UTF-8 文字列。実行の結果を暗号化するために提供される IAM ロール。
-
NumberOfWorkers
– 数値 (整数)。実行に使用される
G.1X
ワーカーの数。デフォルトは 5 です。 -
Timeout
- 数値 (整数)。1 以上。実行のタイムアウト (分)。これは、実行が終了済みになって
TIMEOUT
ステータスに入るまでに、その実行でリソースを消費できる最大時間です。デフォルト値は 2,880 分 (48 時間) です。 -
CreatedRulesetName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。ルールセットの名前。
-
DataQualitySecurityConfiguration
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質暗号化オプションを使用して作成されたセキュリティ設定の名前。
-
ClientToken
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。冪等性のために使用され、同じリソースの複数のインスタンスを作成または開始しないように、ランダム ID ( などUUID) に設定することをお勧めします。
GetDataQualityRuleRecommendationRunResponse 構造
Data Quality ルールのレコメンデーション実行のレスポンス。
フィールド
-
RunId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。この実行に関連付けられた一意の実行識別子。
-
DataSource
– DataSource オブジェクト。この実行に関連付けられたデータソース ( AWS Glue テーブル)。
-
Role
– UTF-8 文字列。実行の結果を暗号化するために提供される IAM ロール。
-
NumberOfWorkers
– 数値 (整数)。実行に使用される
G.1X
ワーカーの数。デフォルトは 5 です。 -
Timeout
- 数値 (整数)。1 以上。実行のタイムアウト (分)。これは、実行が終了済みになって
TIMEOUT
ステータスに入るまでに、その実行でリソースを消費できる最大時間です。デフォルト値は 2,880 分 (48 時間) です。 -
Status
– UTF-8 文字列 (有効な値:STARTING
|RUNNING
| |STOPPING
|STOPPED
SUCCEEDED
|FAILED
|TIMEOUT
)。この実行のステータス。
-
ErrorString
– UTF-8 文字列。実行に関連付けられているエラー文字列。
-
StartedOn
– タイムスタンプ。この実行の開始日時。
-
LastModifiedOn
– タイムスタンプ。タイムスタンプ。このデータ品質ルールの推奨実行が変更された最後の時間ポイント。
-
CompletedOn
– タイムスタンプ。この実行の完了日時。
-
ExecutionTime
– 数値 (整数)。実行でリソースを消費した時間 (秒)。
-
RecommendedRuleset
– UTF-8 文字列、1~65536 バイト長。開始ルールの推奨実行が完了すると、推奨ルールセット (ルールのセット) が作成されます。このメンバーには、データ品質定義言語 (DQDL) 形式のルールがあります。
-
CreatedRulesetName
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。実行によって作成されたルールセットの名前。
-
DataQualitySecurityConfiguration
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。データ品質暗号化オプションを使用して作成されたセキュリティ設定の名前。
BatchPutDataQualityStatisticAnnotation アクション (Python: batch_put_data_quality_statistic_annotation )
特定のデータ品質統計のデータポイントに経時的に注釈を付けます。
リクエスト
-
InclusionAnnotations
– 必須: DatapointInclusionAnnotation オブジェクトの配列。のリスト
DatapointInclusionAnnotation
。 -
ClientToken
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。クライアントトークン。
応答
-
FailedInclusionAnnotations
– AnnotationError オブジェクトの配列。のリスト
AnnotationError
。
エラー
EntityNotFoundException
InvalidInputException
InternalServiceException
ResourceNumberLimitExceededException
GetDataQualityModel アクション (Python: get_data_quality_model)
モデルのトレーニングステータスと詳細情報 (CompletedOn、 StartedOn、) を取得します FailureReason。
リクエスト
-
StatisticId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。統計 ID。
-
ProfileId
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。プロファイル ID。
レスポンス
-
Status
– UTF-8 文字列 (有効な値:RUNNING
|SUCCEEDED
|FAILED
)。データ品質モデルのトレーニングステータス。
-
StartedOn
– タイムスタンプ。データ品質モデルトレーニングが開始されたときのタイムスタンプ。
-
CompletedOn
– タイムスタンプ。データ品質モデルトレーニングが完了したときのタイムスタンプ。
-
FailureReason
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。トレーニング失敗の理由。
エラー
EntityNotFoundException
InvalidInputException
OperationTimeoutException
InternalServiceException
GetDataQualityModelResult アクション (Python: get_data_quality_model_result)
特定のプロファイル ID の統計の予測を取得します。
リクエスト
-
StatisticId
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。統計 ID。
-
ProfileId
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。プロファイル ID。
レスポンス
-
CompletedOn
– タイムスタンプ。データ品質モデルトレーニングが完了したときのタイムスタンプ。
-
Model
– StatisticModelResult オブジェクトの配列。のリスト
StatisticModelResult
エラー
EntityNotFoundException
InvalidInputException
OperationTimeoutException
InternalServiceException
ListDataQualityStatisticAnnotations アクション (Python: list_data_quality_statistic_annotations)
データ品質統計の注釈を取得します。
リクエスト
-
StatisticId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。統計 ID。
-
ProfileId
– UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。プロファイル ID。
-
TimestampFilter
– TimestampFilter オブジェクト。タイムスタンプフィルター。
-
MaxResults
– 1~1000 の数値 (整数)。このリクエストで返す結果の最大数。
-
NextToken
– UTF-8 文字列。次の結果セットを取得するためのページ割りトークン。
応答
-
Annotations
– StatisticAnnotation オブジェクトの配列。統計
StatisticAnnotation
に適用された のリスト -
NextToken
– UTF-8 文字列。次の結果セットを取得するためのページ割りトークン。
エラー
InvalidInputException
InternalServiceException
PutDataQualityProfileAnnotation アクション (Python: put_data_quality_profile_annotation)
プロファイルのすべてのデータポイントに注釈を付けます。
リクエスト
-
ProfileId
– 必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern。注釈を付けるデータ品質モニタリングプロファイルの ID。
-
InclusionAnnotation
– 必須: UTF-8 文字列 (有効な値:INCLUDE
|EXCLUDE
)。プロファイルに適用する包含注釈値。
レスポンス
応答パラメータはありません。
エラー
EntityNotFoundException
InvalidInputException
InternalServiceException