@aws-sdk/client-cleanrooms 3.936.0 → 3.939.0

package/dist-types/models/models_1.d.ts

@@ -1,315 +1,5 @@
-import { AnalysisType, DifferentialPrivacyAggregationType, MemberAbility, MembershipJobLogStatus, MembershipQueryLogStatus, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetType, ProtectedJobAnalysisType, ProtectedJobStatus, ProtectedJobType, TargetProtectedJobStatus } from "./enums";
-import { AccessBudgetsPrivacyTemplateParametersInput, AccessBudgetsPrivacyTemplateUpdateParameters, ComputeConfiguration, DifferentialPrivacyParameters, Membership, MembershipPaymentConfiguration, MembershipProtectedJobResultConfiguration, MembershipProtectedQueryResultConfiguration, MembershipStatus, MLMemberAbilities, PrivacyBudget, PrivacyBudgetTemplateParametersOutput, ProtectedJob, ProtectedJobComputeConfiguration, ProtectedJobParameters, ProtectedQueryError, ProtectedQueryS3OutputConfiguration } from "./models_0";
-/**
- * <p>Details about the member who received the query result.</p>
- * @public
- */
-export interface ProtectedQuerySingleMemberOutput {
-    /**
-     * <p>The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.</p>
-     * @public
-     */
-    accountId: string | undefined;
-}
-/**
- * <p>Contains output information for protected queries with an S3 output type.</p>
- * @public
- */
-export interface ProtectedQueryS3Output {
-    /**
-     * <p>The S3 location of the result.</p>
-     * @public
-     */
-    location: string | undefined;
-}
-/**
- * <p> Contains the output information for a protected query with a distribute output configuration.</p> <p> This output type allows query results to be distributed to multiple receivers, including S3 and collaboration members. It is only available for queries using the Spark analytics engine.</p>
- * @public
- */
-export interface ProtectedQueryDistributeOutput {
-    /**
-     * <p>Contains output information for protected queries with an S3 output type.</p>
-     * @public
-     */
-    s3?: ProtectedQueryS3Output | undefined;
-    /**
-     * <p> Contains the output results for each member location specified in the distribute output configuration. Each entry provides details about the result distribution to a specific collaboration member. </p>
-     * @public
-     */
-    memberList?: ProtectedQuerySingleMemberOutput[] | undefined;
-}
-/**
- * <p>Contains details about the protected query output.</p>
- * @public
- */
-export type ProtectedQueryOutput = ProtectedQueryOutput.DistributeMember | ProtectedQueryOutput.MemberListMember | ProtectedQueryOutput.S3Member | ProtectedQueryOutput.$UnknownMember;
-/**
- * @public
- */
-export declare namespace ProtectedQueryOutput {
-    /**
-     * <p>If present, the output for a protected query with an <code>S3</code> output type.</p>
-     * @public
-     */
-    interface S3Member {
-        s3: ProtectedQueryS3Output;
-        memberList?: never;
-        distribute?: never;
-        $unknown?: never;
-    }
-    /**
-     * <p>The list of member Amazon Web Services account(s) that received the results of the query. </p>
-     * @public
-     */
-    interface MemberListMember {
-        s3?: never;
-        memberList: ProtectedQuerySingleMemberOutput[];
-        distribute?: never;
-        $unknown?: never;
-    }
-    /**
-     * <p>Contains output information for protected queries that use a <code>distribute</code> output type. This output type lets you send query results to multiple locations - either to S3 or to collaboration members. </p> <note> <p> You can only use the <code>distribute</code> output type with the Spark analytics engine. </p> </note>
-     * @public
-     */
-    interface DistributeMember {
-        s3?: never;
-        memberList?: never;
-        distribute: ProtectedQueryDistributeOutput;
-        $unknown?: never;
-    }
-    /**
-     * @public
-     */
-    interface $UnknownMember {
-        s3?: never;
-        memberList?: never;
-        distribute?: never;
-        $unknown: [string, any];
-    }
-    /**
-     * @deprecated unused in schema-serde mode.
-     *
-     */
-    interface Visitor<T> {
-        s3: (value: ProtectedQueryS3Output) => T;
-        memberList: (value: ProtectedQuerySingleMemberOutput[]) => T;
-        distribute: (value: ProtectedQueryDistributeOutput) => T;
-        _: (name: string, value: any) => T;
-    }
-}
-/**
- * <p>Details about the query results.</p>
- * @public
- */
-export interface ProtectedQueryResult {
-    /**
-     * <p>The output of the protected query.</p>
-     * @public
-     */
-    output: ProtectedQueryOutput | undefined;
-}
-/**
- * <p> Contains configuration details for the protected query member output.</p>
- * @public
- */
-export interface ProtectedQueryMemberOutputConfiguration {
-    /**
-     * <p>The unique identifier for the account.</p>
-     * @public
-     */
-    accountId: string | undefined;
-}
-/**
- * <p> Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.</p>
- * @public
- */
-export type ProtectedQueryDistributeOutputConfigurationLocation = ProtectedQueryDistributeOutputConfigurationLocation.MemberMember | ProtectedQueryDistributeOutputConfigurationLocation.S3Member | ProtectedQueryDistributeOutputConfigurationLocation.$UnknownMember;
-/**
- * @public
- */
-export declare namespace ProtectedQueryDistributeOutputConfigurationLocation {
-    /**
-     * <p>Contains the configuration to write the query results to S3.</p>
-     * @public
-     */
-    interface S3Member {
-        s3: ProtectedQueryS3OutputConfiguration;
-        member?: never;
-        $unknown?: never;
-    }
-    /**
-     * <p> Contains configuration details for the protected query member output.</p>
-     * @public
-     */
-    interface MemberMember {
-        s3?: never;
-        member: ProtectedQueryMemberOutputConfiguration;
-        $unknown?: never;
-    }
-    /**
-     * @public
-     */
-    interface $UnknownMember {
-        s3?: never;
-        member?: never;
-        $unknown: [string, any];
-    }
-    /**
-     * @deprecated unused in schema-serde mode.
-     *
-     */
-    interface Visitor<T> {
-        s3: (value: ProtectedQueryS3OutputConfiguration) => T;
-        member: (value: ProtectedQueryMemberOutputConfiguration) => T;
-        _: (name: string, value: any) => T;
-    }
-}
-/**
- * <p> Specifies the configuration for distributing protected query results to multiple receivers, including S3 and collaboration members.</p>
- * @public
- */
-export interface ProtectedQueryDistributeOutputConfiguration {
-    /**
-     * <p> A list of locations where you want to distribute the protected query results. Each location must specify either an S3 destination or a collaboration member destination.</p> <important> <p>You can't specify more than one S3 location.</p> <p>You can't specify the query runner's account as a member location.</p> <p>You must include either an S3 or member output configuration for each location, but not both.</p> </important>
-     * @public
-     */
-    locations: ProtectedQueryDistributeOutputConfigurationLocation[] | undefined;
-}
-/**
- * <p>Contains configuration details for protected query output.</p>
- * @public
- */
-export type ProtectedQueryOutputConfiguration = ProtectedQueryOutputConfiguration.DistributeMember | ProtectedQueryOutputConfiguration.MemberMember | ProtectedQueryOutputConfiguration.S3Member | ProtectedQueryOutputConfiguration.$UnknownMember;
-/**
- * @public
- */
-export declare namespace ProtectedQueryOutputConfiguration {
-    /**
-     * <p>Required configuration for a protected query with an <code>s3</code> output type.</p>
-     * @public
-     */
-    interface S3Member {
-        s3: ProtectedQueryS3OutputConfiguration;
-        member?: never;
-        distribute?: never;
-        $unknown?: never;
-    }
-    /**
-     * <p> Required configuration for a protected query with a <code>member</code> output type.</p>
-     * @public
-     */
-    interface MemberMember {
-        s3?: never;
-        member: ProtectedQueryMemberOutputConfiguration;
-        distribute?: never;
-        $unknown?: never;
-    }
-    /**
-     * <p> Required configuration for a protected query with a <code>distribute</code> output type.</p>
-     * @public
-     */
-    interface DistributeMember {
-        s3?: never;
-        member?: never;
-        distribute: ProtectedQueryDistributeOutputConfiguration;
-        $unknown?: never;
-    }
-    /**
-     * @public
-     */
-    interface $UnknownMember {
-        s3?: never;
-        member?: never;
-        distribute?: never;
-        $unknown: [string, any];
-    }
-    /**
-     * @deprecated unused in schema-serde mode.
-     *
-     */
-    interface Visitor<T> {
-        s3: (value: ProtectedQueryS3OutputConfiguration) => T;
-        member: (value: ProtectedQueryMemberOutputConfiguration) => T;
-        distribute: (value: ProtectedQueryDistributeOutputConfiguration) => T;
-        _: (name: string, value: any) => T;
-    }
-}
-/**
- * <p>Contains configurations for protected query results.</p>
- * @public
- */
-export interface ProtectedQueryResultConfiguration {
-    /**
-     * <p>Configuration for protected query results.</p>
-     * @public
-     */
-    outputConfiguration: ProtectedQueryOutputConfiguration | undefined;
-}
-/**
- * <p>The parameters for the SQL type Protected Query.</p>
- * @public
- */
-export interface ProtectedQuerySQLParameters {
-    /**
-     * <p>The query string to be submitted.</p>
-     * @public
-     */
-    queryString?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>
-     * @public
-     */
-    analysisTemplateArn?: string | undefined;
-    /**
-     * <p>The protected query SQL parameters.</p>
-     * @public
-     */
-    parameters?: Record<string, string> | undefined;
-}
-/**
- * <p> Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected query.</p>
- * @public
- */
-export interface BilledResourceUtilization {
-    /**
-     * <p> The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.</p>
-     * @public
-     */
-    units: number | undefined;
-}
-/**
- * <p>Contains statistics about the execution of the protected query.</p>
- * @public
- */
-export interface ProtectedQueryStatistics {
-    /**
-     * <p>The duration of the protected query, from creation until query completion, in milliseconds.</p>
-     * @public
-     */
-    totalDurationInMillis?: number | undefined;
-    /**
-     * <p> The billed resource utilization.</p>
-     * @public
-     */
-    billedResourceUtilization?: BilledResourceUtilization | undefined;
-}
-/**
- * @public
- * @enum
- */
-export declare const ProtectedQueryStatus: {
-    readonly CANCELLED: "CANCELLED";
-    readonly CANCELLING: "CANCELLING";
-    readonly FAILED: "FAILED";
-    readonly STARTED: "STARTED";
-    readonly SUBMITTED: "SUBMITTED";
-    readonly SUCCESS: "SUCCESS";
-    readonly TIMED_OUT: "TIMED_OUT";
-};
-/**
- * @public
- */
-export type ProtectedQueryStatus = (typeof ProtectedQueryStatus)[keyof typeof ProtectedQueryStatus];
+import { AnalysisType, DifferentialPrivacyAggregationType, MemberAbility, MembershipJobLogStatus, MembershipQueryLogStatus, MembershipStatus, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetType, ProtectedJobAnalysisType, ProtectedJobStatus, ProtectedJobType, ProtectedQueryStatus, ProtectedQueryType, TargetProtectedJobStatus, TargetProtectedQueryStatus } from "./enums";
+import { AccessBudgetsPrivacyTemplateParametersInput, AccessBudgetsPrivacyTemplateUpdateParameters, ComputeConfiguration, DifferentialPrivacyParameters, Membership, MembershipPaymentConfiguration, MembershipProtectedJobResultConfiguration, MembershipProtectedQueryResultConfiguration, MLMemberAbilities, PrivacyBudget, PrivacyBudgetTemplateParametersOutput, ProtectedJob, ProtectedJobComputeConfiguration, ProtectedJobParameters, ProtectedQueryError, ProtectedQueryResult, ProtectedQueryResultConfiguration, ProtectedQuerySQLParameters, ProtectedQueryStatistics } from "./models_0";
 /**
  * <p>The parameters for an Clean Rooms protected query.</p>
  * @public
@@ -1099,17 +789,6 @@ export interface StartProtectedJobOutput {
      */
     protectedJob: ProtectedJob | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const ProtectedQueryType: {
-    readonly SQL: "SQL";
-};
-/**
- * @public
- */
-export type ProtectedQueryType = (typeof ProtectedQueryType)[keyof typeof ProtectedQueryType];
 /**
  * @public
  */
