From 915b7c97fad83bbc3a22e22758f16290ff662db4 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 30 Aug 2023 18:27:44 +0000 Subject: [PATCH] feat(client-cleanrooms): This release decouples member abilities in a collaboration. With this change, the member who can run queries no longer needs to be the same as the member who can receive results. --- clients/client-cleanrooms/README.md | 12 +- clients/client-cleanrooms/src/CleanRooms.ts | 14 +- .../client-cleanrooms/src/CleanRoomsClient.ts | 14 +- ...GetCollaborationAnalysisTemplateCommand.ts | 3 +- .../src/commands/CreateMembershipCommand.ts | 20 + .../src/commands/GetMembershipCommand.ts | 10 + .../src/commands/GetProtectedQueryCommand.ts | 5 + .../commands/StartProtectedQueryCommand.ts | 7 +- .../src/commands/UpdateMembershipCommand.ts | 20 + .../commands/UpdateProtectedQueryCommand.ts | 5 + clients/client-cleanrooms/src/index.ts | 14 +- .../client-cleanrooms/src/models/models_0.ts | 500 +++++++++++++----- .../src/protocols/Aws_restJson1.ts | 17 + .../sdk-codegen/aws-models/cleanrooms.json | 391 +++++++++----- 14 files changed, 717 insertions(+), 315 deletions(-) diff --git a/clients/client-cleanrooms/README.md b/clients/client-cleanrooms/README.md index 2610238e40653..e6324d477a9eb 100644 --- a/clients/client-cleanrooms/README.md +++ b/clients/client-cleanrooms/README.md @@ -7,12 +7,14 @@ AWS SDK for JavaScript CleanRooms Client for Node.js, Browser and React Native.

Welcome to the Clean Rooms API Reference.

-

Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data -together in a secure collaboration workspace. In the collaboration, members who can query -and receive results can get insights into the collective datasets without either party getting -access to the other party's raw data.

-

To learn more about Clean Rooms concepts, procedures, and best practices, see the +

Clean Rooms is an Amazon Web Services service that helps multiple parties to join +their data together in a secure collaboration workspace. In the collaboration, members who +can query and receive results can get insights into the collective datasets without either +party getting access to the other party's raw data.

+

To learn more about Clean Rooms concepts, procedures, and best practices, see the Clean Rooms User Guide.

+

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the +Clean Rooms SQL Reference.

## Installing diff --git a/clients/client-cleanrooms/src/CleanRooms.ts b/clients/client-cleanrooms/src/CleanRooms.ts index 457a746c50794..8cae7f90ed3af 100644 --- a/clients/client-cleanrooms/src/CleanRooms.ts +++ b/clients/client-cleanrooms/src/CleanRooms.ts @@ -983,12 +983,14 @@ export interface CleanRooms { /** * @public *

Welcome to the Clean Rooms API Reference.

- *

Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data - * together in a secure collaboration workspace. In the collaboration, members who can query - * and receive results can get insights into the collective datasets without either party getting - * access to the other party's raw data.

- *

To learn more about Clean Rooms concepts, procedures, and best practices, see the - * Clean Rooms User Guide.

+ *

Clean Rooms is an Amazon Web Services service that helps multiple parties to join + * their data together in a secure collaboration workspace. In the collaboration, members who + * can query and receive results can get insights into the collective datasets without either + * party getting access to the other party's raw data.

+ *

To learn more about Clean Rooms concepts, procedures, and best practices, see the + * Clean Rooms User Guide.

+ *

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the + * Clean Rooms SQL Reference.

