@aws-sdk/client-cleanrooms 3.879.0 → 3.882.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.
Files changed (48) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/index.js +238 -15
  3. package/dist-es/CleanRooms.js +6 -0
  4. package/dist-es/commands/CreateCollaborationChangeRequestCommand.js +22 -0
  5. package/dist-es/commands/GetCollaborationChangeRequestCommand.js +22 -0
  6. package/dist-es/commands/ListCollaborationChangeRequestsCommand.js +22 -0
  7. package/dist-es/commands/index.js +3 -0
  8. package/dist-es/models/models_0.js +24 -15
  9. package/dist-es/models/models_1.js +27 -0
  10. package/dist-es/pagination/ListCollaborationChangeRequestsPaginator.js +4 -0
  11. package/dist-es/pagination/index.js +1 -0
  12. package/dist-es/protocols/Aws_restJson1.js +115 -0
  13. package/dist-types/CleanRooms.d.ts +21 -0
  14. package/dist-types/CleanRoomsClient.d.ts +5 -2
  15. package/dist-types/commands/CreateCollaborationChangeRequestCommand.d.ts +131 -0
  16. package/dist-types/commands/CreateCollaborationCommand.d.ts +6 -0
  17. package/dist-types/commands/CreateMembershipCommand.d.ts +1 -1
  18. package/dist-types/commands/DeleteMembershipCommand.d.ts +1 -1
  19. package/dist-types/commands/GetCollaborationChangeRequestCommand.d.ts +112 -0
  20. package/dist-types/commands/GetCollaborationCommand.d.ts +3 -0
  21. package/dist-types/commands/GetMembershipCommand.d.ts +1 -1
  22. package/dist-types/commands/GetProtectedJobCommand.d.ts +7 -2
  23. package/dist-types/commands/ListCollaborationChangeRequestsCommand.d.ts +117 -0
  24. package/dist-types/commands/StartProtectedJobCommand.d.ts +12 -0
  25. package/dist-types/commands/UpdateCollaborationCommand.d.ts +3 -0
  26. package/dist-types/commands/UpdateProtectedJobCommand.d.ts +6 -0
  27. package/dist-types/commands/index.d.ts +3 -0
  28. package/dist-types/models/models_0.d.ts +318 -317
  29. package/dist-types/models/models_1.d.ts +387 -2
  30. package/dist-types/pagination/ListCollaborationChangeRequestsPaginator.d.ts +7 -0
  31. package/dist-types/pagination/index.d.ts +1 -0
  32. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  33. package/dist-types/ts3.4/CleanRooms.d.ts +51 -0
  34. package/dist-types/ts3.4/CleanRoomsClient.d.ts +18 -0
  35. package/dist-types/ts3.4/commands/CreateCollaborationChangeRequestCommand.d.ts +51 -0
  36. package/dist-types/ts3.4/commands/CreateMembershipCommand.d.ts +1 -1
  37. package/dist-types/ts3.4/commands/DeleteMembershipCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/GetCollaborationChangeRequestCommand.d.ts +51 -0
  39. package/dist-types/ts3.4/commands/GetMembershipCommand.d.ts +1 -1
  40. package/dist-types/ts3.4/commands/GetProtectedJobCommand.d.ts +4 -2
  41. package/dist-types/ts3.4/commands/ListCollaborationChangeRequestsCommand.d.ts +51 -0
  42. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  43. package/dist-types/ts3.4/models/models_0.d.ts +101 -106
  44. package/dist-types/ts3.4/models/models_1.d.ts +139 -6
  45. package/dist-types/ts3.4/pagination/ListCollaborationChangeRequestsPaginator.d.ts +11 -0
  46. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  47. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  48. package/package.json +11 -11
