@aws-sdk/client-cleanroomsml 3.462.0

package/dist-types/commands/StartAudienceGenerationJobCommand.d.ts

@@ -0,0 +1,101 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient";
+import { StartAudienceGenerationJobRequest, StartAudienceGenerationJobResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartAudienceGenerationJobCommand}.
+ */
+export interface StartAudienceGenerationJobCommandInput extends StartAudienceGenerationJobRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartAudienceGenerationJobCommand}.
+ */
+export interface StartAudienceGenerationJobCommandOutput extends StartAudienceGenerationJobResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Information necessary to start the audience generation job.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CleanRoomsMLClient, StartAudienceGenerationJobCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
+ * // const { CleanRoomsMLClient, StartAudienceGenerationJobCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
+ * const client = new CleanRoomsMLClient(config);
+ * const input = { // StartAudienceGenerationJobRequest
+ *   name: "STRING_VALUE", // required
+ *   configuredAudienceModelArn: "STRING_VALUE", // required
+ *   seedAudience: { // AudienceGenerationJobDataSource
+ *     dataSource: { // S3ConfigMap
+ *       s3Uri: "STRING_VALUE", // required
+ *     },
+ *     roleArn: "STRING_VALUE", // required
+ *   },
+ *   includeSeedInOutput: true || false,
+ *   collaborationId: "STRING_VALUE",
+ *   description: "STRING_VALUE",
+ *   tags: { // TagMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new StartAudienceGenerationJobCommand(input);
+ * const response = await client.send(command);
+ * // { // StartAudienceGenerationJobResponse
+ * //   audienceGenerationJobArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param StartAudienceGenerationJobCommandInput - {@link StartAudienceGenerationJobCommandInput}
+ * @returns {@link StartAudienceGenerationJobCommandOutput}
+ * @see {@link StartAudienceGenerationJobCommandInput} for command's `input` shape.
+ * @see {@link StartAudienceGenerationJobCommandOutput} for command's `response` shape.
+ * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>A resource with that name already exists in this region.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource you are requesting does not exist.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>You have exceeded your service quota.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request parameters for this request are incorrect.</p>
+ *
+ * @throws {@link CleanRoomsMLServiceException}
+ * <p>Base exception class for all service exceptions from CleanRoomsML service.</p>
+ *
+ */
+export declare class StartAudienceGenerationJobCommand extends $Command<StartAudienceGenerationJobCommandInput, StartAudienceGenerationJobCommandOutput, CleanRoomsMLClientResolvedConfig> {
+    readonly input: StartAudienceGenerationJobCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: StartAudienceGenerationJobCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsMLClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartAudienceGenerationJobCommandInput, StartAudienceGenerationJobCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/TagResourceCommand.d.ts

@@ -0,0 +1,83 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient";
+import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandInput extends TagResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Adds metadata tags to a specified resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CleanRoomsMLClient, TagResourceCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
+ * // const { CleanRoomsMLClient, TagResourceCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
+ * const client = new CleanRoomsMLClient(config);
+ * const input = { // TagResourceRequest
+ *   resourceArn: "STRING_VALUE", // required
+ *   tags: { // TagMap // required
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
+ * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource you are requesting does not exist.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request parameters for this request are incorrect.</p>
+ *
+ * @throws {@link CleanRoomsMLServiceException}
+ * <p>Base exception class for all service exceptions from CleanRoomsML service.</p>
+ *
+ */
+export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, CleanRoomsMLClientResolvedConfig> {
+    readonly input: TagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: TagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsMLClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -0,0 +1,83 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient";
+import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandInput extends UntagResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Removes metadata tags from a specified resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CleanRoomsMLClient, UntagResourceCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
+ * // const { CleanRoomsMLClient, UntagResourceCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
+ * const client = new CleanRoomsMLClient(config);
+ * const input = { // UntagResourceRequest
+ *   resourceArn: "STRING_VALUE", // required
+ *   tagKeys: [ // TagKeys // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
+ * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource you are requesting does not exist.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request parameters for this request are incorrect.</p>
+ *
+ * @throws {@link CleanRoomsMLServiceException}
+ * <p>Base exception class for all service exceptions from CleanRoomsML service.</p>
+ *
+ */
+export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, CleanRoomsMLClientResolvedConfig> {
+    readonly input: UntagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UntagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsMLClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/UpdateConfiguredAudienceModelCommand.d.ts

@@ -0,0 +1,105 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient";
+import { UpdateConfiguredAudienceModelRequest, UpdateConfiguredAudienceModelResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateConfiguredAudienceModelCommand}.
+ */
+export interface UpdateConfiguredAudienceModelCommandInput extends UpdateConfiguredAudienceModelRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateConfiguredAudienceModelCommand}.
+ */
+export interface UpdateConfiguredAudienceModelCommandOutput extends UpdateConfiguredAudienceModelResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CleanRoomsMLClient, UpdateConfiguredAudienceModelCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
+ * // const { CleanRoomsMLClient, UpdateConfiguredAudienceModelCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
+ * const client = new CleanRoomsMLClient(config);
+ * const input = { // UpdateConfiguredAudienceModelRequest
+ *   configuredAudienceModelArn: "STRING_VALUE", // required
+ *   outputConfig: { // ConfiguredAudienceModelOutputConfig
+ *     destination: { // AudienceDestination
+ *       s3Destination: { // S3ConfigMap
+ *         s3Uri: "STRING_VALUE", // required
+ *       },
+ *     },
+ *     roleArn: "STRING_VALUE", // required
+ *   },
+ *   audienceModelArn: "STRING_VALUE",
+ *   sharedAudienceMetrics: [ // MetricsList
+ *     "ALL" || "NONE",
+ *   ],
+ *   minMatchingSeedSize: Number("int"),
+ *   audienceSizeConfig: { // AudienceSizeConfig
+ *     audienceSizeType: "ABSOLUTE" || "PERCENTAGE", // required
+ *     audienceSizeBins: [ // AudienceSizeBins // required
+ *       Number("int"),
+ *     ],
+ *   },
+ *   description: "STRING_VALUE",
+ * };
+ * const command = new UpdateConfiguredAudienceModelCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateConfiguredAudienceModelResponse
+ * //   configuredAudienceModelArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateConfiguredAudienceModelCommandInput - {@link UpdateConfiguredAudienceModelCommandInput}
+ * @returns {@link UpdateConfiguredAudienceModelCommandOutput}
+ * @see {@link UpdateConfiguredAudienceModelCommandInput} for command's `input` shape.
+ * @see {@link UpdateConfiguredAudienceModelCommandOutput} for command's `response` shape.
+ * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>A resource with that name already exists in this region.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource you are requesting does not exist.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request parameters for this request are incorrect.</p>
+ *
+ * @throws {@link CleanRoomsMLServiceException}
+ * <p>Base exception class for all service exceptions from CleanRoomsML service.</p>
+ *
+ */
+export declare class UpdateConfiguredAudienceModelCommand extends $Command<UpdateConfiguredAudienceModelCommandInput, UpdateConfiguredAudienceModelCommandOutput, CleanRoomsMLClientResolvedConfig> {
+    readonly input: UpdateConfiguredAudienceModelCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateConfiguredAudienceModelCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsMLClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateConfiguredAudienceModelCommandInput, UpdateConfiguredAudienceModelCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,25 @@
+export * from "./CreateAudienceModelCommand";
+export * from "./CreateConfiguredAudienceModelCommand";
+export * from "./CreateTrainingDatasetCommand";
+export * from "./DeleteAudienceGenerationJobCommand";
+export * from "./DeleteAudienceModelCommand";
+export * from "./DeleteConfiguredAudienceModelCommand";
+export * from "./DeleteConfiguredAudienceModelPolicyCommand";
+export * from "./DeleteTrainingDatasetCommand";
+export * from "./GetAudienceGenerationJobCommand";
+export * from "./GetAudienceModelCommand";
+export * from "./GetConfiguredAudienceModelCommand";
+export * from "./GetConfiguredAudienceModelPolicyCommand";
+export * from "./GetTrainingDatasetCommand";
+export * from "./ListAudienceExportJobsCommand";
+export * from "./ListAudienceGenerationJobsCommand";
+export * from "./ListAudienceModelsCommand";
+export * from "./ListConfiguredAudienceModelsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./ListTrainingDatasetsCommand";
+export * from "./PutConfiguredAudienceModelPolicyCommand";
+export * from "./StartAudienceExportJobCommand";
+export * from "./StartAudienceGenerationJobCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateConfiguredAudienceModelCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,22 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string;
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,8 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface CleanRoomsMLExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * <p>API Reference for Amazon Web Services Clean Rooms ML.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./CleanRoomsMLClient";
+export * from "./CleanRoomsML";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export { RuntimeExtension } from "./runtimeExtensions";
+export { CleanRoomsMLExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+import "@aws-sdk/util-endpoints";
+export { CleanRoomsMLServiceException } from "./models/CleanRoomsMLServiceException";

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

@@ -0,0 +1,13 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export { __ServiceException, __ServiceExceptionOptions };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from CleanRoomsML service.
+ */
+export declare class CleanRoomsMLServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1 @@
+export * from "./models_0";