@aws-sdk/client-cleanrooms 3.1107.0 → 3.1109.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 (59) hide show
  1. package/README.md +21 -0
  2. package/dist-cjs/index.js +183 -41
  3. package/dist-es/CleanRooms.js +8 -0
  4. package/dist-es/commands/GetAnalysisLogExportCommand.js +4 -0
  5. package/dist-es/commands/ListAnalysisLogExportsCommand.js +4 -0
  6. package/dist-es/commands/StartAnalysisLogExportCommand.js +4 -0
  7. package/dist-es/commands/index.js +3 -0
  8. package/dist-es/models/enums.js +13 -0
  9. package/dist-es/pagination/ListAnalysisLogExportsPaginator.js +4 -0
  10. package/dist-es/pagination/index.js +1 -0
  11. package/dist-es/schemas/schemas_0.js +133 -40
  12. package/dist-types/CleanRooms.d.ts +28 -0
  13. package/dist-types/CleanRoomsClient.d.ts +5 -2
  14. package/dist-types/commands/CreateCollaborationChangeRequestCommand.d.ts +5 -5
  15. package/dist-types/commands/CreateCollaborationCommand.d.ts +4 -4
  16. package/dist-types/commands/CreateIntermediateTableAnalysisRuleCommand.d.ts +1 -1
  17. package/dist-types/commands/CreateIntermediateTableCommand.d.ts +1 -1
  18. package/dist-types/commands/CreateMembershipCommand.d.ts +1 -1
  19. package/dist-types/commands/DeleteIntermediateTableCommand.d.ts +1 -1
  20. package/dist-types/commands/DisallowIntermediateTableCommand.d.ts +1 -1
  21. package/dist-types/commands/GetAnalysisLogExportCommand.d.ts +107 -0
  22. package/dist-types/commands/GetCollaborationChangeRequestCommand.d.ts +3 -3
  23. package/dist-types/commands/GetCollaborationCommand.d.ts +1 -1
  24. package/dist-types/commands/GetMembershipCommand.d.ts +1 -1
  25. package/dist-types/commands/ListAnalysisLogExportsCommand.d.ts +99 -0
  26. package/dist-types/commands/ListCollaborationChangeRequestsCommand.d.ts +3 -3
  27. package/dist-types/commands/ListMembersCommand.d.ts +1 -1
  28. package/dist-types/commands/ListMembershipsCommand.d.ts +1 -1
  29. package/dist-types/commands/PopulateIntermediateTableCommand.d.ts +2 -2
  30. package/dist-types/commands/StartAnalysisLogExportCommand.d.ts +119 -0
  31. package/dist-types/commands/UpdateCollaborationChangeRequestCommand.d.ts +3 -3
  32. package/dist-types/commands/UpdateCollaborationCommand.d.ts +1 -1
  33. package/dist-types/commands/UpdateConfiguredTableAnalysisRuleCommand.d.ts +3 -0
  34. package/dist-types/commands/UpdateIntermediateTableAnalysisRuleCommand.d.ts +1 -2
  35. package/dist-types/commands/UpdateIntermediateTableCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateMembershipCommand.d.ts +1 -1
  37. package/dist-types/commands/index.d.ts +3 -0
  38. package/dist-types/models/enums.d.ts +29 -0
  39. package/dist-types/models/models_0.d.ts +143 -138
  40. package/dist-types/models/models_1.d.ts +238 -2
  41. package/dist-types/pagination/ListAnalysisLogExportsPaginator.d.ts +7 -0
  42. package/dist-types/pagination/index.d.ts +1 -0
  43. package/dist-types/schemas/schemas_0.d.ts +15 -0
  44. package/dist-types/ts3.4/CleanRooms.d.ts +58 -0
  45. package/dist-types/ts3.4/CleanRoomsClient.d.ts +18 -0
  46. package/dist-types/ts3.4/commands/GetAnalysisLogExportCommand.d.ts +39 -0
  47. package/dist-types/ts3.4/commands/ListAnalysisLogExportsCommand.d.ts +39 -0
  48. package/dist-types/ts3.4/commands/PopulateIntermediateTableCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/StartAnalysisLogExportCommand.d.ts +39 -0
  50. package/dist-types/ts3.4/commands/UpdateIntermediateTableAnalysisRuleCommand.d.ts +4 -2
  51. package/dist-types/ts3.4/commands/UpdateIntermediateTableCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  53. package/dist-types/ts3.4/models/enums.d.ts +17 -0
  54. package/dist-types/ts3.4/models/models_0.d.ts +34 -32
  55. package/dist-types/ts3.4/models/models_1.d.ts +69 -0
  56. package/dist-types/ts3.4/pagination/ListAnalysisLogExportsPaginator.d.ts +11 -0
  57. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  58. package/dist-types/ts3.4/schemas/schemas_0.d.ts +15 -0
  59. package/package.json +6 -6