@@ -0,0 +1,112 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
4
+ import { GetCollaborationChangeRequestInput, GetCollaborationChangeRequestOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetCollaborationChangeRequestCommand}.
14
+ */
15
+ export interface GetCollaborationChangeRequestCommandInput extends GetCollaborationChangeRequestInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetCollaborationChangeRequestCommand}.
21
+ */
22
+ export interface GetCollaborationChangeRequestCommandOutput extends GetCollaborationChangeRequestOutput, __MetadataBearer {
23
+ }
24
+ declare const GetCollaborationChangeRequestCommand_base: {
25
+ new (input: GetCollaborationChangeRequestCommandInput): import("@smithy/smithy-client").CommandImpl<GetCollaborationChangeRequestCommandInput, GetCollaborationChangeRequestCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetCollaborationChangeRequestCommandInput): import("@smithy/smithy-client").CommandImpl<GetCollaborationChangeRequestCommandInput, GetCollaborationChangeRequestCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves detailed information about a specific collaboration change request.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { CleanRoomsClient, GetCollaborationChangeRequestCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
35
+ * // const { CleanRoomsClient, GetCollaborationChangeRequestCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
36
+ * const client = new CleanRoomsClient(config);
37
+ * const input = { // GetCollaborationChangeRequestInput
38
+ * collaborationIdentifier: "STRING_VALUE", // required
39
+ * changeRequestIdentifier: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetCollaborationChangeRequestCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetCollaborationChangeRequestOutput
44
+ * // collaborationChangeRequest: { // CollaborationChangeRequest
45
+ * // id: "STRING_VALUE", // required
46
+ * // collaborationId: "STRING_VALUE", // required
47
+ * // createTime: new Date("TIMESTAMP"), // required
48
+ * // updateTime: new Date("TIMESTAMP"), // required
49
+ * // status: "PENDING" || "APPROVED" || "CANCELLED" || "DENIED" || "COMMITTED", // required
50
+ * // isAutoApproved: true || false, // required
51
+ * // changes: [ // ChangeList // required
52
+ * // { // Change
53
+ * // specificationType: "MEMBER", // required
54
+ * // specification: { // ChangeSpecification Union: only one key present
55
+ * // member: { // MemberChangeSpecification
56
+ * // accountId: "STRING_VALUE", // required
57
+ * // memberAbilities: [ // MemberAbilities // required
58
+ * // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
59
+ * // ],
60
+ * // displayName: "STRING_VALUE",
61
+ * // },
62
+ * // },
63
+ * // types: [ // ChangeTypeList // required
64
+ * // "ADD_MEMBER",
65
+ * // ],
66
+ * // },
67
+ * // ],
68
+ * // },
69
+ * // };
70
+ *
71
+ * ```
72
+ *
73
+ * @param GetCollaborationChangeRequestCommandInput - {@link GetCollaborationChangeRequestCommandInput}
74
+ * @returns {@link GetCollaborationChangeRequestCommandOutput}
75
+ * @see {@link GetCollaborationChangeRequestCommandInput} for command's `input` shape.
76
+ * @see {@link GetCollaborationChangeRequestCommandOutput} for command's `response` shape.
77
+ * @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
78
+ *
79
+ * @throws {@link AccessDeniedException} (client fault)
80
+ * <p>Caller does not have sufficient access to perform this action.</p>
81
+ *
82
+ * @throws {@link InternalServerException} (server fault)
83
+ * <p>Unexpected error during processing of request.</p>
84
+ *
85
+ * @throws {@link ResourceNotFoundException} (client fault)
86
+ * <p>Request references a resource which does not exist.</p>
87
+ *
88
+ * @throws {@link ThrottlingException} (client fault)
89
+ * <p>Request was denied due to request throttling.</p>
90
+ *
91
+ * @throws {@link ValidationException} (client fault)
92
+ * <p>The input fails to satisfy the specified constraints.</p>
93
+ *
94
+ * @throws {@link CleanRoomsServiceException}
95
+ * <p>Base exception class for all service exceptions from CleanRooms service.</p>
96
+ *
97
+ *
98
+ * @public
99
+ */
100
+ export declare class GetCollaborationChangeRequestCommand extends GetCollaborationChangeRequestCommand_base {
101
+ /** @internal type navigation helper, not in runtime. */
102
+ protected static __types: {
103
+ api: {
104
+ input: GetCollaborationChangeRequestInput;
105
+ output: GetCollaborationChangeRequestOutput;
106
+ };
107
+ sdk: {
108
+ input: GetCollaborationChangeRequestCommandInput;
109
+ output: GetCollaborationChangeRequestCommandOutput;
110
+ };
111
+ };
112
+ }
@@ -61,6 +61,9 @@ declare const GetCollaborationCommand_base: {
61
61
  * // queryLogStatus: "ENABLED" || "DISABLED", // required
62
62
  * // jobLogStatus: "ENABLED" || "DISABLED",
63
63
  * // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
64
+ * // autoApprovedChangeTypes: [ // AutoApprovedChangeTypeList
65
+ * // "ADD_MEMBER",
66
+ * // ],
64
67
  * // },
65
68
  * // };
66
69
  *
@@ -1,7 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
4
- import { GetMembershipInput, GetMembershipOutput } from "../models/models_0";
4
+ import { GetMembershipInput, GetMembershipOutput } from "../models/models_1";
5
5
  /**
6
6
  * @public
7
7
  */
@@ -1,8 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
4
- import { GetProtectedJobInput } from "../models/models_0";
5
- import { GetProtectedJobOutput } from "../models/models_1";
4
+ import { GetProtectedJobInput, GetProtectedJobOutput } from "../models/models_1";
6
5
  /**
7
6
  * @public
8
7
  */
@@ -84,6 +83,12 @@ declare const GetProtectedJobCommand_base: {
84
83
  * // message: "STRING_VALUE", // required
85
84
  * // code: "STRING_VALUE", // required
86
85
  * // },
86
+ * // computeConfiguration: { // ProtectedJobComputeConfiguration Union: only one key present
87
+ * // worker: { // ProtectedJobWorkerComputeConfiguration
88
+ * // type: "CR.1X" || "CR.4X", // required
89
+ * // number: Number("int"), // required
90
+ * // },
91
+ * // },
87
92
  * // },
88
93
  * // };
89
94
  *
@@ -0,0 +1,117 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
4
+ import { ListCollaborationChangeRequestsInput, ListCollaborationChangeRequestsOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListCollaborationChangeRequestsCommand}.
14
+ */
15
+ export interface ListCollaborationChangeRequestsCommandInput extends ListCollaborationChangeRequestsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListCollaborationChangeRequestsCommand}.
21
+ */
22
+ export interface ListCollaborationChangeRequestsCommandOutput extends ListCollaborationChangeRequestsOutput, __MetadataBearer {
23
+ }
24
+ declare const ListCollaborationChangeRequestsCommand_base: {
25
+ new (input: ListCollaborationChangeRequestsCommandInput): import("@smithy/smithy-client").CommandImpl<ListCollaborationChangeRequestsCommandInput, ListCollaborationChangeRequestsCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ListCollaborationChangeRequestsCommandInput): import("@smithy/smithy-client").CommandImpl<ListCollaborationChangeRequestsCommandInput, ListCollaborationChangeRequestsCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { CleanRoomsClient, ListCollaborationChangeRequestsCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
35
+ * // const { CleanRoomsClient, ListCollaborationChangeRequestsCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
36
+ * const client = new CleanRoomsClient(config);
37
+ * const input = { // ListCollaborationChangeRequestsInput
38
+ * collaborationIdentifier: "STRING_VALUE", // required
39
+ * status: "PENDING" || "APPROVED" || "CANCELLED" || "DENIED" || "COMMITTED",
40
+ * nextToken: "STRING_VALUE",
41
+ * maxResults: Number("int"),
42
+ * };
43
+ * const command = new ListCollaborationChangeRequestsCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // ListCollaborationChangeRequestsOutput
46
+ * // collaborationChangeRequestSummaries: [ // CollaborationChangeRequestSummaryList // required
47
+ * // { // CollaborationChangeRequestSummary
48
+ * // id: "STRING_VALUE", // required
49
+ * // collaborationId: "STRING_VALUE", // required
50
+ * // createTime: new Date("TIMESTAMP"), // required
51
+ * // updateTime: new Date("TIMESTAMP"), // required
52
+ * // status: "PENDING" || "APPROVED" || "CANCELLED" || "DENIED" || "COMMITTED", // required
53
+ * // isAutoApproved: true || false, // required
54
+ * // changes: [ // ChangeList // required
55
+ * // { // Change
56
+ * // specificationType: "MEMBER", // required
57
+ * // specification: { // ChangeSpecification Union: only one key present
58
+ * // member: { // MemberChangeSpecification
59
+ * // accountId: "STRING_VALUE", // required
60
+ * // memberAbilities: [ // MemberAbilities // required
61
+ * // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
62
+ * // ],
63
+ * // displayName: "STRING_VALUE",
64
+ * // },
65
+ * // },
66
+ * // types: [ // ChangeTypeList // required
67
+ * // "ADD_MEMBER",
68
+ * // ],
69
+ * // },
70
+ * // ],
71
+ * // },
72
+ * // ],
73
+ * // nextToken: "STRING_VALUE",
74
+ * // };
75
+ *
76
+ * ```
77
+ *
78
+ * @param ListCollaborationChangeRequestsCommandInput - {@link ListCollaborationChangeRequestsCommandInput}
79
+ * @returns {@link ListCollaborationChangeRequestsCommandOutput}
80
+ * @see {@link ListCollaborationChangeRequestsCommandInput} for command's `input` shape.
81
+ * @see {@link ListCollaborationChangeRequestsCommandOutput} for command's `response` shape.
82
+ * @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
83
+ *
84
+ * @throws {@link AccessDeniedException} (client fault)
85
+ * <p>Caller does not have sufficient access to perform this action.</p>
86
+ *
87
+ * @throws {@link InternalServerException} (server fault)
88
+ * <p>Unexpected error during processing of request.</p>
89
+ *
90
+ * @throws {@link ResourceNotFoundException} (client fault)
91
+ * <p>Request references a resource which does not exist.</p>
92
+ *
93
+ * @throws {@link ThrottlingException} (client fault)
94
+ * <p>Request was denied due to request throttling.</p>
95
+ *
96
+ * @throws {@link ValidationException} (client fault)
97
+ * <p>The input fails to satisfy the specified constraints.</p>
98
+ *
99
+ * @throws {@link CleanRoomsServiceException}
100
+ * <p>Base exception class for all service exceptions from CleanRooms service.</p>
101
+ *
102
+ *
103
+ * @public
104
+ */
105
+ export declare class ListCollaborationChangeRequestsCommand extends ListCollaborationChangeRequestsCommand_base {
106
+ /** @internal type navigation helper, not in runtime. */
107
+ protected static __types: {
108
+ api: {
109
+ input: ListCollaborationChangeRequestsInput;
110
+ output: ListCollaborationChangeRequestsOutput;
111
+ };
112
+ sdk: {
113
+ input: ListCollaborationChangeRequestsCommandInput;
114
+ output: ListCollaborationChangeRequestsCommandOutput;
115
+ };
116
+ };
117
+ }
@@ -47,6 +47,12 @@ declare const StartProtectedJobCommand_base: {
47
47
  * },
48
48
  * },
49
49
  * },