*/ export class CleanRooms extends CleanRoomsClient implements CleanRooms {} createAggregatedClient(commands, CleanRooms); diff --git a/clients/client-cleanrooms/src/CleanRoomsClient.ts b/clients/client-cleanrooms/src/CleanRoomsClient.ts index ef9279e12e0c6..9f5b611485ea3 100644 --- a/clients/client-cleanrooms/src/CleanRoomsClient.ts +++ b/clients/client-cleanrooms/src/CleanRoomsClient.ts @@ -464,12 +464,14 @@ export interface CleanRoomsClientResolvedConfig extends CleanRoomsClientResolved /** * @public *

Welcome to the Clean Rooms API Reference.

- *

Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data - * together in a secure collaboration workspace. In the collaboration, members who can query - * and receive results can get insights into the collective datasets without either party getting - * access to the other party's raw data.

- *

To learn more about Clean Rooms concepts, procedures, and best practices, see the - * Clean Rooms User Guide.

+ *

Clean Rooms is an Amazon Web Services service that helps multiple parties to join + * their data together in a secure collaboration workspace. In the collaboration, members who + * can query and receive results can get insights into the collective datasets without either + * party getting access to the other party's raw data.

+ *

To learn more about Clean Rooms concepts, procedures, and best practices, see the + * Clean Rooms User Guide.

+ *

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the + * Clean Rooms SQL Reference.

*/ export class CleanRoomsClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts b/clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts index d5478ac2413b6..7199349480f76 100644 --- a/clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts +++ b/clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts @@ -45,7 +45,8 @@ export interface BatchGetCollaborationAnalysisTemplateCommandOutput /** * @public - *

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

+ *

Retrieves multiple analysis templates within a collaboration by their Amazon Resource + * Names (ARNs).

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts b/clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts index 40e773b74cf5a..db8df2db54437 100644 --- a/clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts +++ b/clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts @@ -50,6 +50,16 @@ export interface CreateMembershipCommandOutput extends CreateMembershipOutput, _ * tags: { // TagMap * "": "STRING_VALUE", * }, + * defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration + * outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present + * s3: { // ProtectedQueryS3OutputConfiguration + * resultFormat: "STRING_VALUE", // required + * bucket: "STRING_VALUE", // required + * keyPrefix: "STRING_VALUE", + * }, + * }, + * roleArn: "STRING_VALUE", + * }, * }; * const command = new CreateMembershipCommand(input); * const response = await client.send(command); @@ -69,6 +79,16 @@ export interface CreateMembershipCommandOutput extends CreateMembershipOutput, _ * // "STRING_VALUE", * // ], * // queryLogStatus: "STRING_VALUE", // required + * // defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration + * // outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present + * // s3: { // ProtectedQueryS3OutputConfiguration + * // resultFormat: "STRING_VALUE", // required + * // bucket: "STRING_VALUE", // required + * // keyPrefix: "STRING_VALUE", + * // }, + * // }, + * // roleArn: "STRING_VALUE", + * // }, * // }, * // }; * diff --git a/clients/client-cleanrooms/src/commands/GetMembershipCommand.ts b/clients/client-cleanrooms/src/commands/GetMembershipCommand.ts index 0db64c213c901..3801b1060a637 100644 --- a/clients/client-cleanrooms/src/commands/GetMembershipCommand.ts +++ b/clients/client-cleanrooms/src/commands/GetMembershipCommand.ts @@ -64,6 +64,16 @@ export interface GetMembershipCommandOutput extends GetMembershipOutput, __Metad * // "STRING_VALUE", * // ], * // queryLogStatus: "STRING_VALUE", // required + * // defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration + * // outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present + * // s3: { // ProtectedQueryS3OutputConfiguration + * // resultFormat: "STRING_VALUE", // required + * // bucket: "STRING_VALUE", // required + * // keyPrefix: "STRING_VALUE", + * // }, + * // }, + * // roleArn: "STRING_VALUE", + * // }, * // }, * // }; * diff --git a/clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts b/clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts index b1adc323e0f4f..27d70d8787389 100644 --- a/clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts +++ b/clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts @@ -84,6 +84,11 @@ export interface GetProtectedQueryCommandOutput extends GetProtectedQueryOutput, * // s3: { // ProtectedQueryS3Output * // location: "STRING_VALUE", // required * // }, + * // memberList: [ // ProtectedQueryMemberOutputList + * // { // ProtectedQuerySingleMemberOutput + * // accountId: "STRING_VALUE", // required + * // }, + * // ], * // }, * // }, * // error: { // ProtectedQueryError diff --git a/clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts b/clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts index fc1a20ed6607c..ee7139d1b3979 100644 --- a/clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts +++ b/clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts @@ -41,7 +41,7 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut /** * @public - *

Creates a protected query that is started by Clean Rooms .

+ *

Creates a protected query that is started by Clean Rooms.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -101,6 +101,11 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut * // s3: { // ProtectedQueryS3Output * // location: "STRING_VALUE", // required * // }, + * // memberList: [ // ProtectedQueryMemberOutputList + * // { // ProtectedQuerySingleMemberOutput + * // accountId: "STRING_VALUE", // required + * // }, + * // ], * // }, * // }, * // error: { // ProtectedQueryError diff --git a/clients/client-cleanrooms/src/commands/UpdateMembershipCommand.ts b/clients/client-cleanrooms/src/commands/UpdateMembershipCommand.ts index 9834f96321641..00a62c3b0d42a 100644 --- a/clients/client-cleanrooms/src/commands/UpdateMembershipCommand.ts +++ b/clients/client-cleanrooms/src/commands/UpdateMembershipCommand.ts @@ -46,6 +46,16 @@ export interface UpdateMembershipCommandOutput extends UpdateMembershipOutput, _ * const input = { // UpdateMembershipInput * membershipIdentifier: "STRING_VALUE", // required * queryLogStatus: "STRING_VALUE", + * defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration + * outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present + * s3: { // ProtectedQueryS3OutputConfiguration + * resultFormat: "STRING_VALUE", // required + * bucket: "STRING_VALUE", // required + * keyPrefix: "STRING_VALUE", + * }, + * }, + * roleArn: "STRING_VALUE", + * }, * }; * const command = new UpdateMembershipCommand(input); * const response = await client.send(command); @@ -65,6 +75,16 @@ export interface UpdateMembershipCommandOutput extends UpdateMembershipOutput, _ * // "STRING_VALUE", * // ], * // queryLogStatus: "STRING_VALUE", // required + * // defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration + * // outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present + * // s3: { // ProtectedQueryS3OutputConfiguration + * // resultFormat: "STRING_VALUE", // required + * // bucket: "STRING_VALUE", // required + * // keyPrefix: "STRING_VALUE", + * // }, + * // }, + * // roleArn: "STRING_VALUE", + * // }, * // }, * // }; * diff --git a/clients/client-cleanrooms/src/commands/UpdateProtectedQueryCommand.ts b/clients/client-cleanrooms/src/commands/UpdateProtectedQueryCommand.ts index f14195c006189..371d78154119e 100644 --- a/clients/client-cleanrooms/src/commands/UpdateProtectedQueryCommand.ts +++ b/clients/client-cleanrooms/src/commands/UpdateProtectedQueryCommand.ts @@ -85,6 +85,11 @@ export interface UpdateProtectedQueryCommandOutput extends UpdateProtectedQueryO * // s3: { // ProtectedQueryS3Output * // location: "STRING_VALUE", // required * // }, + * // memberList: [ // ProtectedQueryMemberOutputList + * // { // ProtectedQuerySingleMemberOutput + * // accountId: "STRING_VALUE", // required + * // }, + * // ], * // }, * // }, * // error: { // ProtectedQueryError diff --git a/clients/client-cleanrooms/src/index.ts b/clients/client-cleanrooms/src/index.ts index 8971e13030246..f9ce703443d08 100644 --- a/clients/client-cleanrooms/src/index.ts +++ b/clients/client-cleanrooms/src/index.ts @@ -2,12 +2,14 @@ /* eslint-disable */ /** *

Welcome to the Clean Rooms API Reference.

- *

Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data - * together in a secure collaboration workspace. In the collaboration, members who can query - * and receive results can get insights into the collective datasets without either party getting - * access to the other party's raw data.

- *

To learn more about Clean Rooms concepts, procedures, and best practices, see the - * Clean Rooms User Guide.

+ *

Clean Rooms is an Amazon Web Services service that helps multiple parties to join + * their data together in a secure collaboration workspace. In the collaboration, members who + * can query and receive results can get insights into the collective datasets without either + * party getting access to the other party's raw data.

+ *

To learn more about Clean Rooms concepts, procedures, and best practices, see the + * Clean Rooms User Guide.

+ *

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the + * Clean Rooms SQL Reference.

* * @packageDocumentation */ diff --git a/clients/client-cleanrooms/src/models/models_0.ts b/clients/client-cleanrooms/src/models/models_0.ts index 8a4b7fb6294ac..9528c634ffa07 100644 --- a/clients/client-cleanrooms/src/models/models_0.ts +++ b/clients/client-cleanrooms/src/models/models_0.ts @@ -94,12 +94,14 @@ export type AggregationType = (typeof AggregationType)[keyof typeof AggregationT /** * @public - *

Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.

+ *

Constraint on query output removing output rows that do not meet a minimum number of + * distinct values of a specified column.

*/ export interface AggregationConstraint { /** * @public - *

Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

+ *

Column in aggregation constraint for which there must be a minimum number of distinct + * values in an output row for it to be in the query output.

*/ columnName: string | undefined; @@ -180,8 +182,8 @@ export type ParameterType = (typeof ParameterType)[keyof typeof ParameterType]; export interface AnalysisParameter { /** * @public - *

The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) - * characters but cannot start or end with a hyphen.

+ *

The name of the parameter. The name must use only alphanumeric, underscore (_), or + * hyphen (-) characters but cannot start or end with a hyphen.

*/ name: string | undefined; @@ -253,7 +255,8 @@ export type ScalarFunctions = (typeof ScalarFunctions)[keyof typeof ScalarFuncti /** * @public - *

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

+ *

A type of analysis rule that enables query structure and specified queries that produce + * aggregate statistics.

*/ export interface AnalysisRuleAggregation { /** @@ -291,20 +294,23 @@ export interface AnalysisRuleAggregation { /** * @public - *

Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

+ *

Set of scalar functions that are allowed to be used on dimension columns and the output + * of aggregation of metrics.

*/ scalarFunctions: (ScalarFunctions | string)[] | undefined; /** * @public - *

Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

+ *

Columns that must meet a specific threshold value (after an aggregation function is + * applied to it) for each output row to be returned.

*/ outputConstraints: AggregationConstraint[] | undefined; } /** * @public - *

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.

+ *

A type of analysis rule that enables the table owner to approve custom SQL queries on + * their configured tables.

*/ export interface AnalysisRuleCustom { /** @@ -328,7 +334,8 @@ export interface AnalysisRuleCustom { export interface AnalysisRuleList { /** * @public - *

Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.

+ *

Columns that can be used to join a configured table with the table of the member who can + * query and other members' configured tables.

*/ joinColumns: string[] | undefined; @@ -762,7 +769,10 @@ export interface CreateAnalysisTemplateInput { /** * @public - *

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

+ *

An optional label that you can assign to a resource when you create it. Each tag + * consists of a key and an optional value, both of which you define. When you use tagging, + * you can also use tag-based access control in IAM policies to control access + * to this resource.

*/ tags?: Record; @@ -1022,7 +1032,8 @@ export interface ListAnalysisTemplatesInput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -1088,7 +1099,8 @@ export interface AnalysisTemplateSummary { /** * @public - *

A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.

+ *

A unique identifier for the collaboration that the analysis template summary belongs to. + * Currently accepts collaboration ID.

*/ collaborationId: string | undefined; @@ -1105,7 +1117,8 @@ export interface AnalysisTemplateSummary { export interface ListAnalysisTemplatesOutput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -1156,13 +1169,15 @@ export interface UpdateAnalysisTemplateOutput { export interface BatchGetCollaborationAnalysisTemplateInput { /** * @public - *

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

+ *

A unique identifier for the collaboration that the analysis templates belong to. + * Currently accepts collaboration ID.

*/ collaborationIdentifier: string | undefined; /** * @public - *

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

+ *

The Amazon Resource Name (ARN) associated with the analysis template within a + * collaboration.

*/ analysisTemplateArns: string[] | undefined; } @@ -1186,7 +1201,8 @@ export interface CollaborationAnalysisTemplate { /** * @public - *

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

+ *

A unique identifier for the collaboration that the analysis templates belong to. + * Currently accepts collaboration ID.

*/ collaborationId: string | undefined; @@ -1204,7 +1220,8 @@ export interface CollaborationAnalysisTemplate { /** * @public - *

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

+ *

The identifier used to reference members of the collaboration. Currently only supports + * Amazon Web Services account ID.

*/ creatorAccountId: string | undefined; @@ -1253,7 +1270,8 @@ export interface CollaborationAnalysisTemplate { /** * @public - *

Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.

+ *

Details of errors thrown by the call to retrieve multiple analysis templates within a + * collaboration by their identifiers.

*/ export interface BatchGetCollaborationAnalysisTemplateError { /** @@ -1287,7 +1305,9 @@ export interface BatchGetCollaborationAnalysisTemplateOutput { /** * @public - *

Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.

+ *

Error reasons for collaboration analysis templates that could not be retrieved. One + * error is returned for every collaboration analysis template that could not be + * retrieved.

*/ errors: BatchGetCollaborationAnalysisTemplateError[] | undefined; } @@ -1336,7 +1356,8 @@ export interface BatchGetSchemaError { /** * @public - *

A column within a schema relation, derived from the underlying Glue table.

+ *

A column within a schema relation, derived from the underlying Glue + * table.

*/ export interface Column { /** @@ -1384,7 +1405,8 @@ export interface Schema { /** * @public - *

The analysis rule types associated with the schema. Currently, only one entry is present.

+ *

The analysis rule types associated with the schema. Currently, only one entry is + * present.

*/ analysisRuleTypes: (AnalysisRuleType | string)[] | undefined; @@ -1403,7 +1425,8 @@ export interface Schema { /** * @public - *

A name for the schema. The schema relation is referred to by this name when queried by a protected query.

+ *

A name for the schema. The schema relation is referred to by this name when queried by a + * protected query.

*/ name: string | undefined; @@ -1483,25 +1506,30 @@ export type MemberAbility = (typeof MemberAbility)[keyof typeof MemberAbility]; export interface DataEncryptionMetadata { /** * @public - *

Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).

+ *

Indicates whether encrypted tables can contain cleartext data (true) or are to + * cryptographically process every column (false).

*/ allowCleartext: boolean | undefined; /** * @public - *

Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).

+ *

Indicates whether Fingerprint columns can contain duplicate entries (true) or are to + * contain only non-repeated values (false).

*/ allowDuplicates: boolean | undefined; /** * @public - *

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).

+ *

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with + * a different name (true) or can only be joined on Fingerprint columns of the same name + * (false).

*/ allowJoinsOnColumnsWithDifferentNames: boolean | undefined; /** * @public - *

Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).

+ *

Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or + * cryptographically processed (false).

*/ preserveNulls: boolean | undefined; } @@ -1513,7 +1541,8 @@ export interface DataEncryptionMetadata { export interface MemberSpecification { /** * @public - *

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

+ *

The identifier used to reference members of the collaboration. Currently only supports + * Amazon Web Services account ID.

*/ accountId: string | undefined; @@ -1581,7 +1610,8 @@ export interface CreateCollaborationInput { /** * @public - *

The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

+ *

The settings for client-side encryption with Cryptographic Computing for Clean + * Rooms.

*/ dataEncryptionMetadata?: DataEncryptionMetadata; @@ -1596,8 +1626,8 @@ export interface CreateCollaborationInput { * @public *

An optional label that you can assign to a resource when you create it. Each tag * consists of a key and an optional value, both of which you define. When you use tagging, - * you can also use tag-based access control in IAM policies to control access to this - * resource.

+ * you can also use tag-based access control in IAM policies to control access + * to this resource.

*/ tags?: Record; } @@ -1620,7 +1650,8 @@ export type MemberStatus = (typeof MemberStatus)[keyof typeof MemberStatus]; /** * @public - *

The multi-party data share environment. The collaboration contains metadata about its purpose and participants.

+ *

The multi-party data share environment. The collaboration contains metadata about its + * purpose and participants.

*/ export interface Collaboration { /** @@ -1637,7 +1668,8 @@ export interface Collaboration { /** * @public - *

A human-readable identifier provided by the collaboration owner. Display names are not unique.

+ *

A human-readable identifier provided by the collaboration owner. Display names are not + * unique.

*/ name: string | undefined; @@ -1649,7 +1681,8 @@ export interface Collaboration { /** * @public - *

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

+ *

The identifier used to reference members of the collaboration. Currently only supports + * Amazon Web Services account ID.

*/ creatorAccountId: string | undefined; @@ -1780,13 +1813,15 @@ export interface GetCollaborationOutput { export interface GetCollaborationAnalysisTemplateInput { /** * @public - *

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

+ *

A unique identifier for the collaboration that the analysis templates belong to. + * Currently accepts collaboration ID.

*/ collaborationIdentifier: string | undefined; /** * @public - *

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

+ *

The Amazon Resource Name (ARN) associated with the analysis template within a + * collaboration.

*/ analysisTemplateArn: string | undefined; } @@ -1850,7 +1885,8 @@ export interface GetSchemaAnalysisRuleInput { /** * @public - *

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

+ *

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely + * identified by a combination of the collaboration, the schema name, and their type.

*/ type: AnalysisRuleType | string | undefined; } @@ -1872,13 +1908,15 @@ export interface GetSchemaAnalysisRuleOutput { export interface ListCollaborationAnalysisTemplatesInput { /** * @public - *

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

+ *

A unique identifier for the collaboration that the analysis templates belong to. + * Currently accepts collaboration ID.

*/ collaborationIdentifier: string | undefined; /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -1902,7 +1940,8 @@ export interface CollaborationAnalysisTemplateSummary { /** * @public - *

The time that the summary of the analysis template in a collaboration was created.

+ *

The time that the summary of the analysis template in a collaboration was + * created.

*/ createTime: Date | undefined; @@ -1920,7 +1959,8 @@ export interface CollaborationAnalysisTemplateSummary { /** * @public - *

The time that the summary of the analysis template in the collaboration was last updated.

+ *

The time that the summary of the analysis template in the collaboration was last + * updated.

*/ updateTime: Date | undefined; @@ -1932,13 +1972,15 @@ export interface CollaborationAnalysisTemplateSummary { /** * @public - *

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

+ *

A unique identifier for the collaboration that the analysis templates belong to. + * Currently accepts collaboration ID.

*/ collaborationId: string | undefined; /** * @public - *

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

+ *

The identifier used to reference members of the collaboration. Currently only supports + * Amazon Web Services account ID.

*/ creatorAccountId: string | undefined; @@ -1955,7 +1997,8 @@ export interface CollaborationAnalysisTemplateSummary { export interface ListCollaborationAnalysisTemplatesOutput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -1986,7 +2029,8 @@ export type FilterableMemberStatus = (typeof FilterableMemberStatus)[keyof typeo export interface ListCollaborationsInput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -2024,13 +2068,15 @@ export interface CollaborationSummary { /** * @public - *

A human-readable identifier provided by the collaboration owner. Display names are not unique.

+ *

A human-readable identifier provided by the collaboration owner. Display names are not + * unique.

*/ name: string | undefined; /** * @public - *

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

+ *

The identifier used to reference members of the collaboration. Currently only supports + * Amazon Web Services account ID.

*/ creatorAccountId: string | undefined; @@ -2077,7 +2123,8 @@ export interface CollaborationSummary { export interface ListCollaborationsOutput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -2100,7 +2147,8 @@ export interface ListMembersInput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -2118,13 +2166,15 @@ export interface ListMembersInput { export interface MemberSummary { /** * @public - *

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

+ *

The identifier used to reference members of the collaboration. Currently only supports + * Amazon Web Services account ID.

*/ accountId: string | undefined; /** * @public - *

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and `REMOVED`.

+ *

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and + * `REMOVED`.

*/ status: MemberStatus | string | undefined; @@ -2171,7 +2221,8 @@ export interface MemberSummary { export interface ListMembersOutput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -2195,13 +2246,15 @@ export interface ListSchemasInput { /** * @public - *

If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.

+ *

If present, filter schemas by schema type. The only valid schema type is currently + * `TABLE`.

*/ schemaType?: SchemaType | string; /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -2267,7 +2320,8 @@ export interface SchemaSummary { /** * @public - *

The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.

+ *

The analysis method for the associated schema. The only valid value is currently + * `DIRECT_QUERY`.

*/ analysisMethod?: AnalysisMethod | string; } @@ -2284,7 +2338,8 @@ export interface ListSchemasOutput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; } @@ -2301,7 +2356,8 @@ export interface UpdateCollaborationInput { /** * @public - *

A human-readable identifier provided by the collaboration owner. Display names are not unique.

+ *

A human-readable identifier provided by the collaboration owner. Display names are not + * unique.

*/ name?: string; @@ -2365,8 +2421,8 @@ export interface CreateConfiguredTableAssociationInput { * @public *

An optional label that you can assign to a resource when you create it. Each tag * consists of a key and an optional value, both of which you define. When you use tagging, - * you can also use tag-based access control in IAM policies to control access to this - * resource.

+ * you can also use tag-based access control in IAM policies to control access + * to this resource.

*/ tags?: Record; } @@ -2420,7 +2476,8 @@ export interface ConfiguredTableAssociation { /** * @public - *

The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.

+ *

The name of the configured table association, in lowercase. The table is identified by + * this name when running protected queries against the underlying data.

*/ name: string | undefined; @@ -2460,7 +2517,8 @@ export interface CreateConfiguredTableAssociationOutput { export interface DeleteConfiguredTableAssociationInput { /** * @public - *

The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.

+ *

The unique ID for the configured table association to be deleted. Currently accepts the + * configured table ID.

*/ configuredTableAssociationIdentifier: string | undefined; @@ -2483,7 +2541,8 @@ export interface DeleteConfiguredTableAssociationOutput {} export interface GetConfiguredTableAssociationInput { /** * @public - *

The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.

+ *

The unique ID for the configured table association to retrieve. Currently accepts the + * configured table ID.

*/ configuredTableAssociationIdentifier: string | undefined; @@ -2512,13 +2571,15 @@ export interface GetConfiguredTableAssociationOutput { export interface ListConfiguredTableAssociationsInput { /** * @public - *

A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.

+ *

A unique identifier for the membership to list configured table associations for. + * Currently accepts the membership ID.

*/ membershipIdentifier: string | undefined; /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -2556,7 +2617,8 @@ export interface ConfiguredTableAssociationSummary { /** * @public - *

The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.

+ *

The name of the configured table association. The table is identified by this name when + * running Protected Queries against the underlying data.

*/ name: string | undefined; @@ -2597,7 +2659,8 @@ export interface ListConfiguredTableAssociationsOutput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; } @@ -2608,7 +2671,8 @@ export interface ListConfiguredTableAssociationsOutput { export interface UpdateConfiguredTableAssociationInput { /** * @public - *

The unique identifier for the configured table association to update. Currently accepts the configured table association ID.

+ *

The unique identifier for the configured table association to update. Currently accepts + * the configured table association ID.

*/ configuredTableAssociationIdentifier: string | undefined; @@ -2663,7 +2727,8 @@ export interface GlueTableReference { /** * @public - *

A pointer to the dataset that underlies this table. Currently, this can only be an Glue table.

+ *

A pointer to the dataset that underlies this table. Currently, this can only be an Glue + * table.

*/ export type TableReference = TableReference.GlueMember | TableReference.$UnknownMember; @@ -2724,13 +2789,15 @@ export interface CreateConfiguredTableInput { /** * @public - *

The columns of the underlying table that can be used by collaborations or analysis rules.

+ *

The columns of the underlying table that can be used by collaborations or analysis + * rules.

*/ allowedColumns: string[] | undefined; /** * @public - *

The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.

+ *

The analysis method for the configured tables. The only valid value is currently + * `DIRECT_QUERY`.

*/ analysisMethod: AnalysisMethod | string | undefined; @@ -2738,8 +2805,8 @@ export interface CreateConfiguredTableInput { * @public *

An optional label that you can assign to a resource when you create it. Each tag * consists of a key and an optional value, both of which you define. When you use tagging, - * you can also use tag-based access control in IAM policies to control access to this - * resource.

+ * you can also use tag-based access control in IAM policies to control access + * to this resource.

*/ tags?: Record; } @@ -2809,13 +2876,15 @@ export interface ConfiguredTable { /** * @public - *

The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.

+ *

The types of analysis rules associated with this configured table. Currently, only one + * analysis rule may be associated with a configured table.

*/ analysisRuleTypes: (ConfiguredTableAnalysisRuleType | string)[] | undefined; /** * @public - *

The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.

+ *

The analysis method for the configured table. The only valid value is currently + * `DIRECT_QUERY`.

*/ analysisMethod: AnalysisMethod | string | undefined; @@ -2876,7 +2945,8 @@ export namespace ConfiguredTableAnalysisRulePolicyV1 { /** * @public - *

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.

+ *

A type of analysis rule that enables the table owner to approve custom SQL queries on + * their configured tables.

*/ export interface CustomMember { list?: never; @@ -2956,7 +3026,8 @@ export namespace ConfiguredTableAnalysisRulePolicy { export interface CreateConfiguredTableAnalysisRuleInput { /** * @public - *

The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.

+ *

The identifier for the configured table to create the analysis rule for. Currently + * accepts the configured table ID.

*/ configuredTableIdentifier: string | undefined; @@ -2975,7 +3046,8 @@ export interface CreateConfiguredTableAnalysisRuleInput { /** * @public - *

A configured table analysis rule, which limits how data for this table can be used.

+ *

A configured table analysis rule, which limits how data for this table can be + * used.

*/ export interface ConfiguredTableAnalysisRule { /** @@ -3056,7 +3128,8 @@ export interface DeleteConfiguredTableAnalysisRuleInput { /** * @public - *

The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

+ *

The analysis rule type to be deleted. Configured table analysis rules are uniquely + * identified by their configured table identifier and analysis rule type.

*/ analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined; } @@ -3095,13 +3168,15 @@ export interface GetConfiguredTableOutput { export interface GetConfiguredTableAnalysisRuleInput { /** * @public - *

The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.

+ *

The unique identifier for the configured table to retrieve. Currently accepts the + * configured table ID.

*/ configuredTableIdentifier: string | undefined; /** * @public - *

The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

+ *

The analysis rule to be retrieved. Configured table analysis rules are uniquely + * identified by their configured table identifier and analysis rule type.

*/ analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined; } @@ -3123,7 +3198,8 @@ export interface GetConfiguredTableAnalysisRuleOutput { export interface ListConfiguredTablesInput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -3177,7 +3253,8 @@ export interface ConfiguredTableSummary { /** * @public - *

The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.

+ *

The analysis method for the configured tables. The only valid value is currently + * `DIRECT_QUERY`.

*/ analysisMethod: AnalysisMethod | string | undefined; } @@ -3194,7 +3271,8 @@ export interface ListConfiguredTablesOutput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; } @@ -3205,7 +3283,8 @@ export interface ListConfiguredTablesOutput { export interface UpdateConfiguredTableInput { /** * @public - *

The identifier for the configured table to update. Currently accepts the configured table ID.

+ *

The identifier for the configured table to update. Currently accepts the configured + * table ID.

*/ configuredTableIdentifier: string | undefined; @@ -3246,7 +3325,8 @@ export interface UpdateConfiguredTableAnalysisRuleInput { /** * @public - *

The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

+ *

The analysis rule type to be updated. Configured table analysis rules are uniquely + * identified by their configured table identifier and analysis rule type.

*/ analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined; @@ -3274,7 +3354,8 @@ export interface UpdateConfiguredTableAnalysisRuleOutput { export interface ListTagsForResourceInput { /** * @public - *

The Amazon Resource Name (ARN) associated with the resource you want to list tags on.

+ *

The Amazon Resource Name (ARN) associated with the resource you want to list tags + * on.

*/ resourceArn: string | undefined; } @@ -3290,6 +3371,107 @@ export interface ListTagsForResourceOutput { tags: Record | undefined; } +/** + * @public + * @enum + */ +export const ResultFormat = { + CSV: "CSV", + PARQUET: "PARQUET", +} as const; + +/** + * @public + */ +export type ResultFormat = (typeof ResultFormat)[keyof typeof ResultFormat]; + +/** + * @public + *

Contains the configuration to write the query results to S3.

+ */ +export interface ProtectedQueryS3OutputConfiguration { + /** + * @public + *

Intended file format of the result.

+ */ + resultFormat: ResultFormat | string | undefined; + + /** + * @public + *

The S3 bucket to unload the protected query results.

+ */ + bucket: string | undefined; + + /** + * @public + *

The S3 prefix to unload the protected query results.

+ */ + keyPrefix?: string; +} + +/** + * @public + *

Contains + * configurations for protected query results.

+ */ +export type MembershipProtectedQueryOutputConfiguration = + | MembershipProtectedQueryOutputConfiguration.S3Member + | MembershipProtectedQueryOutputConfiguration.$UnknownMember; + +/** + * @public + */ +export namespace MembershipProtectedQueryOutputConfiguration { + /** + * @public + *

Contains the configuration to write the query results to S3.

+ */ + export interface S3Member { + s3: ProtectedQueryS3OutputConfiguration; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + s3?: never; + $unknown: [string, any]; + } + + export interface Visitor { + s3: (value: ProtectedQueryS3OutputConfiguration) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: MembershipProtectedQueryOutputConfiguration, visitor: Visitor): T => { + if (value.s3 !== undefined) return visitor.s3(value.s3); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + * @public + *

Contains + * configurations for protected query results.

+ */ +export interface MembershipProtectedQueryResultConfiguration { + /** + * @public + *

Configuration for + * protected query results.

+ */ + outputConfiguration: MembershipProtectedQueryOutputConfiguration | undefined; + + /** + * @public + *

The unique ARN for + * an IAM role that is used by Clean Rooms to write protected query results to the + * result location, given by the member who can receive results.

+ */ + roleArn?: string; +} + /** * @public * @enum @@ -3325,10 +3507,18 @@ export interface CreateMembershipInput { * @public *

An optional label that you can assign to a resource when you create it. Each tag * consists of a key and an optional value, both of which you define. When you use tagging, - * you can also use tag-based access control in IAM policies to control access to this - * resource.

+ * you can also use tag-based access control in IAM policies to control access + * to this resource.

*/ tags?: Record; + + /** + * @public + *

The default + * protected query result configuration as specified by the member who can receive + * results.

+ */ + defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration; } /** @@ -3377,7 +3567,8 @@ export interface Membership { /** * @public - *

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

+ *

The identifier used to reference members of the collaboration. Currently only supports + * Amazon Web Services account ID.

*/ collaborationCreatorAccountId: string | undefined; @@ -3407,7 +3598,8 @@ export interface Membership { /** * @public - *

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.

+ *

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and + * `COLLABORATION_DELETED`.

*/ status: MembershipStatus | string | undefined; @@ -3423,6 +3615,14 @@ export interface Membership { * collaboration.

*/ queryLogStatus: MembershipQueryLogStatus | string | undefined; + + /** + * @public + *

The default + * protected query result configuration as specified by the member who can receive + * results.

+ */ + defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration; } /** @@ -3509,6 +3709,21 @@ export interface ProtectedQueryError { code: string | undefined; } +/** + * @public + *

Details about the + * member who received the query result.

+ */ +export interface ProtectedQuerySingleMemberOutput { + /** + * @public + *

The Amazon Web Services account + * ID of the member in the collaboration who can receive results for the + * query.

+ */ + accountId: string | undefined; +} + /** * @public *

Contains output information for protected queries with an S3 output type.

@@ -3525,7 +3740,10 @@ export interface ProtectedQueryS3Output { * @public *

Contains details about the protected query output.

*/ -export type ProtectedQueryOutput = ProtectedQueryOutput.S3Member | ProtectedQueryOutput.$UnknownMember; +export type ProtectedQueryOutput = + | ProtectedQueryOutput.MemberListMember + | ProtectedQueryOutput.S3Member + | ProtectedQueryOutput.$UnknownMember; /** * @public @@ -3537,6 +3755,18 @@ export namespace ProtectedQueryOutput { */ export interface S3Member { s3: ProtectedQueryS3Output; + memberList?: never; + $unknown?: never; + } + + /** + * @public + *

The list of member + * Amazon Web Services account(s) that received the results of the query.

+ */ + export interface MemberListMember { + s3?: never; + memberList: ProtectedQuerySingleMemberOutput[]; $unknown?: never; } @@ -3545,16 +3775,19 @@ export namespace ProtectedQueryOutput { */ export interface $UnknownMember { s3?: never; + memberList?: never; $unknown: [string, any]; } export interface Visitor { s3: (value: ProtectedQueryS3Output) => T; + memberList: (value: ProtectedQuerySingleMemberOutput[]) => T; _: (name: string, value: any) => T; } export const visit = (value: ProtectedQueryOutput, visitor: Visitor): T => { if (value.s3 !== undefined) return visitor.s3(value.s3); + if (value.memberList !== undefined) return visitor.memberList(value.memberList); return visitor._(value.$unknown[0], value.$unknown[1]); }; } @@ -3571,44 +3804,6 @@ export interface ProtectedQueryResult { output: ProtectedQueryOutput | undefined; } -/** - * @public - * @enum - */ -export const ResultFormat = { - CSV: "CSV", - PARQUET: "PARQUET", -} as const; - -/** - * @public - */ -export type ResultFormat = (typeof ResultFormat)[keyof typeof ResultFormat]; - -/** - * @public - *

Contains the configuration to write the query results to S3.

- */ -export interface ProtectedQueryS3OutputConfiguration { - /** - * @public - *

Intended file format of the result.

- */ - resultFormat: ResultFormat | string | undefined; - - /** - * @public - *

The S3 bucket to unload the protected query results.

- */ - bucket: string | undefined; - - /** - * @public - *

The S3 prefix to unload the protected query results.

- */ - keyPrefix?: string; -} - /** * @public *

Contains configuration details for protected query output.

@@ -3674,7 +3869,8 @@ export interface ProtectedQuerySQLParameters { /** * @public - *

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

+ *

The Amazon Resource Name (ARN) associated with the analysis template within a + * collaboration.

*/ analysisTemplateArn?: string; @@ -3718,7 +3914,7 @@ export type ProtectedQueryStatus = (typeof ProtectedQueryStatus)[keyof typeof Pr /** * @public - *

The parameters for an Clean Rooms protected query.

+ *

The parameters for an Clean Rooms protected query.

*/ export interface ProtectedQuery { /** @@ -3749,7 +3945,7 @@ export interface ProtectedQuery { * @public *

The protected query SQL parameters.

*/ - sqlParameters: ProtectedQuerySQLParameters | undefined; + sqlParameters?: ProtectedQuerySQLParameters; /** * @public @@ -3761,7 +3957,7 @@ export interface ProtectedQuery { * @public *

Contains any details needed to write the query results.

*/ - resultConfiguration: ProtectedQueryResultConfiguration | undefined; + resultConfiguration?: ProtectedQueryResultConfiguration; /** * @public @@ -3799,7 +3995,8 @@ export interface GetProtectedQueryOutput { export interface ListMembershipsInput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -3847,7 +4044,8 @@ export interface MembershipSummary { /** * @public - *

The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.

+ *

The identifier of the Amazon Web Services principal that created the collaboration. Currently only + * supports Amazon Web Services account ID.

*/ collaborationCreatorAccountId: string | undefined; @@ -3877,7 +4075,8 @@ export interface MembershipSummary { /** * @public - *

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.

+ *

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and + * `COLLABORATION_DELETED`.

*/ status: MembershipStatus | string | undefined; @@ -3894,7 +4093,8 @@ export interface MembershipSummary { export interface ListMembershipsOutput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -3923,7 +4123,8 @@ export interface ListProtectedQueriesInput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -3967,7 +4168,8 @@ export interface ProtectedQuerySummary { /** * @public - *

The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.

+ *

The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, + * `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.

*/ status: ProtectedQueryStatus | string | undefined; } @@ -3978,7 +4180,8 @@ export interface ProtectedQuerySummary { export interface ListProtectedQueriesOutput { /** * @public - *

The token value retrieved from a previous call to access the next page of results.

+ *

The token value retrieved from a previous call to access the next page of + * results.

*/ nextToken?: string; @@ -4014,7 +4217,8 @@ export interface StartProtectedQueryInput { /** * @public - *

A unique identifier for the membership to run this query against. Currently accepts a membership ID.

+ *

A unique identifier for the membership to run this query against. Currently accepts a + * membership ID.

*/ membershipIdentifier: string | undefined; @@ -4028,7 +4232,7 @@ export interface StartProtectedQueryInput { * @public *

The details needed to write the query results.

*/ - resultConfiguration: ProtectedQueryResultConfiguration | undefined; + resultConfiguration?: ProtectedQueryResultConfiguration; } /** @@ -4058,6 +4262,14 @@ export interface UpdateMembershipInput { * collaboration.

*/ queryLogStatus?: MembershipQueryLogStatus | string; + + /** + * @public + *

The default + * protected query result configuration as specified by the member who can receive + * results.

+ */ + defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration; } /** @@ -4102,7 +4314,8 @@ export interface UpdateProtectedQueryInput { /** * @public - *

The target status of a query. Used to update the execution status of a currently running query.

+ *

The target status of a query. Used to update the execution status of a currently running + * query.

*/ targetStatus: TargetProtectedQueryStatus | string | undefined; } @@ -4146,7 +4359,8 @@ export interface TagResourceOutput {} export interface UntagResourceInput { /** * @public - *

The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.

+ *

The Amazon Resource Name (ARN) associated with the resource you want to remove the tag + * from.

*/ resourceArn: string | undefined; diff --git a/clients/client-cleanrooms/src/protocols/Aws_restJson1.ts b/clients/client-cleanrooms/src/protocols/Aws_restJson1.ts index 0ad0ccfb90cea..9611ab54cd8af 100644 --- a/clients/client-cleanrooms/src/protocols/Aws_restJson1.ts +++ b/clients/client-cleanrooms/src/protocols/Aws_restJson1.ts @@ -186,6 +186,8 @@ import { JoinOperator, MemberAbility, Membership, + MembershipProtectedQueryOutputConfiguration, + MembershipProtectedQueryResultConfiguration, MembershipSummary, MemberSpecification, MemberSummary, @@ -496,6 +498,7 @@ export const se_CreateMembershipCommand = async ( body = JSON.stringify( take(input, { collaborationIdentifier: [], + defaultResultConfiguration: (_) => _json(_), queryLogStatus: [], tags: (_) => _json(_), }) @@ -1795,6 +1798,7 @@ export const se_UpdateMembershipCommand = async ( let body: any; body = JSON.stringify( take(input, { + defaultResultConfiguration: (_) => _json(_), queryLogStatus: [], }) ); @@ -4689,6 +4693,10 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont // se_MemberList omitted. +// se_MembershipProtectedQueryOutputConfiguration omitted. + +// se_MembershipProtectedQueryResultConfiguration omitted. + // se_MemberSpecification omitted. // se_ParameterMap omitted. @@ -5085,6 +5093,7 @@ const de_Membership = (output: any, context: __SerdeContext): Membership => { collaborationId: __expectString, collaborationName: __expectString, createTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + defaultResultConfiguration: _json, id: __expectString, memberAbilities: _json, queryLogStatus: __expectString, @@ -5093,6 +5102,10 @@ const de_Membership = (output: any, context: __SerdeContext): Membership => { }) as any; }; +// de_MembershipProtectedQueryOutputConfiguration omitted. + +// de_MembershipProtectedQueryResultConfiguration omitted. + /** * deserializeAws_restJson1MembershipSummary */ @@ -5174,6 +5187,8 @@ const de_ProtectedQuery = (output: any, context: __SerdeContext): ProtectedQuery // de_ProtectedQueryError omitted. +// de_ProtectedQueryMemberOutputList omitted. + // de_ProtectedQueryOutput omitted. // de_ProtectedQueryOutputConfiguration omitted. @@ -5186,6 +5201,8 @@ const de_ProtectedQuery = (output: any, context: __SerdeContext): ProtectedQuery // de_ProtectedQueryS3OutputConfiguration omitted. +// de_ProtectedQuerySingleMemberOutput omitted. + // de_ProtectedQuerySQLParameters omitted. // de_ProtectedQueryStatistics omitted. diff --git a/codegen/sdk-codegen/aws-models/cleanrooms.json b/codegen/sdk-codegen/aws-models/cleanrooms.json index cb2068d0e8d9d..3aa85fd77a2f9 100644 --- a/codegen/sdk-codegen/aws-models/cleanrooms.json +++ b/codegen/sdk-codegen/aws-models/cleanrooms.json @@ -55,7 +55,7 @@ "additionalExposedHeaders": ["x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id"], "maxAge": 86400 }, - "smithy.api#documentation": "

Welcome to the Clean Rooms API Reference.

\n

Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data\n together in a secure collaboration workspace. In the collaboration, members who can query\n and receive results can get insights into the collective datasets without either party getting\n access to the other party's raw data.

\n

To learn more about Clean Rooms concepts, procedures, and best practices, see the\n Clean Rooms User Guide.

", + "smithy.api#documentation": "

Welcome to the Clean Rooms API Reference.

\n

Clean Rooms is an Amazon Web Services service that helps multiple parties to join\n their data together in a secure collaboration workspace. In the collaboration, members who\n can query and receive results can get insights into the collective datasets without either\n party getting access to the other party's raw data.

\n

To learn more about Clean Rooms concepts, procedures, and best practices, see the\n Clean Rooms User Guide.

\n

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the\n Clean Rooms SQL Reference.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -415,53 +415,53 @@ "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://cleanrooms-fips.us-gov-east-1.api.aws" + "url": "https://cleanrooms-fips.us-east-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms-fips.us-gov-east-1.amazonaws.com" + "url": "https://cleanrooms-fips.us-east-1.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://cleanrooms.us-gov-east-1.api.aws" + "url": "https://cleanrooms.us-east-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms.us-gov-east-1.amazonaws.com" + "url": "https://cleanrooms.us-east-1.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } @@ -519,101 +519,101 @@ } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://cleanrooms-fips.us-gov-east-1.api.aws" + } }, "params": { - "Region": "us-iso-east-1", + "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://cleanrooms-fips.us-gov-east-1.amazonaws.com" } }, "params": { - "Region": "us-iso-east-1", + "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://cleanrooms.us-gov-east-1.api.aws" + } }, "params": { - "Region": "us-iso-east-1", + "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms.us-iso-east-1.c2s.ic.gov" + "url": "https://cleanrooms.us-gov-east-1.amazonaws.com" } }, "params": { - "Region": "us-iso-east-1", + "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://cleanrooms-fips.us-east-1.api.aws" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-east-1", + "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms-fips.us-east-1.amazonaws.com" + "url": "https://cleanrooms-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "us-east-1", + "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://cleanrooms.us-east-1.api.aws" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-east-1", + "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms.us-east-1.amazonaws.com" + "url": "https://cleanrooms.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "us-east-1", + "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } @@ -667,7 +667,7 @@ } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -680,6 +680,19 @@ "Endpoint": "https://example.com" } }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { @@ -703,6 +716,12 @@ "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -813,7 +832,7 @@ "columnName": { "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnName", "traits": { - "smithy.api#documentation": "

Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

", + "smithy.api#documentation": "

Column in aggregation constraint for which there must be a minimum number of distinct\n values in an output row for it to be in the query output.

", "smithy.api#required": {} } }, @@ -837,7 +856,7 @@ } }, "traits": { - "smithy.api#documentation": "

Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.

" + "smithy.api#documentation": "

Constraint on query output removing output rows that do not meet a minimum number of\n distinct values of a specified column.

" } }, "com.amazonaws.cleanrooms#AggregationConstraints": { @@ -882,7 +901,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 100 + "max": 225 } } }, @@ -914,7 +933,7 @@ "name": { "target": "com.amazonaws.cleanrooms#ParameterName", "traits": { - "smithy.api#documentation": "

The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-)\n characters but cannot start or end with a hyphen.

", + "smithy.api#documentation": "

The name of the parameter. The name must use only alphanumeric, underscore (_), or\n hyphen (-) characters but cannot start or end with a hyphen.

", "smithy.api#required": {} } }, @@ -1041,20 +1060,20 @@ "scalarFunctions": { "target": "com.amazonaws.cleanrooms#ScalarFunctionsList", "traits": { - "smithy.api#documentation": "

Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

", + "smithy.api#documentation": "

Set of scalar functions that are allowed to be used on dimension columns and the output\n of aggregation of metrics.

", "smithy.api#required": {} } }, "outputConstraints": { "target": "com.amazonaws.cleanrooms#AggregationConstraints", "traits": { - "smithy.api#documentation": "

Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

", + "smithy.api#documentation": "

Columns that must meet a specific threshold value (after an aggregation function is\n applied to it) for each output row to be returned.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

" + "smithy.api#documentation": "

A type of analysis rule that enables query structure and specified queries that produce\n aggregate statistics.

" } }, "com.amazonaws.cleanrooms#AnalysisRuleColumnList": { @@ -1103,7 +1122,7 @@ } }, "traits": { - "smithy.api#documentation": "

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.

" + "smithy.api#documentation": "

A type of analysis rule that enables the table owner to approve custom SQL queries on\n their configured tables.

" } }, "com.amazonaws.cleanrooms#AnalysisRuleList": { @@ -1112,7 +1131,7 @@ "joinColumns": { "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnList", "traits": { - "smithy.api#documentation": "

Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.

", + "smithy.api#documentation": "

Columns that can be used to join a configured table with the table of the member who can\n query and other members' configured tables.

", "smithy.api#length": { "min": 1 }, @@ -1478,7 +1497,7 @@ "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis template summary belongs to.\n Currently accepts collaboration ID.

", "smithy.api#required": {} } }, @@ -1535,7 +1554,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to view details of multiple analysis tempaltes within a collaboration", - "smithy.api#documentation": "

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

", + "smithy.api#documentation": "

Retrieves multiple analysis templates within a collaboration by their Amazon Resource\n Names (ARNs).

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1570,7 +1589,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.

" + "smithy.api#documentation": "

Details of errors thrown by the call to retrieve multiple analysis templates within a\n collaboration by their identifiers.

" } }, "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateErrorList": { @@ -1590,7 +1609,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -1599,7 +1618,7 @@ "analysisTemplateArns": { "target": "com.amazonaws.cleanrooms#AnalysisTemplateArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.

", "smithy.api#required": {} } } @@ -1618,7 +1637,7 @@ "errors": { "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateErrorList", "traits": { - "smithy.api#documentation": "

Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.

", + "smithy.api#documentation": "

Error reasons for collaboration analysis templates that could not be retrieved. One\n error is returned for every collaboration analysis template that could not be\n retrieved.

", "smithy.api#required": {} } } @@ -1770,7 +1789,7 @@ "name": { "target": "com.amazonaws.cleanrooms#CollaborationName", "traits": { - "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not unique.

", + "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not\n unique.

", "smithy.api#required": {} } }, @@ -1783,7 +1802,7 @@ "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -1842,7 +1861,7 @@ } }, "traits": { - "smithy.api#documentation": "

The multi-party data share environment. The collaboration contains metadata about its purpose and participants.

" + "smithy.api#documentation": "

The multi-party data share environment. The collaboration contains metadata about its\n purpose and participants.

" } }, "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate": { @@ -1866,7 +1885,7 @@ "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#required": {} } }, @@ -1886,7 +1905,7 @@ "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -1967,7 +1986,7 @@ "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time that the summary of the analysis template in a collaboration was created.

", + "smithy.api#documentation": "

The time that the summary of the analysis template in a collaboration was\n created.

", "smithy.api#required": {} } }, @@ -1988,7 +2007,7 @@ "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time that the summary of the analysis template in the collaboration was last updated.

", + "smithy.api#documentation": "

The time that the summary of the analysis template in the collaboration was last\n updated.

", "smithy.api#required": {} } }, @@ -2002,14 +2021,14 @@ "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#required": {} } }, "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -2167,14 +2186,14 @@ "name": { "target": "com.amazonaws.cleanrooms#CollaborationName", "traits": { - "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not unique.

", + "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not\n unique.

", "smithy.api#required": {} } }, "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -2248,7 +2267,7 @@ } }, "traits": { - "smithy.api#documentation": "

A column within a schema relation, derived from the underlying Glue table.

" + "smithy.api#documentation": "

A column within a schema relation, derived from the underlying Glue\n table.

" } }, "com.amazonaws.cleanrooms#ColumnList": { @@ -2330,14 +2349,14 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "

The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.

", + "smithy.api#documentation": "

The types of analysis rules associated with this configured table. Currently, only one\n analysis rule may be associated with a configured table.

", "smithy.api#required": {} } }, "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "

The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.

", + "smithy.api#documentation": "

The analysis method for the configured table. The only valid value is currently\n `DIRECT_QUERY`.

", "smithy.api#required": {} } }, @@ -2401,7 +2420,7 @@ } }, "traits": { - "smithy.api#documentation": "

A configured table analysis rule, which limits how data for this table can be used.

" + "smithy.api#documentation": "

A configured table analysis rule, which limits how data for this table can be\n used.

" } }, "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicy": { @@ -2536,7 +2555,7 @@ "name": { "target": "com.amazonaws.cleanrooms#TableAlias", "traits": { - "smithy.api#documentation": "

The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.

", + "smithy.api#documentation": "

The name of the configured table association, in lowercase. The table is identified by\n this name when running protected queries against the underlying data.

", "smithy.api#required": {} } }, @@ -2648,7 +2667,7 @@ "name": { "target": "com.amazonaws.cleanrooms#TableAlias", "traits": { - "smithy.api#documentation": "

The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.

", + "smithy.api#documentation": "

The name of the configured table association. The table is identified by this name when\n running Protected Queries against the underlying data.

", "smithy.api#required": {} } }, @@ -2798,7 +2817,7 @@ "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.

", + "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently\n `DIRECT_QUERY`.

", "smithy.api#required": {} } } @@ -2949,7 +2968,7 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

" + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" } }, "analysisParameters": { @@ -3048,7 +3067,7 @@ "dataEncryptionMetadata": { "target": "com.amazonaws.cleanrooms#DataEncryptionMetadata", "traits": { - "smithy.api#documentation": "

The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

" + "smithy.api#documentation": "

The settings for client-side encryption with Cryptographic Computing for Clean\n Rooms.

" } }, "queryLogStatus": { @@ -3061,7 +3080,7 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access to this\n resource.

" + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" } } } @@ -3165,7 +3184,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The identifier for the configured table to create the analysis rule for. Currently\n accepts the configured table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -3283,7 +3302,7 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access to this\n resource.

" + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" } } } @@ -3326,21 +3345,21 @@ "allowedColumns": { "target": "com.amazonaws.cleanrooms#AllowedColumnList", "traits": { - "smithy.api#documentation": "

The columns of the underlying table that can be used by collaborations or analysis rules.

", + "smithy.api#documentation": "

The columns of the underlying table that can be used by collaborations or analysis\n rules.

", "smithy.api#required": {} } }, "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.

", + "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently\n `DIRECT_QUERY`.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access to this\n resource.

" + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" } } } @@ -3418,7 +3437,13 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access to this\n resource.

" + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + } + }, + "defaultResultConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", + "traits": { + "smithy.api#documentation": "

The default\n protected query result configuration as specified by the member who can receive\n results.

" } } } @@ -3441,28 +3466,28 @@ "allowCleartext": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).

", + "smithy.api#documentation": "

Indicates whether encrypted tables can contain cleartext data (true) or are to\n cryptographically process every column (false).

", "smithy.api#required": {} } }, "allowDuplicates": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).

", + "smithy.api#documentation": "

Indicates whether Fingerprint columns can contain duplicate entries (true) or are to\n contain only non-repeated values (false).

", "smithy.api#required": {} } }, "allowJoinsOnColumnsWithDifferentNames": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).

", + "smithy.api#documentation": "

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with\n a different name (true) or can only be joined on Fingerprint columns of the same name\n (false).

", "smithy.api#required": {} } }, "preserveNulls": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).

", + "smithy.api#documentation": "

Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or\n cryptographically processed (false).

", "smithy.api#required": {} } } @@ -3678,7 +3703,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

", + "smithy.api#documentation": "

The analysis rule type to be deleted. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3737,7 +3762,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The unique ID for the configured table association to be deleted. Currently accepts the\n configured table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -4072,7 +4097,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -4081,7 +4106,7 @@ "analysisTemplateArn": { "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "AnalysisTemplateArn" @@ -4205,7 +4230,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The unique identifier for the configured table to retrieve. Currently accepts the\n configured table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -4214,7 +4239,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

", + "smithy.api#documentation": "

The analysis rule to be retrieved. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4275,7 +4300,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The unique ID for the configured table association to retrieve. Currently accepts the\n configured table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -4557,7 +4582,7 @@ "type": { "target": "com.amazonaws.cleanrooms#AnalysisRuleType", "traits": { - "smithy.api#documentation": "

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

", + "smithy.api#documentation": "

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely\n identified by a combination of the collaboration, the schema name, and their type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4703,7 +4728,11 @@ "com.amazonaws.cleanrooms#KeyPrefix": { "type": "string", "traits": { - "smithy.api#pattern": "^[\\w!.*/-]*$" + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\w!.=*/-]*$" } }, "com.amazonaws.cleanrooms#ListAnalysisTemplates": { @@ -4759,7 +4788,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4778,7 +4807,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "analysisTemplateSummaries": { @@ -4835,7 +4864,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -4844,7 +4873,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4863,7 +4892,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "collaborationAnalysisTemplateSummaries": { @@ -4917,7 +4946,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4943,7 +4972,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "collaborationList": { @@ -5000,7 +5029,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.

", + "smithy.api#documentation": "

A unique identifier for the membership to list configured table associations for.\n Currently accepts the membership ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5008,7 +5037,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5034,7 +5063,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } } @@ -5081,7 +5110,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5107,7 +5136,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } } @@ -5166,7 +5195,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5185,7 +5214,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "memberSummaries": { @@ -5239,7 +5268,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5265,7 +5294,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "membershipSummaries": { @@ -5340,7 +5369,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5359,7 +5388,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "protectedQueries": { @@ -5425,14 +5454,14 @@ "schemaType": { "target": "com.amazonaws.cleanrooms#SchemaType", "traits": { - "smithy.api#documentation": "

If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.

", + "smithy.api#documentation": "

If present, filter schemas by schema type. The only valid schema type is currently\n `TABLE`.

", "smithy.api#httpQuery": "schemaType" } }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5458,7 +5487,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } } @@ -5495,7 +5524,7 @@ "resourceArn": { "target": "com.amazonaws.cleanrooms#CleanroomsArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource you want to list tags on.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource you want to list tags\n on.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5571,7 +5600,7 @@ "accountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -5623,7 +5652,7 @@ "accountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "AccountId" } @@ -5631,7 +5660,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MemberStatus", "traits": { - "smithy.api#documentation": "

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and `REMOVED`.

", + "smithy.api#documentation": "

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and\n `REMOVED`.

", "smithy.api#required": {} } }, @@ -5721,7 +5750,7 @@ "collaborationCreatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -5756,7 +5785,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MembershipStatus", "traits": { - "smithy.api#documentation": "

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.

", + "smithy.api#documentation": "

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and\n `COLLABORATION_DELETED`.

", "smithy.api#required": {} } }, @@ -5773,6 +5802,12 @@ "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

", "smithy.api#required": {} } + }, + "defaultResultConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", + "traits": { + "smithy.api#documentation": "

The default\n protected query result configuration as specified by the member who can receive\n results.

" + } } }, "traits": { @@ -5798,6 +5833,38 @@ "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" } }, + "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryS3OutputConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Contains\n configurations for protected query results.

" + } + }, + "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration": { + "type": "structure", + "members": { + "outputConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for\n protected query results.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanrooms#RoleArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for\n an IAM role that is used by Clean Rooms to write protected query results to the\n result location, given by the member who can receive results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains\n configurations for protected query results.

" + } + }, "com.amazonaws.cleanrooms#MembershipQueryLogStatus": { "type": "string", "traits": { @@ -5914,7 +5981,7 @@ "collaborationCreatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier of the Amazon Web Services principal that created the collaboration. Currently only\n supports Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -5949,7 +6016,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MembershipStatus", "traits": { - "smithy.api#documentation": "

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.

", + "smithy.api#documentation": "

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and\n `COLLABORATION_DELETED`.

", "smithy.api#required": {} } }, @@ -6137,8 +6204,7 @@ "sqlParameters": { "target": "com.amazonaws.cleanrooms#ProtectedQuerySQLParameters", "traits": { - "smithy.api#documentation": "

The protected query SQL parameters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The protected query SQL parameters.

" } }, "status": { @@ -6151,8 +6217,7 @@ "resultConfiguration": { "target": "com.amazonaws.cleanrooms#ProtectedQueryResultConfiguration", "traits": { - "smithy.api#documentation": "

Contains any details needed to write the query results.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Contains any details needed to write the query results.

" } }, "statistics": { @@ -6175,7 +6240,7 @@ } }, "traits": { - "smithy.api#documentation": "

The parameters for an Clean Rooms protected query.

" + "smithy.api#documentation": "

The parameters for an Clean Rooms protected query.

" } }, "com.amazonaws.cleanrooms#ProtectedQueryError": { @@ -6210,6 +6275,12 @@ "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" } }, + "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ProtectedQuerySingleMemberOutput" + } + }, "com.amazonaws.cleanrooms#ProtectedQueryOutput": { "type": "union", "members": { @@ -6218,6 +6289,12 @@ "traits": { "smithy.api#documentation": "

If present, the output for a protected query with an `S3` output type.

" } + }, + "memberList": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputList", + "traits": { + "smithy.api#documentation": "

The list of member\n Amazon Web Services account(s) that received the results of the query.

" + } } }, "traits": { @@ -6331,7 +6408,7 @@ "analysisTemplateArn": { "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.

" } }, "parameters": { @@ -6346,6 +6423,21 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.cleanrooms#ProtectedQuerySingleMemberOutput": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account\n ID of the member in the collaboration who can receive results for the\n query.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the\n member who received the query result.

" + } + }, "com.amazonaws.cleanrooms#ProtectedQueryStatistics": { "type": "structure", "members": { @@ -6430,7 +6522,7 @@ "status": { "target": "com.amazonaws.cleanrooms#ProtectedQueryStatus", "traits": { - "smithy.api#documentation": "

The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.

", + "smithy.api#documentation": "

The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`,\n `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.

", "smithy.api#required": {} } } @@ -6643,7 +6735,7 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#AnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "

The analysis rule types associated with the schema. Currently, only one entry is present.

", + "smithy.api#documentation": "

The analysis rule types associated with the schema. Currently, only one entry is\n present.

", "smithy.api#required": {} } }, @@ -6663,7 +6755,7 @@ "name": { "target": "com.amazonaws.cleanrooms#TableAlias", "traits": { - "smithy.api#documentation": "

A name for the schema. The schema relation is referred to by this name when queried by a protected query.

", + "smithy.api#documentation": "

A name for the schema. The schema relation is referred to by this name when queried by a\n protected query.

", "smithy.api#required": {} } }, @@ -6788,7 +6880,7 @@ "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "

The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.

" + "smithy.api#documentation": "

The analysis method for the associated schema. The only valid value is currently\n `DIRECT_QUERY`.

" } } }, @@ -6873,7 +6965,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to start protected queries", - "smithy.api#documentation": "

Creates a protected query that is started by Clean Rooms .

", + "smithy.api#documentation": "

Creates a protected query that is started by Clean Rooms.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -6894,7 +6986,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the membership to run this query against. Currently accepts a membership ID.

", + "smithy.api#documentation": "

A unique identifier for the membership to run this query against. Currently accepts a\n membership ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -6910,8 +7002,7 @@ "resultConfiguration": { "target": "com.amazonaws.cleanrooms#ProtectedQueryResultConfiguration", "traits": { - "smithy.api#documentation": "

The details needed to write the query results.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The details needed to write the query results.

" } } } @@ -6969,7 +7060,7 @@ } }, "traits": { - "smithy.api#documentation": "

A pointer to the dataset that underlies this table. Currently, this can only be an Glue table.

" + "smithy.api#documentation": "

A pointer to the dataset that underlies this table. Currently, this can only be an Glue\n table.

" } }, "com.amazonaws.cleanrooms#TagKey": { @@ -7134,7 +7225,7 @@ "resourceArn": { "target": "com.amazonaws.cleanrooms#CleanroomsArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource you want to remove the tag\n from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7282,7 +7373,7 @@ "name": { "target": "com.amazonaws.cleanrooms#CollaborationName", "traits": { - "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not unique.

" + "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not\n unique.

" } }, "description": { @@ -7396,7 +7487,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

", + "smithy.api#documentation": "

The analysis rule type to be updated. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7467,7 +7558,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier for the configured table association to update. Currently accepts the configured table association ID.

", + "smithy.api#documentation": "

The unique identifier for the configured table association to update. Currently accepts\n the configured table association ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -7514,7 +7605,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for the configured table to update. Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The identifier for the configured table to update. Currently accepts the configured\n table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -7601,6 +7692,12 @@ "traits": { "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

" } + }, + "defaultResultConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", + "traits": { + "smithy.api#documentation": "

The default\n protected query result configuration as specified by the member who can receive\n results.

" + } } } }, @@ -7677,7 +7774,7 @@ "targetStatus": { "target": "com.amazonaws.cleanrooms#TargetProtectedQueryStatus", "traits": { - "smithy.api#documentation": "

The target status of a query. Used to update the execution status of a currently running query.

", + "smithy.api#documentation": "

The target status of a query. Used to update the execution status of a currently running\n query.

", "smithy.api#required": {} } }