@@ -0,0 +1,119 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { StartAnalysisLogExportInput, StartAnalysisLogExportOutput } from "../models/models_1";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link StartAnalysisLogExportCommand}.
11
+ */
12
+ export interface StartAnalysisLogExportCommandInput extends StartAnalysisLogExportInput {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link StartAnalysisLogExportCommand}.
18
+ */
19
+ export interface StartAnalysisLogExportCommandOutput extends StartAnalysisLogExportOutput, __MetadataBearer {
20
+ }
21
+ declare const StartAnalysisLogExportCommand_base: {
22
+ new (input: StartAnalysisLogExportCommandInput): import("@smithy/core/client").CommandImpl<StartAnalysisLogExportCommandInput, StartAnalysisLogExportCommandOutput, import("..").CleanRoomsClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: StartAnalysisLogExportCommandInput): import("@smithy/core/client").CommandImpl<StartAnalysisLogExportCommandInput, StartAnalysisLogExportCommandOutput, import("..").CleanRoomsClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Starts an export of the Apache Spark logs for a protected query to an Amazon S3 bucket that you own. Use the exported logs to diagnose a query that failed or that ran more slowly than you expected.</p> <p>Clean Rooms exports a redacted copy of the Spark logs instead of the raw logs. Analyze the exported logs with the tooling of your choice, such as Spark History Server. For details about what the exported logs contain, see <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/export-analysis-logs-contents.html">https://docs.aws.amazon.com/clean-rooms/latest/userguide/export-analysis-logs-contents.html</a>.</p> <p>The export runs asynchronously and returns with a <code>status</code> of <code>IN_PROGRESS</code>. Call <code>GetAnalysisLogExport</code> to poll for the final status.</p> <important> <p>To use this operation, you must have the <code>CAN_EXPORT_QUERY_ANALYSIS_LOG</code> ability for your membership. You must also be the query runner or the query payer. Having the ability alone is not sufficient.</p> <p>The query must have reached a terminal state, and it must have reached the execution stage. A query that failed validation or that was canceled before it started produces no Spark logs.</p> <p>Log export isn't supported for queries that use differential privacy, and isn't supported for PySpark jobs.</p> <p>The destination bucket must be in the same Amazon Web Services Region as the collaboration. Cross-Region export isn't supported.</p> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/export-analysis-logs.html">https://docs.aws.amazon.com/clean-rooms/latest/userguide/export-analysis-logs.html</a>.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { CleanRoomsClient, StartAnalysisLogExportCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
32
+ * // const { CleanRoomsClient, StartAnalysisLogExportCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
33
+ * // import type { CleanRoomsClientConfig } from "@aws-sdk/client-cleanrooms";
34
+ * const config = {}; // type is CleanRoomsClientConfig
35
+ * const client = new CleanRoomsClient(config);
36
+ * const input = { // StartAnalysisLogExportInput
37
+ * membershipIdentifier: "STRING_VALUE", // required
38
+ * analysisId: "STRING_VALUE", // required
39
+ * analysisType: "PROTECTED_QUERY", // required
40
+ * resultConfiguration: { // AnalysisLogExportResultConfiguration
41
+ * outputConfiguration: { // AnalysisLogExportOutputConfiguration
42
+ * s3: { // AnalysisLogExportS3OutputConfiguration
43
+ * bucket: "STRING_VALUE", // required
44
+ * keyPrefix: "STRING_VALUE",
45
+ * },
46
+ * },
47
+ * },
48
+ * };
49
+ * const command = new StartAnalysisLogExportCommand(input);
50
+ * const response = await client.send(command);
51
+ * // { // StartAnalysisLogExportOutput
52
+ * // analysisLogExport: { // AnalysisLogExport
53
+ * // analysisLogExportId: "STRING_VALUE", // required
54
+ * // analysisId: "STRING_VALUE", // required
55
+ * // analysisType: "PROTECTED_QUERY", // required
56
+ * // membershipId: "STRING_VALUE", // required
57
+ * // status: "IN_PROGRESS" || "SUCCESS" || "FAILED", // required
58
+ * // resultConfiguration: { // AnalysisLogExportResultConfiguration
59
+ * // outputConfiguration: { // AnalysisLogExportOutputConfiguration
60
+ * // s3: { // AnalysisLogExportS3OutputConfiguration
61
+ * // bucket: "STRING_VALUE", // required
62
+ * // keyPrefix: "STRING_VALUE",
63
+ * // },
64
+ * // },
65
+ * // },
66
+ * // createTime: new Date("TIMESTAMP"), // required
67
+ * // updateTime: new Date("TIMESTAMP"), // required
68
+ * // error: { // AnalysisLogExportError
69
+ * // code: "STRING_VALUE", // required
70
+ * // message: "STRING_VALUE", // required
71
+ * // },
72
+ * // },
73
+ * // };
74
+ *
75
+ * ```
76
+ *
77
+ * @param StartAnalysisLogExportCommandInput - {@link StartAnalysisLogExportCommandInput}
78
+ * @returns {@link StartAnalysisLogExportCommandOutput}
79
+ * @see {@link StartAnalysisLogExportCommandInput} for command's `input` shape.
80
+ * @see {@link StartAnalysisLogExportCommandOutput} for command's `response` shape.
81
+ * @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
82
+ *
83
+ * @throws {@link AccessDeniedException} (client fault)
84
+ * <p>Caller does not have sufficient access to perform this action.</p>
85
+ *
86
+ * @throws {@link InternalServerException} (server fault)
87
+ * <p>Unexpected error during processing of request.</p>
88
+ *
89
+ * @throws {@link ResourceNotFoundException} (client fault)
90
+ * <p>Request references a resource which does not exist.</p>
91
+ *
92
+ * @throws {@link ServiceQuotaExceededException} (client fault)
93
+ * <p>Request denied because service quota has been exceeded.</p>
94
+ *
95
+ * @throws {@link ThrottlingException} (client fault)
96
+ * <p>Request was denied due to request throttling.</p>
97
+ *
98
+ * @throws {@link ValidationException} (client fault)
99
+ * <p>The input fails to satisfy the specified constraints.</p>
100
+ *
101
+ * @throws {@link CleanRoomsServiceException}
102
+ * <p>Base exception class for all service exceptions from CleanRooms service.</p>
103
+ *
104
+ *
105
+ * @public
106
+ */
107
+ export declare class StartAnalysisLogExportCommand extends StartAnalysisLogExportCommand_base {
108
+ /** @internal type navigation helper, not in runtime. */
109
+ protected static __types: {
110
+ api: {
111
+ input: StartAnalysisLogExportInput;
112
+ output: StartAnalysisLogExportOutput;
113
+ };
114
+ sdk: {
115
+ input: StartAnalysisLogExportCommandInput;
116
+ output: StartAnalysisLogExportCommandOutput;
117
+ };
118
+ };
119
+ }
@@ -55,7 +55,7 @@ declare const UpdateCollaborationChangeRequestCommand_base: {
55
55
  * // member: { // MemberChangeSpecification
56
56
  * // accountId: "STRING_VALUE", // required
57
57
  * // memberAbilities: [ // MemberAbilities // required
58
- * // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
58
+ * // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB" || "CAN_EXPORT_QUERY_ANALYSIS_LOG",
59
59
  * // ],
60
60
  * // mlMemberAbilities: { // MLMemberAbilities
61
61
  * // customMLMemberAbilities: [ // CustomMLMemberAbilities // required
@@ -85,12 +85,12 @@ declare const UpdateCollaborationChangeRequestCommand_base: {
85
85
  * // },
86
86
  * // collaboration: { // CollaborationChangeSpecification
87
87
  * // autoApprovedChangeTypes: [ // AutoApprovedChangeTypeList
88
- * // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY",
88
+ * // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY" || "GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY" || "REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY",
89
89
  * // ],
90
90
  * // },
91
91
  * // },
92
92
  * // types: [ // ChangeTypeList // required
93
- * // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY" || "EDIT_AUTO_APPROVED_CHANGE_TYPES" || "ADD_PAYER_CANDIDATE" || "REMOVE_PAYER_CANDIDATE" || "GRANT_CAN_RECEIVE_MODEL_OUTPUT" || "GRANT_CAN_RECEIVE_INFERENCE_OUTPUT" || "REVOKE_CAN_RECEIVE_MODEL_OUTPUT" || "REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT",
93
+ * // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY" || "EDIT_AUTO_APPROVED_CHANGE_TYPES" || "ADD_PAYER_CANDIDATE" || "REMOVE_PAYER_CANDIDATE" || "GRANT_CAN_RECEIVE_MODEL_OUTPUT" || "GRANT_CAN_RECEIVE_INFERENCE_OUTPUT" || "REVOKE_CAN_RECEIVE_MODEL_OUTPUT" || "REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT" || "GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY" || "REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY",
94
94
  * // ],
95
95
  * // },
96
96
  * // ],
@@ -64,7 +64,7 @@ declare const UpdateCollaborationCommand_base: {
64
64
  * // jobLogStatus: "ENABLED" || "DISABLED",
65
65
  * // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
66
66
  * // autoApprovedChangeTypes: [ // AutoApprovedChangeTypeList
67
- * // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY",
67
+ * // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY" || "GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY" || "REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY",
68
68
  * // ],
69
69
  * // allowedResultRegions: [ // AllowedResultRegions
70
70
  * // "us-west-1" || "us-west-2" || "us-east-1" || "us-east-2" || "af-south-1" || "ap-east-1" || "ap-east-2" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ap-southeast-5" || "ap-southeast-4" || "ap-southeast-7" || "ap-south-1" || "ap-northeast-3" || "ap-northeast-1" || "ap-northeast-2" || "ca-central-1" || "ca-west-1" || "eu-south-1" || "eu-west-3" || "eu-south-2" || "eu-central-2" || "eu-central-1" || "eu-north-1" || "eu-west-1" || "eu-west-2" || "me-south-1" || "me-central-1" || "il-central-1" || "sa-east-1" || "mx-central-1",
@@ -213,6 +213,9 @@ declare const UpdateConfiguredTableAnalysisRuleCommand_base: {
213
213
  * @throws {@link ResourceNotFoundException} (client fault)
214
214
  * <p>Request references a resource which does not exist.</p>
215
215
  *
216
+ * @throws {@link ServiceQuotaExceededException} (client fault)
217
+ * <p>Request denied because service quota has been exceeded.</p>
218
+ *
216
219
  * @throws {@link ThrottlingException} (client fault)
217
220
  * <p>Request was denied due to request throttling.</p>
218
221
  *
@@ -1,6 +1,5 @@
1
1
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
- import type { UpdateIntermediateTableAnalysisRuleInput } from "../models/models_0";
3
- import type { UpdateIntermediateTableAnalysisRuleOutput } from "../models/models_1";
2
+ import type { UpdateIntermediateTableAnalysisRuleInput, UpdateIntermediateTableAnalysisRuleOutput } from "../models/models_1";
4
3
  /**
5
4
  * @public
6
5
  */
@@ -1,5 +1,5 @@
1
1
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
- import type { UpdateIntermediateTableInput, UpdateIntermediateTableOutput } from "../models/models_0";
2
+ import type { UpdateIntermediateTableInput, UpdateIntermediateTableOutput } from "../models/models_1";
3
3
  /**
4
4
  * @public
5
5
  */
@@ -92,7 +92,7 @@ declare const UpdateMembershipCommand_base: {
92
92
  * // updateTime: new Date("TIMESTAMP"), // required
93
93
  * // status: "STRING_VALUE", // required
94
94
  * // memberAbilities: [ // MemberAbilities // required
95
- * // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
95
+ * // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB" || "CAN_EXPORT_QUERY_ANALYSIS_LOG",
96
96
  * // ],
97
97
  * // mlMemberAbilities: { // MLMemberAbilities
98
98
  * // customMLMemberAbilities: [ // CustomMLMemberAbilities // required
@@ -30,6 +30,7 @@ export * from "./DeleteMemberCommand";
30
30
  export * from "./DeleteMembershipCommand";
31
31
  export * from "./DeletePrivacyBudgetTemplateCommand";
32
32
  export * from "./DisallowIntermediateTableCommand";
33
+ export * from "./GetAnalysisLogExportCommand";
33
34
  export * from "./GetAnalysisTemplateCommand";
34
35
  export * from "./GetCollaborationAnalysisTemplateCommand";
35
36
  export * from "./GetCollaborationChangeRequestCommand";
@@ -52,6 +53,7 @@ export * from "./GetProtectedJobCommand";
52
53
  export * from "./GetProtectedQueryCommand";
53
54
  export * from "./GetSchemaAnalysisRuleCommand";
54
55
  export * from "./GetSchemaCommand";
56
+ export * from "./ListAnalysisLogExportsCommand";
55
57
  export * from "./ListAnalysisTemplatesCommand";
56
58
  export * from "./ListCollaborationAnalysisTemplatesCommand";
57
59
  export * from "./ListCollaborationChangeRequestsCommand";
@@ -78,6 +80,7 @@ export * from "./ListTagsForResourceCommand";
78
80
  export * from "./PopulateIdMappingTableCommand";
79
81
  export * from "./PopulateIntermediateTableCommand";
80
82
  export * from "./PreviewPrivacyImpactCommand";
83
+ export * from "./StartAnalysisLogExportCommand";
81
84
  export * from "./StartProtectedJobCommand";
82
85
  export * from "./StartProtectedQueryCommand";
83
86
  export * from "./TagResourceCommand";
@@ -129,6 +129,30 @@ export declare const AnalysisFormat: {
129
129
  * @public
130
130
  */
131
131
  export type AnalysisFormat = (typeof AnalysisFormat)[keyof typeof AnalysisFormat];
132
+ /**
133
+ * @public
134
+ * @enum
135
+ */
136
+ export declare const LogExportAnalysisType: {
137
+ readonly PROTECTED_QUERY: "PROTECTED_QUERY";
138
+ };
139
+ /**
140
+ * @public
141
+ */
142
+ export type LogExportAnalysisType = (typeof LogExportAnalysisType)[keyof typeof LogExportAnalysisType];
143
+ /**
144
+ * @public
145
+ * @enum
146
+ */
147
+ export declare const AnalysisLogExportStatus: {
148
+ readonly FAILED: "FAILED";
149
+ readonly IN_PROGRESS: "IN_PROGRESS";
150
+ readonly SUCCESS: "SUCCESS";
151
+ };
152
+ /**
153
+ * @public
154
+ */
155
+ export type AnalysisLogExportStatus = (typeof AnalysisLogExportStatus)[keyof typeof AnalysisLogExportStatus];
132
156
  /**
133
157
  * @public
134
158
  * @enum
@@ -425,7 +449,9 @@ export type CommercialRegion = (typeof CommercialRegion)[keyof typeof Commercial
425
449
  */
426
450
  export declare const AutoApprovedChangeType: {
427
451
  readonly ADD_MEMBER: "ADD_MEMBER";
452
+ readonly GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY: "GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY";
428
453
  readonly GRANT_RECEIVE_RESULTS_ABILITY: "GRANT_RECEIVE_RESULTS_ABILITY";
454
+ readonly REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY: "REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY";
429
455
  readonly REVOKE_RECEIVE_RESULTS_ABILITY: "REVOKE_RECEIVE_RESULTS_ABILITY";
430
456
  };
431
457
  /**
@@ -524,6 +550,7 @@ export type SchemaType = (typeof SchemaType)[keyof typeof SchemaType];
524
550
  * @enum
525
551
  */
526
552
  export declare const MemberAbility: {
553
+ readonly CAN_EXPORT_QUERY_ANALYSIS_LOG: "CAN_EXPORT_QUERY_ANALYSIS_LOG";
527
554
  readonly CAN_QUERY: "CAN_QUERY";
528
555
  readonly CAN_RECEIVE_RESULTS: "CAN_RECEIVE_RESULTS";
529
556
  readonly CAN_RUN_JOB: "CAN_RUN_JOB";
@@ -604,10 +631,12 @@ export declare const ChangeType: {
604
631
  readonly EDIT_AUTO_APPROVED_CHANGE_TYPES: "EDIT_AUTO_APPROVED_CHANGE_TYPES";
605
632
  readonly GRANT_CAN_RECEIVE_INFERENCE_OUTPUT: "GRANT_CAN_RECEIVE_INFERENCE_OUTPUT";
606
633
  readonly GRANT_CAN_RECEIVE_MODEL_OUTPUT: "GRANT_CAN_RECEIVE_MODEL_OUTPUT";
634
+ readonly GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY: "GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY";
607
635
  readonly GRANT_RECEIVE_RESULTS_ABILITY: "GRANT_RECEIVE_RESULTS_ABILITY";
608
636
  readonly REMOVE_PAYER_CANDIDATE: "REMOVE_PAYER_CANDIDATE";
609
637
  readonly REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT: "REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT";
610
638
  readonly REVOKE_CAN_RECEIVE_MODEL_OUTPUT: "REVOKE_CAN_RECEIVE_MODEL_OUTPUT";
639
+ readonly REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY: "REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY";
611
640
  readonly REVOKE_RECEIVE_RESULTS_ABILITY: "REVOKE_RECEIVE_RESULTS_ABILITY";
612
641
  };
613
642
  /**
@@ -1,5 +1,5 @@
1
1
  import type { DocumentType as __DocumentType } from "@smithy/types";
2
- import type { AccessBudgetType, AdditionalAnalyses, AggregateFunctionName, AggregationType, AnalysisFormat, AnalysisMethod, AnalysisRuleType, AnalysisTemplateValidationStatus, AnalysisTemplateValidationType, AnalysisType, AnalyticsEngine, ApprovalStatus, AutoApprovedChangeType, AutoRefreshMode, BaseTableDependencyType, BaseTableParentType, ChangeRequestAction, ChangeRequestStatus, ChangeSpecificationType, ChangeType, ChildResourceType, CollaborationJobLogStatus, CollaborationQueryLogStatus, CommercialRegion, ConfiguredTableAnalysisRuleType, ConfiguredTableAssociationAnalysisRuleType, CustomMLMemberAbility, DifferentialPrivacyAggregationType, ErrorMessageType, FilterableMemberStatus, IdNamespaceType, IntermediateTableAnalysisRuleType, IntermediateTableStatus, IntermediateTableVersionStatus, JobType, JoinOperator, JoinRequiredOption, MemberAbility, MemberStatus, ParameterType, PopulateIntermediateTableAnalysisType, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetType, ResourceStatus, ScalarFunctions, SchemaConfiguration, SchemaStatus, SchemaStatusReasonCode, SchemaType, SelectedAnalysisMethod, SupportedS3Region, SyntheticDataColumnType, WorkerComputeType } from "./enums";
2
+ import type { AccessBudgetType, AdditionalAnalyses, AggregateFunctionName, AggregationType, AnalysisFormat, AnalysisLogExportStatus, AnalysisMethod, AnalysisRuleType, AnalysisTemplateValidationStatus, AnalysisTemplateValidationType, AnalysisType, AnalyticsEngine, ApprovalStatus, AutoApprovedChangeType, AutoRefreshMode, BaseTableDependencyType, BaseTableParentType, ChangeRequestAction, ChangeRequestStatus, ChangeSpecificationType, ChangeType, ChildResourceType, CollaborationJobLogStatus, CollaborationQueryLogStatus, CommercialRegion, ConfiguredTableAnalysisRuleType, ConfiguredTableAssociationAnalysisRuleType, CustomMLMemberAbility, DifferentialPrivacyAggregationType, ErrorMessageType, FilterableMemberStatus, IdNamespaceType, IntermediateTableAnalysisRuleType, IntermediateTableStatus, IntermediateTableVersionStatus, JobType, JoinOperator, JoinRequiredOption, LogExportAnalysisType, MemberAbility, MemberStatus, ParameterType, PopulateIntermediateTableAnalysisType, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetType, ResourceStatus, ScalarFunctions, SchemaConfiguration, SchemaStatus, SchemaStatusReasonCode, SchemaType, SelectedAnalysisMethod, SupportedS3Region, SyntheticDataColumnType, WorkerComputeType } from "./enums";
3
3
  /**
4
4
  * <p>Detailed information about an access budget including time bounds, budget allocation, and configuration settings.</p>
5
5
  * @public
@@ -158,6 +158,142 @@ export interface AggregationConstraint {
158
158
  */
159
159
  type: AggregationType | undefined;
160
160
  }
161
+ /**
162
+ * <p>The analysis log export error.</p>
163
+ * @public
164
+ */
165
+ export interface AnalysisLogExportError {
166
+ /**
167
+ * <p>The error code for the analysis log export.</p>
168
+ * @public
169
+ */
170
+ code: string | undefined;
171
+ /**
172
+ * <p>The message for the analysis log export error.</p>
173
+ * @public
174
+ */
175
+ message: string | undefined;
176
+ }
177
+ /**
178
+ * <p>Contains output information for an analysis log export with an S3 output type.</p> <p>The exported logs are written under the bucket and key prefix that you specify. The path includes the collaboration ID, the protected query ID, and the analysis log export ID. Because the path includes the export ID, exporting the same query more than once doesn't overwrite the logs from an earlier export.</p> <note> <p>The exported logs are encrypted using the default encryption configuration of the destination bucket. Clean Rooms doesn't accept a KMS key for log export. To encrypt the exported logs with a customer managed key, configure the bucket's default encryption to use that key before you export.</p> </note>
179
+ * @public
180
+ */
181
+ export interface AnalysisLogExportS3OutputConfiguration {
182
+ /**
183
+ * <p>The S3 bucket that the exported analysis logs are written to. The bucket must be in the same Amazon Web Services Region as the collaboration.</p>
184
+ * @public
185
+ */
186
+ bucket: string | undefined;
187
+ /**
188
+ * <p>The S3 key prefix under which the exported analysis logs are written.</p> <p>Only one export can be in progress at a time for a given query and destination. To export the same query twice at once, use a different key prefix for the second export.</p>
189
+ * @public
190
+ */
191
+ keyPrefix?: string | undefined;
192
+ }
193
+ /**
194
+ * <p>Contains configuration details for analysis log export output.</p>
195
+ * @public
196
+ */
197
+ export interface AnalysisLogExportOutputConfiguration {
198
+ /**
199
+ * <p>Required configuration for an analysis log export with an <code>s3</code> output type.</p>
200
+ * @public
201
+ */
202
+ s3: AnalysisLogExportS3OutputConfiguration | undefined;
203
+ }
204
+ /**
205
+ * <p>Contains configurations for analysis log export results.</p>
206
+ * @public
207
+ */
208
+ export interface AnalysisLogExportResultConfiguration {
209
+ /**
210
+ * <p>The configuration for analysis log export results.</p>
211
+ * @public
212
+ */
213
+ outputConfiguration: AnalysisLogExportOutputConfiguration | undefined;
214
+ }
215
+ /**
216
+ * <p>An export of the redacted Apache Spark logs for a protected query.</p>
217
+ * @public
218
+ */
219
+ export interface AnalysisLogExport {
220
+ /**
221
+ * <p>The unique identifier of the analysis log export.</p>
222
+ * @public
223
+ */
224
+ analysisLogExportId: string | undefined;
225
+ /**
226
+ * <p>The unique identifier of the protected query that the analysis logs were exported for.</p>
227
+ * @public
228
+ */
229
+ analysisId: string | undefined;
230
+ /**
231
+ * <p>The type of analysis that the logs were exported for. Currently, only <code>PROTECTED_QUERY</code> is supported.</p>
232
+ * @public
233
+ */
234
+ analysisType: LogExportAnalysisType | undefined;
235
+ /**
236
+ * <p>The unique identifier of the membership that the analysis log export belongs to.</p>
237
+ * @public
238
+ */
239
+ membershipId: string | undefined;
240
+ /**
241
+ * <p>The status of the analysis log export. Possible values are:</p> <ul> <li> <p> <code>IN_PROGRESS</code> – The export is currently running.</p> </li> <li> <p> <code>SUCCESS</code> – The export completed successfully.</p> </li> <li> <p> <code>FAILED</code> – The export failed. See the <code>error</code> field for details.</p> </li> </ul>
242
+ * @public
243
+ */
244
+ status: AnalysisLogExportStatus | undefined;
245
+ /**
246
+ * <p>Contains the details needed to write the exported analysis logs.</p>
247
+ * @public
248
+ */
249
+ resultConfiguration: AnalysisLogExportResultConfiguration | undefined;
250
+ /**
251
+ * <p>The time the analysis log export was created.</p>
252
+ * @public
253
+ */
254
+ createTime: Date | undefined;
255
+ /**
256
+ * <p>The time the analysis log export was last updated.</p>
257
+ * @public
258
+ */
259
+ updateTime: Date | undefined;
260
+ /**
261
+ * <p>The analysis log export error. This is present only when the export <code>status</code> is <code>FAILED</code>.</p>
262
+ * @public
263
+ */
264
+ error?: AnalysisLogExportError | undefined;
265
+ }
266
+ /**
267
+ * <p>A summary of an analysis log export, including its identifier, status, analysis type, and creation time. Returned by <code>ListAnalysisLogExports</code>.</p>
268
+ * @public
269
+ */
270
+ export interface AnalysisLogExportSummary {
271
+ /**
272
+ * <p>The unique identifier of the analysis log export.</p>
273
+ * @public
274
+ */
275
+ analysisLogExportId: string | undefined;
276
+ /**
277
+ * <p>The unique identifier of the protected query that the analysis logs were exported for.</p>
278
+ * @public
279
+ */
280
+ analysisId: string | undefined;
281
+ /**
282
+ * <p>The type of analysis that the logs were exported for. Currently, only <code>PROTECTED_QUERY</code> is supported.</p>
283
+ * @public
284
+ */
285
+ analysisType: LogExportAnalysisType | undefined;
286
+ /**
287
+ * <p>The status of the analysis log export. Possible values are:</p> <ul> <li> <p> <code>IN_PROGRESS</code> – The export is currently running.</p> </li> <li> <p> <code>SUCCESS</code> – The export completed successfully.</p> </li> <li> <p> <code>FAILED</code> – The export failed.</p> </li> </ul>
288
+ * @public
289
+ */
290
+ status: AnalysisLogExportStatus | undefined;
291
+ /**
292
+ * <p>The time the analysis log export was created.</p>
293
+ * @public
294
+ */
295
+ createTime: Date | undefined;
296
+ }
161
297
  /**
162
298
  * <p>Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.</p>
163
299
  * @public
@@ -2486,7 +2622,7 @@ export interface MemberChangeSpecification {
2486
2622
  */
2487
2623
  accountId: string | undefined;
2488
2624
  /**
2489
- * <p>The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.</p> <note> <p>The following values are currently not supported: <code>CAN_QUERY</code> and <code>CAN_RUN_JOB</code>. </p> <p>Set the value of <code>memberAbilities</code> to <code>[]</code> to allow a member to contribute data.</p> <p>Set the value of <code>memberAbilities</code> to <code>[CAN_RECEIVE_RESULTS]</code> to allow a member to contribute data and receive results.</p> </note>
2625
+ * <p>The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.</p> <note> <p>The following values are currently not supported: <code>CAN_QUERY</code> and <code>CAN_RUN_JOB</code>. </p> <p>Set the value of <code>memberAbilities</code> to <code>[]</code> to allow a member to contribute data.</p> <p>Set the value of <code>memberAbilities</code> to <code>[CAN_RECEIVE_RESULTS]</code> to allow a member to contribute data and receive results.</p> <p>Set the value of <code>memberAbilities</code> to <code>[CAN_EXPORT_QUERY_ANALYSIS_LOG]</code> so that the member can export the analysis logs for a protected query. Having this ability isn't sufficient on its own: You can export logs only for queries that you ran or paid for.</p> </note>
2490
2626
  * @public
2491
2627
  */
2492
2628
  memberAbilities: MemberAbility[] | undefined;
@@ -6263,7 +6399,7 @@ export interface UpdateIdNamespaceAssociationOutput {
6263
6399
  */
6264
6400
  export interface PopulationAnalysisSqlParameters {
6265
6401
  /**
6266
- * <p>The SQL query string used to populate the intermediate table. Maximum length of 500,000 characters.</p>
6402
+ * <p>The SQL query string used to populate the intermediate table.</p>
6267
6403
  * @public
6268
6404
  */
6269
6405
  queryString?: string | undefined;
@@ -6326,7 +6462,7 @@ export interface CreateIntermediateTableInput {
6326
6462
  */
6327
6463
  description?: string | undefined;
6328
6464
  /**
6329
- * <p>The configuration that defines the analysis used to populate the intermediate table. This configuration contains the SQL query or analysis template reference.</p>
6465
+ * <p>The configuration that defines the analysis used to populate the intermediate table.</p>
6330
6466
  * @public
6331
6467
  */
6332
6468
  populationAnalysisConfiguration: PopulationAnalysisConfiguration | undefined;
@@ -6336,7 +6472,7 @@ export interface CreateIntermediateTableInput {
6336
6472
  */
6337
6473
  kmsKeyArn?: string | undefined;
6338
6474
  /**
6339
- * <p>The number of days to retain populated data versions. Minimum value of 1, maximum value of 365.</p>
6475
+ * <p>The number of days to retain populated data versions.</p>
6340
6476
  * @public
6341
6477
  */
6342
6478
  retentionInDays?: number | undefined;
@@ -6638,7 +6774,7 @@ export interface IntermediateTableDependency {
6638
6774
  */
6639
6775
  type: BaseTableDependencyType | undefined;
6640
6776
  /**
6641
- * <p>Whether the dependency is direct or indirect. A direct dependency is a table explicitly referenced in the stored query, while an indirect dependency is referenced through another intermediate table.</p>
6777
+ * <p>The type of dependency, either direct or indirect. A direct dependency is a table explicitly referenced in the stored query. An indirect dependency is a table referenced through another intermediate table.</p>
6642
6778
  * @public
6643
6779
  */
6644
6780
  parentType: BaseTableParentType | undefined;
@@ -7289,7 +7425,7 @@ export interface WorkerComputeConfiguration {
7289
7425
  properties?: WorkerComputeConfigurationProperties | undefined;
7290
7426
  }
7291
7427
  /**
7292
- * <p>The compute configuration for an intermediate table population operation.</p>
7428
+ * <p>Contains the compute configuration for an intermediate table population operation.</p>
7293
7429
  * @public
7294
7430
  */
7295
7431
  export type IntermediateTableComputeConfiguration = IntermediateTableComputeConfiguration.QueryComputeConfigurationMember | IntermediateTableComputeConfiguration.$UnknownMember;
@@ -7321,134 +7457,3 @@ export declare namespace IntermediateTableComputeConfiguration {
7321
7457
  _: (name: string, value: any) => T;
7322
7458
  }
7323
7459
  }
7324
- /**
7325
- * @public
7326
- */
7327
- export interface PopulateIntermediateTableInput {
7328
- /**
7329
- * <p>The unique identifier of the intermediate table to populate.</p>
7330
- * @public
7331
- */
7332
- intermediateTableIdentifier: string | undefined;
7333
- /**
7334
- * <p>The unique identifier of the membership that contains the intermediate table.</p>
7335
- * @public
7336
- */
7337
- membershipIdentifier: string | undefined;
7338
- /**
7339
- * <p>The runtime parameter values that override the defaults in the stored query.</p>
7340
- * @public
7341
- */
7342
- parameters?: Record<string, string> | undefined;
7343
- /**
7344
- * <p>The compute configuration for the population query execution.</p>
7345
- * @public
7346
- */
7347
- computeConfiguration?: IntermediateTableComputeConfiguration | undefined;
7348
- /**
7349
- * <p>The account ID of the member that pays for the analysis compute costs.</p>
7350
- * @public
7351
- */
7352
- analysisPayerAccountId?: string | undefined;
7353
- }
7354
- /**
7355
- * @public
7356
- */
7357
- export interface PopulateIntermediateTableOutput {
7358
- /**
7359
- * <p>The identifier for the protected query execution. Use this value with <code>GetProtectedQuery</code> to track the population progress.</p>
7360
- * @public
7361
- */
7362
- analysisId: string | undefined;
7363
- /**
7364
- * <p>The type of analysis performed to populate the intermediate table.</p>
7365
- * @public
7366
- */
7367
- analysisType: PopulateIntermediateTableAnalysisType | undefined;
7368
- /**
7369
- * <p>The unique identifier of the version created by this population operation.</p>
7370
- * @public
7371
- */
7372
- versionId: string | undefined;
7373
- }
7374
- /**
7375
- * <p>Contains the name and type of a column in an intermediate table.</p>
7376
- * @public
7377
- */
7378
- export interface IntermediateTableColumn {
7379
- /**
7380
- * <p>The name of the column.</p>
7381
- * @public
7382
- */
7383
- name: string | undefined;
7384
- /**
7385
- * <p>The data type of the column.</p>
7386
- * @public
7387
- */
7388
- type: string | undefined;
7389
- }
7390
- /**
7391
- * @public
7392
- */
7393
- export interface UpdateIntermediateTableInput {
7394
- /**
7395
- * <p>The unique identifier of the intermediate table to update.</p>
7396
- * @public
7397
- */
7398
- intermediateTableIdentifier: string | undefined;
7399
- /**
7400
- * <p>The unique identifier of the membership that contains the intermediate table.</p>
7401
- * @public
7402
- */
7403
- membershipIdentifier: string | undefined;
7404
- /**
7405
- * <p>A new description for the intermediate table.</p>
7406
- * @public
7407
- */
7408
- description?: string | undefined;
7409
- /**
7410
- * <p>The Amazon Resource Name (ARN) of the customer-managed KMS key to use for encrypting future population data.</p>
7411
- * @public
7412
- */
7413
- kmsKeyArn?: string | undefined;
7414
- /**
7415
- * <p>The list of columns with updated type definitions. Only the type of existing columns can be updated.</p>
7416
- * @public
7417
- */
7418
- columns?: IntermediateTableColumn[] | undefined;
7419
- }
7420
- /**
7421
- * @public
7422
- */
7423
- export interface UpdateIntermediateTableOutput {
7424
- /**
7425
- * <p>The updated intermediate table.</p>
7426
- * @public
7427
- */
7428
- intermediateTable: IntermediateTable | undefined;
7429
- }
7430
- /**
7431
- * @public
7432
- */
7433
- export interface UpdateIntermediateTableAnalysisRuleInput {
7434
- /**
7435
- * <p>The unique identifier of the membership that contains the intermediate table.</p>
7436
- * @public
7437
- */
7438
- membershipIdentifier: string | undefined;
7439
- /**
7440
- * <p>The unique identifier of the intermediate table for which to update the analysis rule.</p>
7441
- * @public
7442
- */
7443
- intermediateTableIdentifier: string | undefined;
7444
- /**
7445
- * <p>The type of analysis rule to update. Currently, only <code>CUSTOM</code> is supported.</p>
7446
- * @public
7447
- */
7448
- analysisRuleType: IntermediateTableAnalysisRuleType | undefined;
7449
- /**
7450
- * <p>The updated analysis rule policy for the intermediate table.</p>
7451
- * @public
7452
- */
7453
- analysisRulePolicy: IntermediateTableAnalysisRulePolicy | undefined;
7454
- }