Skip to content

Commit fd0d898

Browse files
author
awstools
committed
feat(client-glue): Adds observation and analyzer support to the GetDataQualityResult and BatchGetDataQualityResult APIs.
1 parent 77b3170 commit fd0d898

File tree

11 files changed

+615
-169
lines changed

11 files changed

+615
-169
lines changed

clients/client-glue/src/commands/BatchGetDataQualityResultCommand.ts

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,33 @@ export interface BatchGetDataQualityResultCommandOutput extends BatchGetDataQual
8585
* // },
8686
* // },
8787
* // ],
88+
* // AnalyzerResults: [ // DataQualityAnalyzerResults
89+
* // { // DataQualityAnalyzerResult
90+
* // Name: "STRING_VALUE",
91+
* // Description: "STRING_VALUE",
92+
* // EvaluationMessage: "STRING_VALUE",
93+
* // EvaluatedMetrics: {
94+
* // "<keys>": Number("double"),
95+
* // },
96+
* // },
97+
* // ],
98+
* // Observations: [ // DataQualityObservations
99+
* // { // DataQualityObservation
100+
* // Description: "STRING_VALUE",
101+
* // MetricBasedObservation: { // MetricBasedObservation
102+
* // MetricName: "STRING_VALUE",
103+
* // MetricValues: { // DataQualityMetricValues
104+
* // ActualValue: Number("double"),
105+
* // ExpectedValue: Number("double"),
106+
* // LowerLimit: Number("double"),
107+
* // UpperLimit: Number("double"),
108+
* // },
109+
* // NewRules: [ // NewRules
110+
* // "STRING_VALUE",
111+
* // ],
112+
* // },
113+
* // },
114+
* // ],
88115
* // },
89116
* // ],
90117
* // ResultsNotFound: [ // DataQualityResultIds

clients/client-glue/src/commands/CreateCustomEntityTypeCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ import {
1515
} from "@smithy/types";
1616

