-
Notifications
You must be signed in to change notification settings - Fork 584
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-cleanrooms): Feature: New schemaStatusDetails field to th…
…e existing Schema object that displays a status on Schema API responses to show whether a schema is queryable or not. New BatchGetSchemaAnalysisRule API to retrieve multiple schemaAnalysisRules using a single API call.
- Loading branch information
awstools
committed
Apr 4, 2024
1 parent
36c6750
commit 30e75ea
Showing
10 changed files
with
898 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
178 changes: 178 additions & 0 deletions
178
clients/client-cleanrooms/src/commands/BatchGetSchemaAnalysisRuleCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
// smithy-typescript generated code | ||
import { getEndpointPlugin } from "@smithy/middleware-endpoint"; | ||
import { getSerdePlugin } from "@smithy/middleware-serde"; | ||
import { Command as $Command } from "@smithy/smithy-client"; | ||
import { MetadataBearer as __MetadataBearer } from "@smithy/types"; | ||
|
||
import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient"; | ||
import { commonParams } from "../endpoint/EndpointParameters"; | ||
import { BatchGetSchemaAnalysisRuleInput, BatchGetSchemaAnalysisRuleOutput } from "../models/models_0"; | ||
import { de_BatchGetSchemaAnalysisRuleCommand, se_BatchGetSchemaAnalysisRuleCommand } from "../protocols/Aws_restJson1"; | ||
|
||
/** | ||
* @public | ||
*/ | ||
export { __MetadataBearer, $Command }; | ||
/** | ||
* @public | ||
* | ||
* The input for {@link BatchGetSchemaAnalysisRuleCommand}. | ||
*/ | ||
export interface BatchGetSchemaAnalysisRuleCommandInput extends BatchGetSchemaAnalysisRuleInput {} | ||
/** | ||
* @public | ||
* | ||
* The output of {@link BatchGetSchemaAnalysisRuleCommand}. | ||
*/ | ||
export interface BatchGetSchemaAnalysisRuleCommandOutput extends BatchGetSchemaAnalysisRuleOutput, __MetadataBearer {} | ||
|
||
/** | ||
* <p>Retrieves multiple analysis rule schemas.</p> | ||
* @example | ||
* Use a bare-bones client and the command you need to make an API call. | ||
* ```javascript | ||
* import { CleanRoomsClient, BatchGetSchemaAnalysisRuleCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import | ||
* // const { CleanRoomsClient, BatchGetSchemaAnalysisRuleCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import | ||
* const client = new CleanRoomsClient(config); | ||
* const input = { // BatchGetSchemaAnalysisRuleInput | ||
* collaborationIdentifier: "STRING_VALUE", // required | ||
* schemaAnalysisRuleRequests: [ // SchemaAnalysisRuleRequestList // required | ||
* { // SchemaAnalysisRuleRequest | ||
* name: "STRING_VALUE", // required | ||
* type: "AGGREGATION" || "LIST" || "CUSTOM", // required | ||
* }, | ||
* ], | ||
* }; | ||
* const command = new BatchGetSchemaAnalysisRuleCommand(input); | ||
* const response = await client.send(command); | ||
* // { // BatchGetSchemaAnalysisRuleOutput | ||
* // analysisRules: [ // SchemaAnalysisRuleList // required | ||
* // { // AnalysisRule | ||
* // collaborationId: "STRING_VALUE", // required | ||
* // type: "AGGREGATION" || "LIST" || "CUSTOM", // required | ||
* // name: "STRING_VALUE", // required | ||
* // createTime: new Date("TIMESTAMP"), // required | ||
* // updateTime: new Date("TIMESTAMP"), // required | ||
* // policy: { // AnalysisRulePolicy Union: only one key present | ||
* // v1: { // AnalysisRulePolicyV1 Union: only one key present | ||
* // list: { // AnalysisRuleList | ||
* // joinColumns: [ // AnalysisRuleColumnList // required | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // allowedJoinOperators: [ // JoinOperatorsList | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // listColumns: [ // required | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // }, | ||
* // aggregation: { // AnalysisRuleAggregation | ||
* // aggregateColumns: [ // AggregateColumnList // required | ||
* // { // AggregateColumn | ||
* // columnNames: [ // AnalysisRuleColumnNameList // required | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // function: "STRING_VALUE", // required | ||
* // }, | ||
* // ], | ||
* // joinColumns: [ // required | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // joinRequired: "STRING_VALUE", | ||
* // allowedJoinOperators: [ | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // dimensionColumns: [ // required | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // scalarFunctions: [ // ScalarFunctionsList // required | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // outputConstraints: [ // AggregationConstraints // required | ||
* // { // AggregationConstraint | ||
* // columnName: "STRING_VALUE", // required | ||
* // minimum: Number("int"), // required | ||
* // type: "STRING_VALUE", // required | ||
* // }, | ||
* // ], | ||
* // }, | ||
* // custom: { // AnalysisRuleCustom | ||
* // allowedAnalyses: [ // AllowedAnalysesList // required | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // allowedAnalysisProviders: [ // AllowedAnalysisProviderList | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // differentialPrivacy: { // DifferentialPrivacyConfiguration | ||
* // columns: [ // DifferentialPrivacyColumnList // required | ||
* // { // DifferentialPrivacyColumn | ||
* // name: "STRING_VALUE", // required | ||
* // }, | ||
* // ], | ||
* // }, | ||
* // }, | ||
* // }, | ||
* // }, | ||
* // }, | ||
* // ], | ||
* // errors: [ // BatchGetSchemaAnalysisRuleErrorList // required | ||
* // { // BatchGetSchemaAnalysisRuleError | ||
* // name: "STRING_VALUE", // required | ||
* // type: "AGGREGATION" || "LIST" || "CUSTOM", // required | ||
* // code: "STRING_VALUE", // required | ||
* // message: "STRING_VALUE", // required | ||
* // }, | ||
* // ], | ||
* // }; | ||
* | ||
* ``` | ||
* | ||
* @param BatchGetSchemaAnalysisRuleCommandInput - {@link BatchGetSchemaAnalysisRuleCommandInput} | ||
* @returns {@link BatchGetSchemaAnalysisRuleCommandOutput} | ||
* @see {@link BatchGetSchemaAnalysisRuleCommandInput} for command's `input` shape. | ||
* @see {@link BatchGetSchemaAnalysisRuleCommandOutput} for command's `response` shape. | ||
* @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape. | ||
* | ||
* @throws {@link AccessDeniedException} (client fault) | ||
* <p>Caller does not have sufficient access to perform this action.</p> | ||
* | ||
* @throws {@link InternalServerException} (server fault) | ||
* <p>Unexpected error during processing of request.</p> | ||
* | ||
* @throws {@link ResourceNotFoundException} (client fault) | ||
* <p>Request references a resource which does not exist.</p> | ||
* | ||
* @throws {@link ThrottlingException} (client fault) | ||
* <p>Request was denied due to request throttling.</p> | ||
* | ||
* @throws {@link ValidationException} (client fault) | ||
* <p>The input fails to satisfy the specified constraints.</p> | ||
* | ||
* @throws {@link CleanRoomsServiceException} | ||
* <p>Base exception class for all service exceptions from CleanRooms service.</p> | ||
* | ||
* @public | ||
*/ | ||
export class BatchGetSchemaAnalysisRuleCommand extends $Command | ||
.classBuilder< | ||
BatchGetSchemaAnalysisRuleCommandInput, | ||
BatchGetSchemaAnalysisRuleCommandOutput, | ||
CleanRoomsClientResolvedConfig, | ||
ServiceInputTypes, | ||
ServiceOutputTypes | ||
>() | ||
.ep({ | ||
...commonParams, | ||
}) | ||
.m(function (this: any, Command: any, cs: any, config: CleanRoomsClientResolvedConfig, o: any) { | ||
return [ | ||
getSerdePlugin(config, this.serialize, this.deserialize), | ||
getEndpointPlugin(config, Command.getEndpointParameterInstructions()), | ||
]; | ||
}) | ||
.s("AWSBastionControlPlaneServiceLambda", "BatchGetSchemaAnalysisRule", {}) | ||
.n("CleanRoomsClient", "BatchGetSchemaAnalysisRuleCommand") | ||
.f(void 0, void 0) | ||
.ser(se_BatchGetSchemaAnalysisRuleCommand) | ||
.de(de_BatchGetSchemaAnalysisRuleCommand) | ||
.build() {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.