@aws-sdk/client-cleanrooms 3.378.0 → 3.381.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.
- package/README.md +71 -7
- package/dist-cjs/CleanRooms.js +16 -0
- package/dist-cjs/commands/BatchGetCollaborationAnalysisTemplateCommand.js +47 -0
- package/dist-cjs/commands/CreateAnalysisTemplateCommand.js +47 -0
- package/dist-cjs/commands/DeleteAnalysisTemplateCommand.js +46 -0
- package/dist-cjs/commands/GetAnalysisTemplateCommand.js +47 -0
- package/dist-cjs/commands/GetCollaborationAnalysisTemplateCommand.js +47 -0
- package/dist-cjs/commands/ListAnalysisTemplatesCommand.js +46 -0
- package/dist-cjs/commands/ListCollaborationAnalysisTemplatesCommand.js +46 -0
- package/dist-cjs/commands/UpdateAnalysisTemplateCommand.js +47 -0
- package/dist-cjs/commands/index.js +8 -0
- package/dist-cjs/models/models_0.js +139 -45
- package/dist-cjs/pagination/ListAnalysisTemplatesPaginator.js +29 -0
- package/dist-cjs/pagination/ListCollaborationAnalysisTemplatesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +673 -36
- package/dist-es/CleanRooms.js +16 -0
- package/dist-es/commands/BatchGetCollaborationAnalysisTemplateCommand.js +43 -0
- package/dist-es/commands/CreateAnalysisTemplateCommand.js +43 -0
- package/dist-es/commands/DeleteAnalysisTemplateCommand.js +42 -0
- package/dist-es/commands/GetAnalysisTemplateCommand.js +43 -0
- package/dist-es/commands/GetCollaborationAnalysisTemplateCommand.js +43 -0
- package/dist-es/commands/ListAnalysisTemplatesCommand.js +42 -0
- package/dist-es/commands/ListCollaborationAnalysisTemplatesCommand.js +42 -0
- package/dist-es/commands/UpdateAnalysisTemplateCommand.js +43 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/models_0.js +125 -42
- package/dist-es/pagination/ListAnalysisTemplatesPaginator.js +25 -0
- package/dist-es/pagination/ListCollaborationAnalysisTemplatesPaginator.js +25 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +698 -77
- package/dist-types/CleanRooms.d.ts +56 -0
- package/dist-types/CleanRoomsClient.d.ts +10 -2
- package/dist-types/commands/BatchGetCollaborationAnalysisTemplateCommand.d.ts +126 -0
- package/dist-types/commands/BatchGetSchemaCommand.d.ts +1 -1
- package/dist-types/commands/CreateAnalysisTemplateCommand.d.ts +137 -0
- package/dist-types/commands/CreateConfiguredTableAnalysisRuleCommand.d.ts +18 -2
- package/dist-types/commands/CreateConfiguredTableCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAnalysisTemplateCommand.d.ts +87 -0
- package/dist-types/commands/DeleteConfiguredTableAnalysisRuleCommand.d.ts +1 -1
- package/dist-types/commands/GetAnalysisTemplateCommand.d.ts +116 -0
- package/dist-types/commands/GetCollaborationAnalysisTemplateCommand.d.ts +115 -0
- package/dist-types/commands/GetConfiguredTableAnalysisRuleCommand.d.ts +10 -2
- package/dist-types/commands/GetConfiguredTableCommand.d.ts +1 -1
- package/dist-types/commands/GetProtectedQueryCommand.d.ts +4 -0
- package/dist-types/commands/GetSchemaAnalysisRuleCommand.d.ts +10 -2
- package/dist-types/commands/GetSchemaCommand.d.ts +1 -1
- package/dist-types/commands/ListAnalysisTemplatesCommand.d.ts +104 -0
- package/dist-types/commands/ListCollaborationAnalysisTemplatesCommand.d.ts +103 -0
- package/dist-types/commands/ListConfiguredTablesCommand.d.ts +1 -1
- package/dist-types/commands/ListSchemasCommand.d.ts +1 -1
- package/dist-types/commands/StartProtectedQueryCommand.d.ts +8 -0
- package/dist-types/commands/UpdateAnalysisTemplateCommand.d.ts +117 -0
- package/dist-types/commands/UpdateConfiguredTableAnalysisRuleCommand.d.ts +18 -2
- package/dist-types/commands/UpdateConfiguredTableCommand.d.ts +1 -1
- package/dist-types/commands/UpdateProtectedQueryCommand.d.ts +4 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +3 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +793 -166
- package/dist-types/pagination/ListAnalysisTemplatesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListCollaborationAnalysisTemplatesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +72 -0
- package/dist-types/runtimeConfig.browser.d.ts +3 -1
- package/dist-types/ts3.4/CleanRooms.d.ts +148 -0
- package/dist-types/ts3.4/CleanRoomsClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/BatchGetCollaborationAnalysisTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateAnalysisTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteAnalysisTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetAnalysisTemplateCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetCollaborationAnalysisTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListAnalysisTemplatesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListCollaborationAnalysisTemplatesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateAnalysisTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +294 -58
- package/dist-types/ts3.4/pagination/ListAnalysisTemplatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListCollaborationAnalysisTemplatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
- package/package.json +6 -6
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
|
|
5
|
+
import { GetAnalysisTemplateInput, GetAnalysisTemplateOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetAnalysisTemplateCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetAnalysisTemplateCommandInput extends GetAnalysisTemplateInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetAnalysisTemplateCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetAnalysisTemplateCommandOutput extends GetAnalysisTemplateOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Retrieves an analysis template.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CleanRoomsClient, GetAnalysisTemplateCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
|
|
31
|
+
* // const { CleanRoomsClient, GetAnalysisTemplateCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
|
|
32
|
+
* const client = new CleanRoomsClient(config);
|
|
33
|
+
* const input = { // GetAnalysisTemplateInput
|
|
34
|
+
* membershipIdentifier: "STRING_VALUE", // required
|
|
35
|
+
* analysisTemplateIdentifier: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new GetAnalysisTemplateCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // GetAnalysisTemplateOutput
|
|
40
|
+
* // analysisTemplate: { // AnalysisTemplate
|
|
41
|
+
* // id: "STRING_VALUE", // required
|
|
42
|
+
* // arn: "STRING_VALUE", // required
|
|
43
|
+
* // collaborationId: "STRING_VALUE", // required
|
|
44
|
+
* // collaborationArn: "STRING_VALUE", // required
|
|
45
|
+
* // membershipId: "STRING_VALUE", // required
|
|
46
|
+
* // membershipArn: "STRING_VALUE", // required
|
|
47
|
+
* // description: "STRING_VALUE",
|
|
48
|
+
* // name: "STRING_VALUE", // required
|
|
49
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
50
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
51
|
+
* // schema: { // AnalysisSchema
|
|
52
|
+
* // referencedTables: [ // QueryTables
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // },
|
|
56
|
+
* // format: "STRING_VALUE", // required
|
|
57
|
+
* // source: { // AnalysisSource Union: only one key present
|
|
58
|
+
* // text: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // analysisParameters: [ // AnalysisParameterList
|
|
61
|
+
* // { // AnalysisParameter
|
|
62
|
+
* // name: "STRING_VALUE", // required
|
|
63
|
+
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
|
|
64
|
+
* // defaultValue: "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // },
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param GetAnalysisTemplateCommandInput - {@link GetAnalysisTemplateCommandInput}
|
|
73
|
+
* @returns {@link GetAnalysisTemplateCommandOutput}
|
|
74
|
+
* @see {@link GetAnalysisTemplateCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link GetAnalysisTemplateCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
79
|
+
* <p>Caller does not have sufficient access to perform this action.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InternalServerException} (server fault)
|
|
82
|
+
* <p>Unexpected error during processing of request.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
|
+
* <p>Request references a resource which does not exist.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
88
|
+
* <p>Request was denied due to request throttling.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ValidationException} (client fault)
|
|
91
|
+
* <p>The input fails to satisfy the specified constraints.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link CleanRoomsServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from CleanRooms service.</p>
|
|
95
|
+
*
|
|
96
|
+
*/
|
|
97
|
+
export declare class GetAnalysisTemplateCommand extends $Command<GetAnalysisTemplateCommandInput, GetAnalysisTemplateCommandOutput, CleanRoomsClientResolvedConfig> {
|
|
98
|
+
readonly input: GetAnalysisTemplateCommandInput;
|
|
99
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
100
|
+
/**
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
constructor(input: GetAnalysisTemplateCommandInput);
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAnalysisTemplateCommandInput, GetAnalysisTemplateCommandOutput>;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
private serialize;
|
|
112
|
+
/**
|
|
113
|
+
* @internal
|
|
114
|
+
*/
|
|
115
|
+
private deserialize;
|
|
116
|
+
}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
|
|
5
|
+
import { GetCollaborationAnalysisTemplateInput, GetCollaborationAnalysisTemplateOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetCollaborationAnalysisTemplateCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetCollaborationAnalysisTemplateCommandInput extends GetCollaborationAnalysisTemplateInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetCollaborationAnalysisTemplateCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetCollaborationAnalysisTemplateCommandOutput extends GetCollaborationAnalysisTemplateOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Retrieves an analysis template within a collaboration.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CleanRoomsClient, GetCollaborationAnalysisTemplateCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
|
|
31
|
+
* // const { CleanRoomsClient, GetCollaborationAnalysisTemplateCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
|
|
32
|
+
* const client = new CleanRoomsClient(config);
|
|
33
|
+
* const input = { // GetCollaborationAnalysisTemplateInput
|
|
34
|
+
* collaborationIdentifier: "STRING_VALUE", // required
|
|
35
|
+
* analysisTemplateArn: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new GetCollaborationAnalysisTemplateCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // GetCollaborationAnalysisTemplateOutput
|
|
40
|
+
* // collaborationAnalysisTemplate: { // CollaborationAnalysisTemplate
|
|
41
|
+
* // id: "STRING_VALUE", // required
|
|
42
|
+
* // arn: "STRING_VALUE", // required
|
|
43
|
+
* // collaborationId: "STRING_VALUE", // required
|
|
44
|
+
* // collaborationArn: "STRING_VALUE", // required
|
|
45
|
+
* // description: "STRING_VALUE",
|
|
46
|
+
* // creatorAccountId: "STRING_VALUE", // required
|
|
47
|
+
* // name: "STRING_VALUE", // required
|
|
48
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
50
|
+
* // schema: { // AnalysisSchema
|
|
51
|
+
* // referencedTables: [ // QueryTables
|
|
52
|
+
* // "STRING_VALUE",
|
|
53
|
+
* // ],
|
|
54
|
+
* // },
|
|
55
|
+
* // format: "STRING_VALUE", // required
|
|
56
|
+
* // source: { // AnalysisSource Union: only one key present
|
|
57
|
+
* // text: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // analysisParameters: [ // AnalysisParameterList
|
|
60
|
+
* // { // AnalysisParameter
|
|
61
|
+
* // name: "STRING_VALUE", // required
|
|
62
|
+
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
|
|
63
|
+
* // defaultValue: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // },
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @param GetCollaborationAnalysisTemplateCommandInput - {@link GetCollaborationAnalysisTemplateCommandInput}
|
|
72
|
+
* @returns {@link GetCollaborationAnalysisTemplateCommandOutput}
|
|
73
|
+
* @see {@link GetCollaborationAnalysisTemplateCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link GetCollaborationAnalysisTemplateCommandOutput} for command's `response` shape.
|
|
75
|
+
* @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
78
|
+
* <p>Caller does not have sufficient access to perform this action.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerException} (server fault)
|
|
81
|
+
* <p>Unexpected error during processing of request.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>Request references a resource which does not exist.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
87
|
+
* <p>Request was denied due to request throttling.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
* <p>The input fails to satisfy the specified constraints.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link CleanRoomsServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from CleanRooms service.</p>
|
|
94
|
+
*
|
|
95
|
+
*/
|
|
96
|
+
export declare class GetCollaborationAnalysisTemplateCommand extends $Command<GetCollaborationAnalysisTemplateCommandInput, GetCollaborationAnalysisTemplateCommandOutput, CleanRoomsClientResolvedConfig> {
|
|
97
|
+
readonly input: GetCollaborationAnalysisTemplateCommandInput;
|
|
98
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
99
|
+
/**
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
constructor(input: GetCollaborationAnalysisTemplateCommandInput);
|
|
103
|
+
/**
|
|
104
|
+
* @internal
|
|
105
|
+
*/
|
|
106
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCollaborationAnalysisTemplateCommandInput, GetCollaborationAnalysisTemplateCommandOutput>;
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
private serialize;
|
|
111
|
+
/**
|
|
112
|
+
* @internal
|
|
113
|
+
*/
|
|
114
|
+
private deserialize;
|
|
115
|
+
}
|
|
@@ -32,7 +32,7 @@ export interface GetConfiguredTableAnalysisRuleCommandOutput extends GetConfigur
|
|
|
32
32
|
* const client = new CleanRoomsClient(config);
|
|
33
33
|
* const input = { // GetConfiguredTableAnalysisRuleInput
|
|
34
34
|
* configuredTableIdentifier: "STRING_VALUE", // required
|
|
35
|
-
* analysisRuleType: "AGGREGATION" || "LIST", // required
|
|
35
|
+
* analysisRuleType: "AGGREGATION" || "LIST" || "CUSTOM", // required
|
|
36
36
|
* };
|
|
37
37
|
* const command = new GetConfiguredTableAnalysisRuleCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
@@ -83,9 +83,17 @@ export interface GetConfiguredTableAnalysisRuleCommandOutput extends GetConfigur
|
|
|
83
83
|
* // },
|
|
84
84
|
* // ],
|
|
85
85
|
* // },
|
|
86
|
+
* // custom: { // AnalysisRuleCustom
|
|
87
|
+
* // allowedAnalyses: [ // AllowedAnalysesList // required
|
|
88
|
+
* // "STRING_VALUE",
|
|
89
|
+
* // ],
|
|
90
|
+
* // allowedAnalysisProviders: [ // AllowedAnalysisProviderList
|
|
91
|
+
* // "STRING_VALUE",
|
|
92
|
+
* // ],
|
|
93
|
+
* // },
|
|
86
94
|
* // },
|
|
87
95
|
* // },
|
|
88
|
-
* // type: "AGGREGATION" || "LIST", // required
|
|
96
|
+
* // type: "AGGREGATION" || "LIST" || "CUSTOM", // required
|
|
89
97
|
* // createTime: new Date("TIMESTAMP"), // required
|
|
90
98
|
* // updateTime: new Date("TIMESTAMP"), // required
|
|
91
99
|
* // },
|
|
@@ -50,7 +50,7 @@ export interface GetConfiguredTableCommandOutput extends GetConfiguredTableOutpu
|
|
|
50
50
|
* // createTime: new Date("TIMESTAMP"), // required
|
|
51
51
|
* // updateTime: new Date("TIMESTAMP"), // required
|
|
52
52
|
* // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
|
|
53
|
-
* // "AGGREGATION" || "LIST",
|
|
53
|
+
* // "AGGREGATION" || "LIST" || "CUSTOM",
|
|
54
54
|
* // ],
|
|
55
55
|
* // analysisMethod: "STRING_VALUE", // required
|
|
56
56
|
* // allowedColumns: [ // AllowedColumnList // required
|
|
@@ -44,6 +44,10 @@ export interface GetProtectedQueryCommandOutput extends GetProtectedQueryOutput,
|
|
|
44
44
|
* // createTime: new Date("TIMESTAMP"), // required
|
|
45
45
|
* // sqlParameters: { // ProtectedQuerySQLParameters
|
|
46
46
|
* // queryString: "STRING_VALUE",
|
|
47
|
+
* // analysisTemplateArn: "STRING_VALUE",
|
|
48
|
+
* // parameters: { // ParameterMap
|
|
49
|
+
* // "<keys>": "STRING_VALUE",
|
|
50
|
+
* // },
|
|
47
51
|
* // },
|
|
48
52
|
* // status: "STRING_VALUE", // required
|
|
49
53
|
* // resultConfiguration: { // ProtectedQueryResultConfiguration
|
|
@@ -33,14 +33,14 @@ export interface GetSchemaAnalysisRuleCommandOutput extends GetSchemaAnalysisRul
|
|
|
33
33
|
* const input = { // GetSchemaAnalysisRuleInput
|
|
34
34
|
* collaborationIdentifier: "STRING_VALUE", // required
|
|
35
35
|
* name: "STRING_VALUE", // required
|
|
36
|
-
* type: "AGGREGATION" || "LIST", // required
|
|
36
|
+
* type: "AGGREGATION" || "LIST" || "CUSTOM", // required
|
|
37
37
|
* };
|
|
38
38
|
* const command = new GetSchemaAnalysisRuleCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
40
|
* // { // GetSchemaAnalysisRuleOutput
|
|
41
41
|
* // analysisRule: { // AnalysisRule
|
|
42
42
|
* // collaborationId: "STRING_VALUE", // required
|
|
43
|
-
* // type: "AGGREGATION" || "LIST", // required
|
|
43
|
+
* // type: "AGGREGATION" || "LIST" || "CUSTOM", // required
|
|
44
44
|
* // name: "STRING_VALUE", // required
|
|
45
45
|
* // createTime: new Date("TIMESTAMP"), // required
|
|
46
46
|
* // updateTime: new Date("TIMESTAMP"), // required
|
|
@@ -87,6 +87,14 @@ export interface GetSchemaAnalysisRuleCommandOutput extends GetSchemaAnalysisRul
|
|
|
87
87
|
* // },
|
|
88
88
|
* // ],
|
|
89
89
|
* // },
|
|
90
|
+
* // custom: { // AnalysisRuleCustom
|
|
91
|
+
* // allowedAnalyses: [ // AllowedAnalysesList // required
|
|
92
|
+
* // "STRING_VALUE",
|
|
93
|
+
* // ],
|
|
94
|
+
* // allowedAnalysisProviders: [ // AllowedAnalysisProviderList
|
|
95
|
+
* // "STRING_VALUE",
|
|
96
|
+
* // ],
|
|
97
|
+
* // },
|
|
90
98
|
* // },
|
|
91
99
|
* // },
|
|
92
100
|
* // },
|
|
@@ -51,7 +51,7 @@ export interface GetSchemaCommandOutput extends GetSchemaOutput, __MetadataBeare
|
|
|
51
51
|
* // },
|
|
52
52
|
* // ],
|
|
53
53
|
* // analysisRuleTypes: [ // AnalysisRuleTypeList // required
|
|
54
|
-
* // "AGGREGATION" || "LIST",
|
|
54
|
+
* // "AGGREGATION" || "LIST" || "CUSTOM",
|
|
55
55
|
* // ],
|
|
56
56
|
* // analysisMethod: "STRING_VALUE",
|
|
57
57
|
* // creatorAccountId: "STRING_VALUE", // required
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
|
|
5
|
+
import { ListAnalysisTemplatesInput, ListAnalysisTemplatesOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAnalysisTemplatesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAnalysisTemplatesCommandInput extends ListAnalysisTemplatesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAnalysisTemplatesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAnalysisTemplatesCommandOutput extends ListAnalysisTemplatesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Lists analysis templates that the caller owns.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CleanRoomsClient, ListAnalysisTemplatesCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
|
|
31
|
+
* // const { CleanRoomsClient, ListAnalysisTemplatesCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
|
|
32
|
+
* const client = new CleanRoomsClient(config);
|
|
33
|
+
* const input = { // ListAnalysisTemplatesInput
|
|
34
|
+
* membershipIdentifier: "STRING_VALUE", // required
|
|
35
|
+
* nextToken: "STRING_VALUE",
|
|
36
|
+
* maxResults: Number("int"),
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListAnalysisTemplatesCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // ListAnalysisTemplatesOutput
|
|
41
|
+
* // nextToken: "STRING_VALUE",
|
|
42
|
+
* // analysisTemplateSummaries: [ // AnalysisTemplateSummaryList // required
|
|
43
|
+
* // { // AnalysisTemplateSummary
|
|
44
|
+
* // arn: "STRING_VALUE", // required
|
|
45
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
46
|
+
* // id: "STRING_VALUE", // required
|
|
47
|
+
* // name: "STRING_VALUE", // required
|
|
48
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // membershipArn: "STRING_VALUE", // required
|
|
50
|
+
* // membershipId: "STRING_VALUE", // required
|
|
51
|
+
* // collaborationArn: "STRING_VALUE", // required
|
|
52
|
+
* // collaborationId: "STRING_VALUE", // required
|
|
53
|
+
* // description: "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param ListAnalysisTemplatesCommandInput - {@link ListAnalysisTemplatesCommandInput}
|
|
61
|
+
* @returns {@link ListAnalysisTemplatesCommandOutput}
|
|
62
|
+
* @see {@link ListAnalysisTemplatesCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link ListAnalysisTemplatesCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
67
|
+
* <p>Caller does not have sufficient access to perform this action.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalServerException} (server fault)
|
|
70
|
+
* <p>Unexpected error during processing of request.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
73
|
+
* <p>Request references a resource which does not exist.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
76
|
+
* <p>Request was denied due to request throttling.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ValidationException} (client fault)
|
|
79
|
+
* <p>The input fails to satisfy the specified constraints.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link CleanRoomsServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from CleanRooms service.</p>
|
|
83
|
+
*
|
|
84
|
+
*/
|
|
85
|
+
export declare class ListAnalysisTemplatesCommand extends $Command<ListAnalysisTemplatesCommandInput, ListAnalysisTemplatesCommandOutput, CleanRoomsClientResolvedConfig> {
|
|
86
|
+
readonly input: ListAnalysisTemplatesCommandInput;
|
|
87
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
88
|
+
/**
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
constructor(input: ListAnalysisTemplatesCommandInput);
|
|
92
|
+
/**
|
|
93
|
+
* @internal
|
|
94
|
+
*/
|
|
95
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAnalysisTemplatesCommandInput, ListAnalysisTemplatesCommandOutput>;
|
|
96
|
+
/**
|
|
97
|
+
* @internal
|
|
98
|
+
*/
|
|
99
|
+
private serialize;
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
private deserialize;
|
|
104
|
+
}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
|
|
5
|
+
import { ListCollaborationAnalysisTemplatesInput, ListCollaborationAnalysisTemplatesOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListCollaborationAnalysisTemplatesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListCollaborationAnalysisTemplatesCommandInput extends ListCollaborationAnalysisTemplatesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListCollaborationAnalysisTemplatesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListCollaborationAnalysisTemplatesCommandOutput extends ListCollaborationAnalysisTemplatesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Lists analysis templates within a collaboration.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CleanRoomsClient, ListCollaborationAnalysisTemplatesCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
|
|
31
|
+
* // const { CleanRoomsClient, ListCollaborationAnalysisTemplatesCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
|
|
32
|
+
* const client = new CleanRoomsClient(config);
|
|
33
|
+
* const input = { // ListCollaborationAnalysisTemplatesInput
|
|
34
|
+
* collaborationIdentifier: "STRING_VALUE", // required
|
|
35
|
+
* nextToken: "STRING_VALUE",
|
|
36
|
+
* maxResults: Number("int"),
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListCollaborationAnalysisTemplatesCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // ListCollaborationAnalysisTemplatesOutput
|
|
41
|
+
* // nextToken: "STRING_VALUE",
|
|
42
|
+
* // collaborationAnalysisTemplateSummaries: [ // CollaborationAnalysisTemplateSummaryList // required
|
|
43
|
+
* // { // CollaborationAnalysisTemplateSummary
|
|
44
|
+
* // arn: "STRING_VALUE", // required
|
|
45
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
46
|
+
* // id: "STRING_VALUE", // required
|
|
47
|
+
* // name: "STRING_VALUE", // required
|
|
48
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // collaborationArn: "STRING_VALUE", // required
|
|
50
|
+
* // collaborationId: "STRING_VALUE", // required
|
|
51
|
+
* // creatorAccountId: "STRING_VALUE", // required
|
|
52
|
+
* // description: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param ListCollaborationAnalysisTemplatesCommandInput - {@link ListCollaborationAnalysisTemplatesCommandInput}
|
|
60
|
+
* @returns {@link ListCollaborationAnalysisTemplatesCommandOutput}
|
|
61
|
+
* @see {@link ListCollaborationAnalysisTemplatesCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link ListCollaborationAnalysisTemplatesCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
+
* <p>Caller does not have sufficient access to perform this action.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerException} (server fault)
|
|
69
|
+
* <p>Unexpected error during processing of request.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>Request references a resource which does not exist.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>Request was denied due to request throttling.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationException} (client fault)
|
|
78
|
+
* <p>The input fails to satisfy the specified constraints.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link CleanRoomsServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from CleanRooms service.</p>
|
|
82
|
+
*
|
|
83
|
+
*/
|
|
84
|
+
export declare class ListCollaborationAnalysisTemplatesCommand extends $Command<ListCollaborationAnalysisTemplatesCommandInput, ListCollaborationAnalysisTemplatesCommandOutput, CleanRoomsClientResolvedConfig> {
|
|
85
|
+
readonly input: ListCollaborationAnalysisTemplatesCommandInput;
|
|
86
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
constructor(input: ListCollaborationAnalysisTemplatesCommandInput);
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
*/
|
|
94
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListCollaborationAnalysisTemplatesCommandInput, ListCollaborationAnalysisTemplatesCommandOutput>;
|
|
95
|
+
/**
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
private serialize;
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
private deserialize;
|
|
103
|
+
}
|
|
@@ -45,7 +45,7 @@ export interface ListConfiguredTablesCommandOutput extends ListConfiguredTablesO
|
|
|
45
45
|
* // createTime: new Date("TIMESTAMP"), // required
|
|
46
46
|
* // updateTime: new Date("TIMESTAMP"), // required
|
|
47
47
|
* // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
|
|
48
|
-
* // "AGGREGATION" || "LIST",
|
|
48
|
+
* // "AGGREGATION" || "LIST" || "CUSTOM",
|
|
49
49
|
* // ],
|
|
50
50
|
* // analysisMethod: "STRING_VALUE", // required
|
|
51
51
|
* // },
|
|
@@ -49,7 +49,7 @@ export interface ListSchemasCommandOutput extends ListSchemasOutput, __MetadataB
|
|
|
49
49
|
* // collaborationId: "STRING_VALUE", // required
|
|
50
50
|
* // collaborationArn: "STRING_VALUE", // required
|
|
51
51
|
* // analysisRuleTypes: [ // AnalysisRuleTypeList // required
|
|
52
|
-
* // "AGGREGATION" || "LIST",
|
|
52
|
+
* // "AGGREGATION" || "LIST" || "CUSTOM",
|
|
53
53
|
* // ],
|
|
54
54
|
* // analysisMethod: "STRING_VALUE",
|
|
55
55
|
* // },
|
|
@@ -35,6 +35,10 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut
|
|
|
35
35
|
* membershipIdentifier: "STRING_VALUE", // required
|
|
36
36
|
* sqlParameters: { // ProtectedQuerySQLParameters
|
|
37
37
|
* queryString: "STRING_VALUE",
|
|
38
|
+
* analysisTemplateArn: "STRING_VALUE",
|
|
39
|
+
* parameters: { // ParameterMap
|
|
40
|
+
* "<keys>": "STRING_VALUE",
|
|
41
|
+
* },
|
|
38
42
|
* },
|
|
39
43
|
* resultConfiguration: { // ProtectedQueryResultConfiguration
|
|
40
44
|
* outputConfiguration: { // ProtectedQueryOutputConfiguration Union: only one key present
|
|
@@ -56,6 +60,10 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut
|
|
|
56
60
|
* // createTime: new Date("TIMESTAMP"), // required
|
|
57
61
|
* // sqlParameters: { // ProtectedQuerySQLParameters
|
|
58
62
|
* // queryString: "STRING_VALUE",
|
|
63
|
+
* // analysisTemplateArn: "STRING_VALUE",
|
|
64
|
+
* // parameters: { // ParameterMap
|
|
65
|
+
* // "<keys>": "STRING_VALUE",
|
|
66
|
+
* // },
|
|
59
67
|
* // },
|
|
60
68
|
* // status: "STRING_VALUE", // required
|
|
61
69
|
* // resultConfiguration: { // ProtectedQueryResultConfiguration
|