1717
import { GlueClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GlueClient";
18-
import { CreateCustomEntityTypeRequest, CreateCustomEntityTypeResponse } from "../models/models_0";
18+
import { CreateCustomEntityTypeRequest } from "../models/models_0";
19+
import { CreateCustomEntityTypeResponse } from "../models/models_1";
1920
import { de_CreateCustomEntityTypeCommand, se_CreateCustomEntityTypeCommand } from "../protocols/Aws_json1_1";
2021

2122
/**

clients/client-glue/src/commands/GetDataQualityResultCommand.ts

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,33 @@ export interface GetDataQualityResultCommandOutput extends GetDataQualityResultR
8181
* // },
8282
* // },
8383
* // ],
84+
* // AnalyzerResults: [ // DataQualityAnalyzerResults
85+
* // { // DataQualityAnalyzerResult
86+
* // Name: "STRING_VALUE",
87+
* // Description: "STRING_VALUE",
88+
* // EvaluationMessage: "STRING_VALUE",
89+
* // EvaluatedMetrics: {
90+
* // "<keys>": Number("double"),
91+
* // },
92+
* // },
93+
* // ],
94+
* // Observations: [ // DataQualityObservations
95+
* // { // DataQualityObservation
96+
* // Description: "STRING_VALUE",
97+
* // MetricBasedObservation: { // MetricBasedObservation
98+
* // MetricName: "STRING_VALUE",
99+
* // MetricValues: { // DataQualityMetricValues
100+
* // ActualValue: Number("double"),
101+
* // ExpectedValue: Number("double"),
102+
* // LowerLimit: Number("double"),
103+
* // UpperLimit: Number("double"),
104+
* // },
105+
* // NewRules: [ // NewRules
106+
* // "STRING_VALUE",
107+
* // ],
108+
* // },
109+
* // },
110+
* // ],
84111
* // };
85112
*
86113
* ```

clients/client-glue/src/commands/GetSecurityConfigurationsCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ import {
1515
} from "@smithy/types";
1616

1717
import { GlueClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GlueClient";
18-
import { GetSecurityConfigurationsRequest, GetSecurityConfigurationsResponse } from "../models/models_1";
18+
import { GetSecurityConfigurationsRequest } from "../models/models_1";
19+
import { GetSecurityConfigurationsResponse } from "../models/models_2";
1920
import { de_GetSecurityConfigurationsCommand, se_GetSecurityConfigurationsCommand } from "../protocols/Aws_json1_1";
2021

2122
/**

clients/client-glue/src/commands/GetSessionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import {
1515
} from "@smithy/types";
1616

1717
import { GlueClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GlueClient";
18-
import { GetSessionRequest, GetSessionResponse } from "../models/models_1";
18+
import { GetSessionRequest, GetSessionResponse } from "../models/models_2";
1919
import { de_GetSessionCommand, se_GetSessionCommand } from "../protocols/Aws_json1_1";
2020

2121
/**

clients/client-glue/src/commands/GetStatementCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ import {
1515
} from "@smithy/types";
1616

1717
import { GlueClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GlueClient";
18-
import { GetStatementRequest } from "../models/models_1";
19-
import { GetStatementResponse } from "../models/models_2";
18+
import { GetStatementRequest, GetStatementResponse } from "../models/models_2";
2019
import { de_GetStatementCommand, se_GetStatementCommand } from "../protocols/Aws_json1_1";
2120

2221
/**

clients/client-glue/src/models/models_0.ts

Lines changed: 114 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -2296,6 +2296,36 @@ export interface BatchGetDataQualityResultRequest {
22962296
ResultIds: string[] | undefined;
22972297
}
22982298

2299+
/**
2300+
* @public
2301+
* <p>Describes the result of the evaluation of a data quality analyzer.</p>
2302+
*/
2303+
export interface DataQualityAnalyzerResult {
2304+
/**
2305+
* @public
2306+
* <p>The name of the data quality analyzer.</p>
2307+
*/
2308+
Name?: string;
2309+
2310+
/**
2311+
* @public
2312+
* <p>A description of the data quality analyzer.</p>
2313+
*/
2314+
Description?: string;
2315+
2316+
/**
2317+
* @public
2318+
* <p>An evaluation message.</p>
2319+
*/
2320+
EvaluationMessage?: string;
2321+
2322+
/**
2323+
* @public
2324+
* <p>A map of metrics associated with the evaluation of the analyzer.</p>
2325+
*/
2326+
EvaluatedMetrics?: Record<string, number>;
2327+
}
2328+
22992329
/**
23002330
* @public
23012331
* <p>The database and table in the Glue Data Catalog that is used for input or output data.</p>
@@ -2354,6 +2384,78 @@ export interface DataSource {
23542384
GlueTable: GlueTable | undefined;
23552385
}
23562386

2387+
/**
2388+
* @public
2389+
* <p>Describes the data quality metric value according to the analysis of historical data.</p>
2390+
*/
2391+
export interface DataQualityMetricValues {
2392+
/**
2393+
* @public
2394+
* <p>The actual value of the data quality metric.</p>
2395+
*/
2396+
ActualValue?: number;
2397+
2398+
/**
2399+
* @public
2400+
* <p>The expected value of the data quality metric according to the analysis of historical data.</p>
2401+
*/
2402+
ExpectedValue?: number;
2403+
2404+
/**
2405+
* @public
2406+
* <p>The lower limit of the data quality metric value according to the analysis of historical data.</p>
2407+
*/
2408+
LowerLimit?: number;
2409+
2410+
/**
2411+
* @public
2412+
* <p>The upper limit of the data quality metric value according to the analysis of historical data.</p>
2413+
*/
2414+
UpperLimit?: number;
2415+
}
2416+
2417+
/**
2418+
* @public
2419+
* <p>Describes the metric based observation generated based on evaluated data quality metrics.</p>
2420+
*/
2421+
export interface MetricBasedObservation {
2422+
/**
2423+
* @public
2424+
* <p>The name of the data quality metric used for generating the observation.</p>
2425+
*/
2426+
MetricName?: string;
2427+
2428+
/**
2429+
* @public
2430+
* <p>An object of type <code>DataQualityMetricValues</code> representing the analysis of the data quality metric value.</p>
2431+
*/
2432+
MetricValues?: DataQualityMetricValues;
2433+
2434+
/**
2435+
* @public
2436+
* <p>A list of new data quality rules generated as part of the observation based on the data quality metric value.</p>
2437+
*/
2438+
NewRules?: string[];
2439+
}
2440+
2441+
/**
2442+
* @public
2443+
* <p>Describes the observation generated after evaluating the rules and analyzers.</p>
2444+
*/
2445+
export interface DataQualityObservation {
2446+
/**
2447+
* @public
2448+
* <p>A description of the data quality observation.</p>
2449+
*/
2450+
Description?: string;
2451+
2452+
/**
2453+
* @public
2454+
* <p>An object of type <code>MetricBasedObservation</code> representing the observation that is based on evaluated data quality metrics.</p>
2455+
*/
2456+
MetricBasedObservation?: MetricBasedObservation;
2457+
}
2458+
23572459
/**
23582460
* @public
23592461
* @enum
@@ -2476,6 +2578,18 @@ export interface DataQualityResult {
24762578
* <p>A list of <code>DataQualityRuleResult</code> objects representing the results for each rule. </p>
24772579
*/
24782580
RuleResults?: DataQualityRuleResult[];
2581+
2582+
/**
2583+
* @public
2584+
* <p>A list of <code>DataQualityAnalyzerResult</code> objects representing the results for each analyzer. </p>
2585+
*/
2586+
AnalyzerResults?: DataQualityAnalyzerResult[];
2587+
2588+
/**
2589+
* @public
2590+
* <p>A list of <code>DataQualityObservation</code> objects representing the observations generated after evaluating the rules and analyzers. </p>
2591+
*/
2592+
Observations?: DataQualityObservation[];
24792593
}
24802594