@@ -1220,17 +899,6 @@ export interface UpdateProtectedJobOutput {
      */
     protectedJob: ProtectedJob | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const TargetProtectedQueryStatus: {
-    readonly CANCELLED: "CANCELLED";
-};
-/**
- * @public
- */
-export type TargetProtectedQueryStatus = (typeof TargetProtectedQueryStatus)[keyof typeof TargetProtectedQueryStatus];
 /**
  * @public
  */

package/dist-types/ts3.4/models/enums.d.ts

@@ -12,6 +12,11 @@ export declare const AccessBudgetType: {
 };
 export type AccessBudgetType =
   (typeof AccessBudgetType)[keyof typeof AccessBudgetType];
+export declare const AccessDeniedExceptionReason: {
+  readonly INSUFFICIENT_PERMISSIONS: "INSUFFICIENT_PERMISSIONS";
+};
+export type AccessDeniedExceptionReason =
+  (typeof AccessDeniedExceptionReason)[keyof typeof AccessDeniedExceptionReason];
 export declare const AdditionalAnalyses: {
   readonly ALLOWED: "ALLOWED";
   readonly NOT_ALLOWED: "NOT_ALLOWED";
@@ -19,6 +24,20 @@ export declare const AdditionalAnalyses: {
 };
 export type AdditionalAnalyses =
   (typeof AdditionalAnalyses)[keyof typeof AdditionalAnalyses];
+export declare const AggregateFunctionName: {
+  readonly AVG: "AVG";
+  readonly COUNT: "COUNT";
+  readonly COUNT_DISTINCT: "COUNT_DISTINCT";
+  readonly SUM: "SUM";
+  readonly SUM_DISTINCT: "SUM_DISTINCT";
+};
+export type AggregateFunctionName =
+  (typeof AggregateFunctionName)[keyof typeof AggregateFunctionName];
+export declare const AggregationType: {
+  readonly COUNT_DISTINCT: "COUNT_DISTINCT";
+};
+export type AggregationType =
+  (typeof AggregationType)[keyof typeof AggregationType];
 export declare const SupportedS3Region: {
   readonly AF_SOUTH_1: "af-south-1";
   readonly AP_EAST_1: "ap-east-1";
@@ -100,6 +119,44 @@ export declare const ParameterType: {
   readonly VARCHAR: "VARCHAR";
 };
 export type ParameterType = (typeof ParameterType)[keyof typeof ParameterType];
+export declare const JoinOperator: {
+  readonly AND: "AND";
+  readonly OR: "OR";
+};
+export type JoinOperator = (typeof JoinOperator)[keyof typeof JoinOperator];
+export declare const JoinRequiredOption: {
+  readonly QUERY_RUNNER: "QUERY_RUNNER";
+};
+export type JoinRequiredOption =
+  (typeof JoinRequiredOption)[keyof typeof JoinRequiredOption];
+export declare const ScalarFunctions: {
+  readonly ABS: "ABS";
+  readonly CAST: "CAST";
+  readonly CEILING: "CEILING";
+  readonly COALESCE: "COALESCE";
+  readonly CONVERT: "CONVERT";
+  readonly CURRENT_DATE: "CURRENT_DATE";
+  readonly DATEADD: "DATEADD";
+  readonly EXTRACT: "EXTRACT";
+  readonly FLOOR: "FLOOR";
+  readonly GETDATE: "GETDATE";
+  readonly LN: "LN";
+  readonly LOG: "LOG";
+  readonly LOWER: "LOWER";
+  readonly ROUND: "ROUND";
+  readonly RTRIM: "RTRIM";
+  readonly SQRT: "SQRT";
+  readonly SUBSTRING: "SUBSTRING";
+  readonly TO_CHAR: "TO_CHAR";
+  readonly TO_DATE: "TO_DATE";
+  readonly TO_NUMBER: "TO_NUMBER";
+  readonly TO_TIMESTAMP: "TO_TIMESTAMP";
+  readonly TRIM: "TRIM";
+  readonly TRUNC: "TRUNC";
+  readonly UPPER: "UPPER";
+};
+export type ScalarFunctions =
+  (typeof ScalarFunctions)[keyof typeof ScalarFunctions];
 export declare const AnalysisRuleType: {
   readonly AGGREGATION: "AGGREGATION";
   readonly CUSTOM: "CUSTOM";
@@ -125,6 +182,28 @@ export declare const AnalysisTemplateValidationType: {
 };
 export type AnalysisTemplateValidationType =
   (typeof AnalysisTemplateValidationType)[keyof typeof AnalysisTemplateValidationType];
+export declare const ConflictExceptionReason: {
+  readonly ALREADY_EXISTS: "ALREADY_EXISTS";
+  readonly INVALID_STATE: "INVALID_STATE";
+  readonly SUBRESOURCES_EXIST: "SUBRESOURCES_EXIST";
+};
+export type ConflictExceptionReason =
+  (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
+export declare const ResourceType: {
+  readonly COLLABORATION: "COLLABORATION";
+  readonly CONFIGURED_TABLE: "CONFIGURED_TABLE";
+  readonly CONFIGURED_TABLE_ASSOCIATION: "CONFIGURED_TABLE_ASSOCIATION";
+  readonly MEMBERSHIP: "MEMBERSHIP";
+};
+export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
+export declare const ValidationExceptionReason: {
+  readonly FIELD_VALIDATION_FAILED: "FIELD_VALIDATION_FAILED";
+  readonly IAM_SYNCHRONIZATION_DELAY: "IAM_SYNCHRONIZATION_DELAY";
+  readonly INVALID_CONFIGURATION: "INVALID_CONFIGURATION";
+  readonly INVALID_QUERY: "INVALID_QUERY";
+};
+export type ValidationExceptionReason =
+  (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
 export declare const AnalysisType: {
   readonly ADDITIONAL_ANALYSIS: "ADDITIONAL_ANALYSIS";
   readonly DIRECT_ANALYSIS: "DIRECT_ANALYSIS";
@@ -244,6 +323,13 @@ export declare const CollaborationQueryLogStatus: {
 };
 export type CollaborationQueryLogStatus =
   (typeof CollaborationQueryLogStatus)[keyof typeof CollaborationQueryLogStatus];
+export declare const MemberStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly INVITED: "INVITED";
+  readonly LEFT: "LEFT";
+  readonly REMOVED: "REMOVED";
+};
+export type MemberStatus = (typeof MemberStatus)[keyof typeof MemberStatus];
 export declare const ChangeSpecificationType: {
   readonly MEMBER: "MEMBER";
 };
@@ -283,6 +369,12 @@ export declare const DifferentialPrivacyAggregationType: {
 };
 export type DifferentialPrivacyAggregationType =
   (typeof DifferentialPrivacyAggregationType)[keyof typeof DifferentialPrivacyAggregationType];
+export declare const FilterableMemberStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly INVITED: "INVITED";
+};
+export type FilterableMemberStatus =
+  (typeof FilterableMemberStatus)[keyof typeof FilterableMemberStatus];
 export declare const ConfiguredTableAssociationAnalysisRuleType: {
   readonly AGGREGATION: "AGGREGATION";
   readonly CUSTOM: "CUSTOM";
@@ -303,6 +395,11 @@ export declare const JobType: {
   readonly INCREMENTAL: "INCREMENTAL";
 };
 export type JobType = (typeof JobType)[keyof typeof JobType];
+export declare const ResultFormat: {
+  readonly CSV: "CSV";
+  readonly PARQUET: "PARQUET";
+};
+export type ResultFormat = (typeof ResultFormat)[keyof typeof ResultFormat];
 export declare const MembershipJobLogStatus: {
   readonly DISABLED: "DISABLED";
   readonly ENABLED: "ENABLED";
@@ -315,6 +412,13 @@ export declare const MembershipQueryLogStatus: {
 };
 export type MembershipQueryLogStatus =
   (typeof MembershipQueryLogStatus)[keyof typeof MembershipQueryLogStatus];
+export declare const MembershipStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly COLLABORATION_DELETED: "COLLABORATION_DELETED";
+  readonly REMOVED: "REMOVED";
+};
+export type MembershipStatus =
+  (typeof MembershipStatus)[keyof typeof MembershipStatus];
 export declare const ProtectedJobWorkerComputeType: {
   readonly CR1X: "CR.1X";
   readonly CR4X: "CR.4X";
@@ -337,6 +441,17 @@ export declare const WorkerComputeType: {
 };
 export type WorkerComputeType =
   (typeof WorkerComputeType)[keyof typeof WorkerComputeType];
+export declare const ProtectedQueryStatus: {
+  readonly CANCELLED: "CANCELLED";
+  readonly CANCELLING: "CANCELLING";
+  readonly FAILED: "FAILED";
+  readonly STARTED: "STARTED";
+  readonly SUBMITTED: "SUBMITTED";
+  readonly SUCCESS: "SUCCESS";
+  readonly TIMED_OUT: "TIMED_OUT";
+};
+export type ProtectedQueryStatus =
+  (typeof ProtectedQueryStatus)[keyof typeof ProtectedQueryStatus];
 export declare const ProtectedJobAnalysisType: {
   readonly DIRECT_ANALYSIS: "DIRECT_ANALYSIS";
 };
@@ -347,8 +462,18 @@ export declare const ProtectedJobType: {
 };
 export type ProtectedJobType =
   (typeof ProtectedJobType)[keyof typeof ProtectedJobType];
+export declare const ProtectedQueryType: {
+  readonly SQL: "SQL";
+};
+export type ProtectedQueryType =
+  (typeof ProtectedQueryType)[keyof typeof ProtectedQueryType];
 export declare const TargetProtectedJobStatus: {
   readonly CANCELLED: "CANCELLED";
 };
 export type TargetProtectedJobStatus =
   (typeof TargetProtectedJobStatus)[keyof typeof TargetProtectedJobStatus];
+export declare const TargetProtectedQueryStatus: {
+  readonly CANCELLED: "CANCELLED";
+};
+export type TargetProtectedQueryStatus =
+  (typeof TargetProtectedQueryStatus)[keyof typeof TargetProtectedQueryStatus];

package/dist-types/ts3.4/models/errors.d.ts

@@ -4,9 +4,9 @@ import {
   AccessDeniedExceptionReason,
   ConflictExceptionReason,
   ResourceType,
-  ValidationExceptionField,
   ValidationExceptionReason,
-} from "./models_0";
+} from "./enums";
+import { ValidationExceptionField } from "./models_0";
 export declare class AccessDeniedException extends __BaseException {
   readonly name: "AccessDeniedException";
   readonly $fault: "client";