50
+ * computeConfiguration: { // ProtectedJobComputeConfiguration Union: only one key present
51
+ * worker: { // ProtectedJobWorkerComputeConfiguration
52
+ * type: "CR.1X" || "CR.4X", // required
53
+ * number: Number("int"), // required
54
+ * },
55
+ * },
50
56
  * };
51
57
  * const command = new StartProtectedJobCommand(input);
52
58
  * const response = await client.send(command);
@@ -93,6 +99,12 @@ declare const StartProtectedJobCommand_base: {
93
99
  * // message: "STRING_VALUE", // required
94
100
  * // code: "STRING_VALUE", // required
95
101
  * // },
102
+ * // computeConfiguration: { // ProtectedJobComputeConfiguration Union: only one key present
103
+ * // worker: { // ProtectedJobWorkerComputeConfiguration
104
+ * // type: "CR.1X" || "CR.4X", // required
105
+ * // number: Number("int"), // required
106
+ * // },
107
+ * // },
96
108
  * // },
97
109
  * // };
98
110
  *
@@ -64,6 +64,9 @@ declare const UpdateCollaborationCommand_base: {
64
64
  * // queryLogStatus: "ENABLED" || "DISABLED", // required
65
65
  * // jobLogStatus: "ENABLED" || "DISABLED",
66
66
  * // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
67
+ * // autoApprovedChangeTypes: [ // AutoApprovedChangeTypeList
68
+ * // "ADD_MEMBER",
69
+ * // ],
67
70
  * // },
68
71
  * // };
69
72
  *
@@ -84,6 +84,12 @@ declare const UpdateProtectedJobCommand_base: {
84
84
  * // message: "STRING_VALUE", // required
85
85
  * // code: "STRING_VALUE", // required
86
86
  * // },
87
+ * // computeConfiguration: { // ProtectedJobComputeConfiguration Union: only one key present
88
+ * // worker: { // ProtectedJobWorkerComputeConfiguration
89
+ * // type: "CR.1X" || "CR.4X", // required
90
+ * // number: Number("int"), // required
91
+ * // },
92
+ * // },
87
93
  * // },
88
94
  * // };
89
95
  *
@@ -2,6 +2,7 @@ export * from "./BatchGetCollaborationAnalysisTemplateCommand";
2
2
  export * from "./BatchGetSchemaAnalysisRuleCommand";
3
3
  export * from "./BatchGetSchemaCommand";
4
4
  export * from "./CreateAnalysisTemplateCommand";
5
+ export * from "./CreateCollaborationChangeRequestCommand";
5
6
  export * from "./CreateCollaborationCommand";
6
7
  export * from "./CreateConfiguredAudienceModelAssociationCommand";
7
8
  export * from "./CreateConfiguredTableAnalysisRuleCommand";
@@ -26,6 +27,7 @@ export * from "./DeleteMembershipCommand";
26
27
  export * from "./DeletePrivacyBudgetTemplateCommand";
27
28
  export * from "./GetAnalysisTemplateCommand";
28
29
  export * from "./GetCollaborationAnalysisTemplateCommand";
30
+ export * from "./GetCollaborationChangeRequestCommand";
29
31
  export * from "./GetCollaborationCommand";
30
32
  export * from "./GetCollaborationConfiguredAudienceModelAssociationCommand";
31
33
  export * from "./GetCollaborationIdNamespaceAssociationCommand";
@@ -45,6 +47,7 @@ export * from "./GetSchemaAnalysisRuleCommand";
45
47
  export * from "./GetSchemaCommand";
46
48
  export * from "./ListAnalysisTemplatesCommand";
47
49
  export * from "./ListCollaborationAnalysisTemplatesCommand";
50
+ export * from "./ListCollaborationChangeRequestsCommand";
48
51
  export * from "./ListCollaborationConfiguredAudienceModelAssociationsCommand";
49
52
  export * from "./ListCollaborationIdNamespaceAssociationsCommand";
50
53
  export * from "./ListCollaborationPrivacyBudgetTemplatesCommand";