24812595
/**
@@ -9207,87 +9321,3 @@ export interface CreateCustomEntityTypeRequest {
92079321
*/
92089322
Tags?: Record<string, string>;
92099323
}
9210-
9211-
/**
9212-
* @public
9213-
*/
9214-
export interface CreateCustomEntityTypeResponse {
9215-
/**
9216-
* @public
9217-
* <p>The name of the custom pattern you created.</p>
9218-
*/
9219-
Name?: string;
9220-
}
9221-
9222-
/**
9223-
* @public
9224-
* <p>The same unique identifier was associated with two different records.</p>
9225-
*/
9226-
export class IdempotentParameterMismatchException extends __BaseException {
9227-
readonly name: "IdempotentParameterMismatchException" = "IdempotentParameterMismatchException";
9228-
readonly $fault: "client" = "client";
9229-
/**
9230-
* @public
9231-
* <p>A message describing the problem.</p>
9232-
*/
9233-
Message?: string;
9234-
/**
9235-
* @internal
9236-
*/
9237-
constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>) {
9238-
super({
9239-
name: "IdempotentParameterMismatchException",
9240-
$fault: "client",
9241-
...opts,
9242-
});
9243-
Object.setPrototypeOf(this, IdempotentParameterMismatchException.prototype);
9244-
this.Message = opts.Message;
9245-
}
9246-
}
9247-
9248-
/**
9249-
* @public
9250-
* <p>Two processes are trying to modify a resource simultaneously.</p>
9251-
*/
9252-
export class ConcurrentModificationException extends __BaseException {
9253-
readonly name: "ConcurrentModificationException" = "ConcurrentModificationException";
9254-
readonly $fault: "client" = "client";
9255-
/**
9256-
* @public
9257-
* <p>A message describing the problem.</p>
9258-
*/
9259-
Message?: string;
9260-
/**
9261-
* @internal
9262-
*/
9263-
constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>) {
9264-
super({
9265-
name: "ConcurrentModificationException",
9266-
$fault: "client",
9267-
...opts,
9268-
});
9269-
Object.setPrototypeOf(this, ConcurrentModificationException.prototype);
9270-
this.Message = opts.Message;
9271-
}
9272-
}
9273-
9274-
/**
9275-
* @public
9276-
* @enum
9277-
*/
9278-
export const Permission = {
9279-
ALL: "ALL",
9280-
ALTER: "ALTER",
9281-
CREATE_DATABASE: "CREATE_DATABASE",
9282-
CREATE_TABLE: "CREATE_TABLE",
9283-
DATA_LOCATION_ACCESS: "DATA_LOCATION_ACCESS",
9284-
DELETE: "DELETE",
9285-
DROP: "DROP",
9286-
INSERT: "INSERT",
9287-
SELECT: "SELECT",
9288-
} as const;
9289-
9290-
/**
9291-
* @public
9292-
*/
9293-
export type Permission = (typeof Permission)[keyof typeof Permission];

0 commit comments

Comments
 (0)