@aws-sdk/client-cleanrooms 3.616.0 → 3.619.0

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

@@ -0,0 +1,430 @@
+import { PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetTemplateParametersOutput, PrivacyBudgetType, ProtectedQuery } from "./models_0";
+/**
+ * @public
+ */
+export interface UpdateProtectedQueryOutput {
+    /**
+     * <p>The protected query output.</p>
+     * @public
+     */
+    protectedQuery: ProtectedQuery | undefined;
+}
+/**
+ * <p>The epsilon and noise parameter values that you want to use for the differential privacy template.</p>
+ * @public
+ */
+export interface DifferentialPrivacyTemplateParametersInput {
+    /**
+     * <p>The epsilon value that you want to use.</p>
+     * @public
+     */
+    epsilon: number | undefined;
+    /**
+     * <p>Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.</p>
+     * @public
+     */
+    usersNoisePerQuery: number | undefined;
+}
+/**
+ * <p>The epsilon and noise parameters that you want to use for the privacy budget template.</p>
+ * @public
+ */
+export type PrivacyBudgetTemplateParametersInput = PrivacyBudgetTemplateParametersInput.DifferentialPrivacyMember | PrivacyBudgetTemplateParametersInput.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace PrivacyBudgetTemplateParametersInput {
+    /**
+     * <p>An object that specifies the epsilon and noise parameters.</p>
+     * @public
+     */
+    interface DifferentialPrivacyMember {
+        differentialPrivacy: DifferentialPrivacyTemplateParametersInput;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        differentialPrivacy?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        differentialPrivacy: (value: DifferentialPrivacyTemplateParametersInput) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: PrivacyBudgetTemplateParametersInput, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface CreatePrivacyBudgetTemplateInput {
+    /**
+     * <p>A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.</p>
+     * @public
+     */
+    membershipIdentifier: string | undefined;
+    /**
+     * <p>How often the privacy budget refreshes.</p>
+     *          <important>
+     *             <p>If you plan to regularly bring new data into the collaboration, you can use <code>CALENDAR_MONTH</code> to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.</p>
+     *          </important>
+     * @public
+     */
+    autoRefresh: PrivacyBudgetTemplateAutoRefresh | undefined;
+    /**
+     * <p>Specifies the type of the privacy budget template.</p>
+     * @public
+     */
+    privacyBudgetType: PrivacyBudgetType | undefined;
+    /**
+     * <p>Specifies your parameters for the privacy budget template.</p>
+     * @public
+     */
+    parameters: PrivacyBudgetTemplateParametersInput | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * <p>An object that defines the privacy budget template.</p>
+ * @public
+ */
+export interface PrivacyBudgetTemplate {
+    /**
+     * <p>The unique identifier of the privacy budget template.</p>
+     * @public
+     */
+    id: string | undefined;
+    /**
+     * <p>The ARN of the privacy budget template.</p>
+     * @public
+     */
+    arn: string | undefined;
+    /**
+     * <p>The identifier for a membership resource.</p>
+     * @public
+     */
+    membershipId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the member who created the privacy budget template.</p>
+     * @public
+     */
+    membershipArn: string | undefined;
+    /**
+     * <p>The unique ID of the collaboration that contains this privacy budget template.</p>
+     * @public
+     */
+    collaborationId: string | undefined;
+    /**
+     * <p>The ARN of the collaboration that contains this privacy budget template.</p>
+     * @public
+     */
+    collaborationArn: string | undefined;
+    /**
+     * <p>The time at which the privacy budget template was created.</p>
+     * @public
+     */
+    createTime: Date | undefined;
+    /**
+     * <p>The most recent time at which the privacy budget template was updated.</p>
+     * @public
+     */
+    updateTime: Date | undefined;
+    /**
+     * <p>Specifies the type of the privacy budget template.</p>
+     * @public
+     */
+    privacyBudgetType: PrivacyBudgetType | undefined;
+    /**
+     * <p>How often the privacy budget refreshes.</p>
+     *          <important>
+     *             <p>If you plan to regularly bring new data into the collaboration, use <code>CALENDAR_MONTH</code> to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.</p>
+     *          </important>
+     * @public
+     */
+    autoRefresh: PrivacyBudgetTemplateAutoRefresh | undefined;
+    /**
+     * <p>Specifies the
+     *          epsilon
+     *          and noise parameters for the privacy budget template.</p>
+     * @public
+     */
+    parameters: PrivacyBudgetTemplateParametersOutput | undefined;
+}
+/**
+ * @public
+ */
+export interface CreatePrivacyBudgetTemplateOutput {
+    /**
+     * <p>A summary of the elements in the privacy budget template.</p>
+     * @public
+     */
+    privacyBudgetTemplate: PrivacyBudgetTemplate | undefined;
+}
+/**
+ * @public
+ */
+export interface DeletePrivacyBudgetTemplateInput {
+    /**
+     * <p>A unique identifier for one of your memberships for a collaboration. The privacy budget template is deleted from the collaboration that this membership belongs to. Accepts a membership ID.</p>
+     * @public
+     */
+    membershipIdentifier: string | undefined;
+    /**
+     * <p>A unique identifier for your privacy budget template. </p>
+     * @public
+     */
+    privacyBudgetTemplateIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeletePrivacyBudgetTemplateOutput {
+}
+/**
+ * @public
+ */
+export interface GetPrivacyBudgetTemplateInput {
+    /**
+     * <p>A unique identifier for one of your memberships for a collaboration. The privacy budget template is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.</p>
+     * @public
+     */
+    membershipIdentifier: string | undefined;
+    /**
+     * <p>A unique identifier for your privacy budget template.</p>
+     * @public
+     */
+    privacyBudgetTemplateIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetPrivacyBudgetTemplateOutput {
+    /**
+     * <p>Returns the details of the privacy budget template that you requested.</p>
+     * @public
+     */
+    privacyBudgetTemplate: PrivacyBudgetTemplate | undefined;
+}
+/**
+ * @public
+ */
+export interface ListPrivacyBudgetTemplatesInput {
+    /**
+     * <p>A unique identifier for one of your memberships for a collaboration. The privacy budget templates are retrieved from the collaboration that this membership belongs to. Accepts a membership ID.</p>
+     * @public
+     */
+    membershipIdentifier: string | undefined;
+    /**
+     * <p>The token value retrieved from a previous call to access the next page of
+     *          results.</p>
+     * @public
+     */
+    nextToken?: string;
+    /**
+     * <p>The maximum size of the results that is returned per call. Service chooses a default if
+     *          it has not been set. Service may return a nextToken even if the maximum results has not
+     *          been met.</p>
+     * @public
+     */
+    maxResults?: number;
+}
+/**
+ * <p>A summary of the privacy budget template. The summary includes membership information, collaboration information, and creation information.</p>
+ * @public
+ */
+export interface PrivacyBudgetTemplateSummary {
+    /**
+     * <p>The unique identifier of the privacy budget template.</p>
+     * @public
+     */
+    id: string | undefined;
+    /**
+     * <p>The ARN of the privacy budget template.</p>
+     * @public
+     */
+    arn: string | undefined;
+    /**
+     * <p>The identifier for a membership resource.</p>
+     * @public
+     */
+    membershipId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the member who created the privacy budget template.</p>
+     * @public
+     */
+    membershipArn: string | undefined;
+    /**
+     * <p>The unique ID of the collaboration that contains this privacy budget template.</p>
+     * @public
+     */
+    collaborationId: string | undefined;
+    /**
+     * <p>The ARN of the collaboration that contains this privacy budget template.</p>
+     * @public
+     */
+    collaborationArn: string | undefined;
+    /**
+     * <p>The type of the privacy budget template.</p>
+     * @public
+     */
+    privacyBudgetType: PrivacyBudgetType | undefined;
+    /**
+     * <p>The time at which the privacy budget template was created.</p>
+     * @public
+     */
+    createTime: Date | undefined;
+    /**
+     * <p>The most recent time at which the privacy budget template was updated.</p>
+     * @public
+     */
+    updateTime: Date | undefined;
+}
+/**
+ * @public
+ */
+export interface ListPrivacyBudgetTemplatesOutput {
+    /**
+     * <p>The token value retrieved from a previous call to access the next page of
+     *          results.</p>
+     * @public
+     */
+    nextToken?: string;
+    /**
+     * <p>An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.</p>
+     * @public
+     */
+    privacyBudgetTemplateSummaries: PrivacyBudgetTemplateSummary[] | undefined;
+}
+/**
+ * <p>The epsilon and noise parameter values that you want to update in the differential privacy template.</p>
+ * @public
+ */
+export interface DifferentialPrivacyTemplateUpdateParameters {
+    /**
+     * <p>The updated epsilon value that you want to use.</p>
+     * @public
+     */
+    epsilon?: number;
+    /**
+     * <p>The updated value of noise added per query. It is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.</p>
+     * @public
+     */
+    usersNoisePerQuery?: number;
+}
+/**
+ * <p>The epsilon and noise parameters that you want to update in the privacy budget template.</p>
+ * @public
+ */
+export type PrivacyBudgetTemplateUpdateParameters = PrivacyBudgetTemplateUpdateParameters.DifferentialPrivacyMember | PrivacyBudgetTemplateUpdateParameters.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace PrivacyBudgetTemplateUpdateParameters {
+    /**
+     * <p>An object that specifies the new values for the epsilon and noise parameters.</p>
+     * @public
+     */
+    interface DifferentialPrivacyMember {
+        differentialPrivacy: DifferentialPrivacyTemplateUpdateParameters;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        differentialPrivacy?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        differentialPrivacy: (value: DifferentialPrivacyTemplateUpdateParameters) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: PrivacyBudgetTemplateUpdateParameters, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface UpdatePrivacyBudgetTemplateInput {
+    /**
+     * <p>A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.</p>
+     * @public
+     */
+    membershipIdentifier: string | undefined;
+    /**
+     * <p>A unique identifier for your privacy budget template that you want to update.</p>
+     * @public
+     */
+    privacyBudgetTemplateIdentifier: string | undefined;
+    /**
+     * <p>Specifies the type of the privacy budget template.</p>
+     * @public
+     */
+    privacyBudgetType: PrivacyBudgetType | undefined;
+    /**
+     * <p>Specifies the epsilon and noise parameters for the privacy budget template.</p>
+     * @public
+     */
+    parameters?: PrivacyBudgetTemplateUpdateParameters;
+}
+/**
+ * @public
+ */
+export interface UpdatePrivacyBudgetTemplateOutput {
+    /**
+     * <p>Summary of the privacy budget template.</p>
+     * @public
+     */
+    privacyBudgetTemplate: PrivacyBudgetTemplate | undefined;
+}
+/**
+ * @public
+ */
+export interface TagResourceInput {
+    /**
+     * <p>The Amazon Resource Name (ARN) associated with the resource you want to tag.</p>
+     * @public
+     */
+    resourceArn: string | undefined;
+    /**
+     * <p>A map of objects specifying each key name and value.</p>
+     * @public
+     */
+    tags: Record<string, string> | undefined;
+}
+/**
+ * @public
+ */
+export interface TagResourceOutput {
+}
+/**
+ * @public
+ */
+export interface UntagResourceInput {
+    /**
+     * <p>The Amazon Resource Name (ARN) associated with the resource you want to remove the tag
+     *          from.</p>
+     * @public
+     */
+    resourceArn: string | undefined;
+    /**
+     * <p>A list of key names of tags to be removed.</p>
+     * @public
+     */
+    tagKeys: string[] | undefined;
+}
+/**
+ * @public
+ */
+export interface UntagResourceOutput {
+}
+/**
+ * @internal
+ */
+export declare const UpdateProtectedQueryOutputFilterSensitiveLog: (obj: UpdateProtectedQueryOutput) => any;

package/dist-types/pagination/ListCollaborationIdNamespaceAssociationsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListCollaborationIdNamespaceAssociationsCommandInput, ListCollaborationIdNamespaceAssociationsCommandOutput } from "../commands/ListCollaborationIdNamespaceAssociationsCommand";
+import { CleanRoomsPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListCollaborationIdNamespaceAssociations: (config: CleanRoomsPaginationConfiguration, input: ListCollaborationIdNamespaceAssociationsCommandInput, ...rest: any[]) => Paginator<ListCollaborationIdNamespaceAssociationsCommandOutput>;

package/dist-types/pagination/ListIdMappingTablesPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListIdMappingTablesCommandInput, ListIdMappingTablesCommandOutput } from "../commands/ListIdMappingTablesCommand";
+import { CleanRoomsPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListIdMappingTables: (config: CleanRoomsPaginationConfiguration, input: ListIdMappingTablesCommandInput, ...rest: any[]) => Paginator<ListIdMappingTablesCommandOutput>;

package/dist-types/pagination/ListIdNamespaceAssociationsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListIdNamespaceAssociationsCommandInput, ListIdNamespaceAssociationsCommandOutput } from "../commands/ListIdNamespaceAssociationsCommand";
+import { CleanRoomsPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListIdNamespaceAssociations: (config: CleanRoomsPaginationConfiguration, input: ListIdNamespaceAssociationsCommandInput, ...rest: any[]) => Paginator<ListIdNamespaceAssociationsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -2,12 +2,15 @@ export * from "./Interfaces";
 export * from "./ListAnalysisTemplatesPaginator";
 export * from "./ListCollaborationAnalysisTemplatesPaginator";
 export * from "./ListCollaborationConfiguredAudienceModelAssociationsPaginator";
+export * from "./ListCollaborationIdNamespaceAssociationsPaginator";
 export * from "./ListCollaborationPrivacyBudgetTemplatesPaginator";
 export * from "./ListCollaborationPrivacyBudgetsPaginator";
 export * from "./ListCollaborationsPaginator";
 export * from "./ListConfiguredAudienceModelAssociationsPaginator";
 export * from "./ListConfiguredTableAssociationsPaginator";
 export * from "./ListConfiguredTablesPaginator";
+export * from "./ListIdMappingTablesPaginator";
+export * from "./ListIdNamespaceAssociationsPaginator";
 export * from "./ListMembersPaginator";
 export * from "./ListMembershipsPaginator";
 export * from "./ListPrivacyBudgetTemplatesPaginator";