@aws-sdk/client-personalize 3.35.0 → 3.38.0

package/src/commands/CreateDatasetCommand.ts

@@ -1,145 +0,0 @@
-import { getSerdePlugin } from "@aws-sdk/middleware-serde";
-import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  FinalizeHandlerArguments,
-  Handler,
-  HandlerExecutionContext,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-  SerdeContext as __SerdeContext,
-} from "@aws-sdk/types";
-
-import { CreateDatasetRequest, CreateDatasetResponse } from "../models/models_0";
-import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
-import {
-  deserializeAws_json1_1CreateDatasetCommand,
-  serializeAws_json1_1CreateDatasetCommand,
-} from "../protocols/Aws_json1_1";
-
-export interface CreateDatasetCommandInput extends CreateDatasetRequest {}
-export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __MetadataBearer {}
-
-/**
- * <p>Creates an empty dataset and adds it to the specified dataset group. Use <a>CreateDatasetImportJob</a> to import your training data to a dataset.</p>
- *          <p>There are three types of datasets:</p>
- *          <ul>
- *             <li>
- *                <p>Interactions</p>
- *             </li>
- *             <li>
- *                <p>Items</p>
- *             </li>
- *             <li>
- *                <p>Users</p>
- *             </li>
- *          </ul>
- *          <p>Each dataset type has an associated schema with required field types. Only the
- *         <code>Interactions</code> dataset is required in order to train a model (also referred to as
- *       creating a solution).</p>
- *          <p>A dataset can be in one of the following states:</p>
- *          <ul>
- *             <li>
- *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
- *             </li>
- *             <li>
- *                <p>DELETE PENDING > DELETE IN_PROGRESS</p>
- *             </li>
- *          </ul>
- *          <p>To get the status of the dataset, call <a>DescribeDataset</a>.</p>
- *          <p class="title">
- *             <b>Related APIs</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>CreateDatasetGroup</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>ListDatasets</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>DescribeDataset</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>DeleteDataset</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { PersonalizeClient, CreateDatasetCommand } from "@aws-sdk/client-personalize"; // ES Modules import
- * // const { PersonalizeClient, CreateDatasetCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
- * const client = new PersonalizeClient(config);
- * const command = new CreateDatasetCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link CreateDatasetCommandInput} for command's `input` shape.
- * @see {@link CreateDatasetCommandOutput} for command's `response` shape.
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
- *
- */
-export class CreateDatasetCommand extends $Command<
-  CreateDatasetCommandInput,
-  CreateDatasetCommandOutput,
-  PersonalizeClientResolvedConfig
-> {
-  // Start section: command_properties
-  // End section: command_properties
-
-  constructor(readonly input: CreateDatasetCommandInput) {
-    // Start section: command_constructor
-    super();
-    // End section: command_constructor
-  }
-
-  /**
-   * @internal
-   */
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PersonalizeClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<CreateDatasetCommandInput, CreateDatasetCommandOutput> {
-    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
-
-    const stack = clientStack.concat(this.middlewareStack);
-
-    const { logger } = configuration;
-    const clientName = "PersonalizeClient";
-    const commandName = "CreateDatasetCommand";
-    const handlerExecutionContext: HandlerExecutionContext = {
-      logger,
-      clientName,
-      commandName,
-      inputFilterSensitiveLog: CreateDatasetRequest.filterSensitiveLog,
-      outputFilterSensitiveLog: CreateDatasetResponse.filterSensitiveLog,
-    };
-    const { requestHandler } = configuration;
-    return stack.resolve(
-      (request: FinalizeHandlerArguments<any>) =>
-        requestHandler.handle(request.request as __HttpRequest, options || {}),
-      handlerExecutionContext
-    );
-  }
-
-  private serialize(input: CreateDatasetCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
-    return serializeAws_json1_1CreateDatasetCommand(input, context);
-  }
-
-  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<CreateDatasetCommandOutput> {
-    return deserializeAws_json1_1CreateDatasetCommand(output, context);
-  }
-
-  // Start section: command_body_extra
-  // End section: command_body_extra
-}

package/src/commands/CreateDatasetExportJobCommand.ts

@@ -1,116 +0,0 @@
-import { getSerdePlugin } from "@aws-sdk/middleware-serde";
-import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  FinalizeHandlerArguments,
-  Handler,
-  HandlerExecutionContext,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-  SerdeContext as __SerdeContext,
-} from "@aws-sdk/types";
-
-import { CreateDatasetExportJobRequest, CreateDatasetExportJobResponse } from "../models/models_0";
-import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
-import {
-  deserializeAws_json1_1CreateDatasetExportJobCommand,
-  serializeAws_json1_1CreateDatasetExportJobCommand,
-} from "../protocols/Aws_json1_1";
-
-export interface CreateDatasetExportJobCommandInput extends CreateDatasetExportJobRequest {}
-export interface CreateDatasetExportJobCommandOutput extends CreateDatasetExportJobResponse, __MetadataBearer {}
-
-/**
- * <p>
- *       Creates a job that exports data from your dataset to an Amazon S3 bucket.
- *       To allow Amazon Personalize to export the training data, you must specify an
- *       service-linked IAM role that gives Amazon Personalize <code>PutObject</code> permissions for your Amazon S3 bucket.
- *       For information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/export-data.html">Exporting a dataset</a>
- *       in the Amazon Personalize developer guide.
- *     </p>
- *          <p>
- *             <b>Status</b>
- *          </p>
- *          <p>A dataset export job can be in one of the following states:</p>
- *          <ul>
- *             <li>
- *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
- *             </li>
- *          </ul>
- *          <p>
- *       To get the status of the export job, call <a>DescribeDatasetExportJob</a>,
- *       and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is
- *       complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
- *       includes a <code>failureReason</code> key, which describes why the job failed.
- *     </p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { PersonalizeClient, CreateDatasetExportJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
- * // const { PersonalizeClient, CreateDatasetExportJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
- * const client = new PersonalizeClient(config);
- * const command = new CreateDatasetExportJobCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link CreateDatasetExportJobCommandInput} for command's `input` shape.
- * @see {@link CreateDatasetExportJobCommandOutput} for command's `response` shape.
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
- *
- */
-export class CreateDatasetExportJobCommand extends $Command<
-  CreateDatasetExportJobCommandInput,
-  CreateDatasetExportJobCommandOutput,
-  PersonalizeClientResolvedConfig
-> {
-  // Start section: command_properties
-  // End section: command_properties
-
-  constructor(readonly input: CreateDatasetExportJobCommandInput) {
-    // Start section: command_constructor
-    super();
-    // End section: command_constructor
-  }
-
-  /**
-   * @internal
-   */
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PersonalizeClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<CreateDatasetExportJobCommandInput, CreateDatasetExportJobCommandOutput> {
-    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
-
-    const stack = clientStack.concat(this.middlewareStack);
-
-    const { logger } = configuration;
-    const clientName = "PersonalizeClient";
-    const commandName = "CreateDatasetExportJobCommand";
-    const handlerExecutionContext: HandlerExecutionContext = {
-      logger,
-      clientName,
-      commandName,
-      inputFilterSensitiveLog: CreateDatasetExportJobRequest.filterSensitiveLog,
-      outputFilterSensitiveLog: CreateDatasetExportJobResponse.filterSensitiveLog,
-    };
-    const { requestHandler } = configuration;
-    return stack.resolve(
-      (request: FinalizeHandlerArguments<any>) =>
-        requestHandler.handle(request.request as __HttpRequest, options || {}),
-      handlerExecutionContext
-    );
-  }
-
-  private serialize(input: CreateDatasetExportJobCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
-    return serializeAws_json1_1CreateDatasetExportJobCommand(input, context);
-  }
-
-  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<CreateDatasetExportJobCommandOutput> {
-    return deserializeAws_json1_1CreateDatasetExportJobCommand(output, context);
-  }
-
-  // Start section: command_body_extra
-  // End section: command_body_extra
-}

package/src/commands/CreateDatasetGroupCommand.ts

@@ -1,170 +0,0 @@
-import { getSerdePlugin } from "@aws-sdk/middleware-serde";
-import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  FinalizeHandlerArguments,
-  Handler,
-  HandlerExecutionContext,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-  SerdeContext as __SerdeContext,
-} from "@aws-sdk/types";
-
-import { CreateDatasetGroupRequest, CreateDatasetGroupResponse } from "../models/models_0";
-import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
-import {
-  deserializeAws_json1_1CreateDatasetGroupCommand,
-  serializeAws_json1_1CreateDatasetGroupCommand,
-} from "../protocols/Aws_json1_1";
-
-export interface CreateDatasetGroupCommandInput extends CreateDatasetGroupRequest {}
-export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupResponse, __MetadataBearer {}
-
-/**
- * <p>Creates an empty dataset group. A dataset group contains related datasets that supply data
- *       for training a model. A dataset group can contain at most three datasets, one for each type of
- *       dataset:</p>
- *          <ul>
- *             <li>
- *                <p>Interactions</p>
- *             </li>
- *             <li>
- *                <p>Items</p>
- *             </li>
- *             <li>
- *                <p>Users</p>
- *             </li>
- *          </ul>
- *          <p>To train a model (create a solution), a dataset group that contains an
- *         <code>Interactions</code> dataset is required. Call <a>CreateDataset</a> to add a
- *       dataset to the group.</p>
- *          <p>A dataset group can be in one of the following states:</p>
- *          <ul>
- *             <li>
- *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
- *             </li>
- *             <li>
- *                <p>DELETE PENDING</p>
- *             </li>
- *          </ul>
- *          <p>To get the status of the dataset group, call <a>DescribeDatasetGroup</a>. If
- *       the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key,
- *       which describes why the creation failed.</p>
- *          <note>
- *             <p>You must wait until the <code>status</code> of the dataset group is <code>ACTIVE</code>
- *         before adding a dataset to the group.</p>
- *          </note>
- *          <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you
- *       specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to
- *       access the key.</p>
- *          <p class="title">
- *             <b>APIs that require a dataset group ARN in the request</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>CreateDataset</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>CreateEventTracker</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>CreateSolution</a>
- *                </p>
- *             </li>
- *          </ul>
- *          <p class="title">
- *             <b>Related APIs</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>ListDatasetGroups</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>DescribeDatasetGroup</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>DeleteDatasetGroup</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { PersonalizeClient, CreateDatasetGroupCommand } from "@aws-sdk/client-personalize"; // ES Modules import
- * // const { PersonalizeClient, CreateDatasetGroupCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
- * const client = new PersonalizeClient(config);
- * const command = new CreateDatasetGroupCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link CreateDatasetGroupCommandInput} for command's `input` shape.
- * @see {@link CreateDatasetGroupCommandOutput} for command's `response` shape.
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
- *
- */
-export class CreateDatasetGroupCommand extends $Command<
-  CreateDatasetGroupCommandInput,
-  CreateDatasetGroupCommandOutput,
-  PersonalizeClientResolvedConfig
-> {
-  // Start section: command_properties
-  // End section: command_properties
-
-  constructor(readonly input: CreateDatasetGroupCommandInput) {
-    // Start section: command_constructor
-    super();
-    // End section: command_constructor
-  }
-
-  /**
-   * @internal
-   */
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PersonalizeClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput> {
-    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
-
-    const stack = clientStack.concat(this.middlewareStack);
-
-    const { logger } = configuration;
-    const clientName = "PersonalizeClient";
-    const commandName = "CreateDatasetGroupCommand";
-    const handlerExecutionContext: HandlerExecutionContext = {
-      logger,
-      clientName,
-      commandName,
-      inputFilterSensitiveLog: CreateDatasetGroupRequest.filterSensitiveLog,
-      outputFilterSensitiveLog: CreateDatasetGroupResponse.filterSensitiveLog,
-    };
-    const { requestHandler } = configuration;
-    return stack.resolve(
-      (request: FinalizeHandlerArguments<any>) =>
-        requestHandler.handle(request.request as __HttpRequest, options || {}),
-      handlerExecutionContext
-    );
-  }
-
-  private serialize(input: CreateDatasetGroupCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
-    return serializeAws_json1_1CreateDatasetGroupCommand(input, context);
-  }
-
-  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<CreateDatasetGroupCommandOutput> {
-    return deserializeAws_json1_1CreateDatasetGroupCommand(output, context);
-  }
-
-  // Start section: command_body_extra
-  // End section: command_body_extra
-}

package/src/commands/CreateDatasetImportJobCommand.ts

@@ -1,136 +0,0 @@
-import { getSerdePlugin } from "@aws-sdk/middleware-serde";
-import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  FinalizeHandlerArguments,
-  Handler,
-  HandlerExecutionContext,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-  SerdeContext as __SerdeContext,
-} from "@aws-sdk/types";
-
-import { CreateDatasetImportJobRequest, CreateDatasetImportJobResponse } from "../models/models_0";
-import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
-import {
-  deserializeAws_json1_1CreateDatasetImportJobCommand,
-  serializeAws_json1_1CreateDatasetImportJobCommand,
-} from "../protocols/Aws_json1_1";
-
-export interface CreateDatasetImportJobCommandInput extends CreateDatasetImportJobRequest {}
-export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImportJobResponse, __MetadataBearer {}
-
-/**
- * <p>Creates a job that imports training data from your data source (an Amazon S3 bucket) to an
- *       Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an
- *       IAM service role that has permission to read from the data source, as Amazon Personalize makes a
- *       copy of your data and processes it internally. For information on granting access
- *       to your Amazon S3 bucket, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html">Giving Amazon Personalize
- *       Access to Amazon S3 Resources</a>. </p>
- *          <important>
- *             <p>The dataset import job replaces any existing data in the dataset that you imported in bulk.</p>
- *          </important>
- *          <p>
- *             <b>Status</b>
- *          </p>
- *          <p>A dataset import job can be in one of the following states:</p>
- *          <ul>
- *             <li>
- *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
- *             </li>
- *          </ul>
- *          <p>To get the status of the import job, call <a>DescribeDatasetImportJob</a>,
- *       providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is
- *       complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
- *       includes a <code>failureReason</code> key, which describes why the job failed.</p>
- *          <note>
- *             <p>Importing takes time. You must wait until the status shows as ACTIVE before training a
- *         model using the dataset.</p>
- *          </note>
- *
- *          <p class="title">
- *             <b>Related APIs</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>ListDatasetImportJobs</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>DescribeDatasetImportJob</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { PersonalizeClient, CreateDatasetImportJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
- * // const { PersonalizeClient, CreateDatasetImportJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
- * const client = new PersonalizeClient(config);
- * const command = new CreateDatasetImportJobCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link CreateDatasetImportJobCommandInput} for command's `input` shape.
- * @see {@link CreateDatasetImportJobCommandOutput} for command's `response` shape.
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
- *
- */
-export class CreateDatasetImportJobCommand extends $Command<
-  CreateDatasetImportJobCommandInput,
-  CreateDatasetImportJobCommandOutput,
-  PersonalizeClientResolvedConfig
-> {
-  // Start section: command_properties
-  // End section: command_properties
-
-  constructor(readonly input: CreateDatasetImportJobCommandInput) {
-    // Start section: command_constructor
-    super();
-    // End section: command_constructor
-  }
-
-  /**
-   * @internal
-   */
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PersonalizeClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput> {
-    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
-
-    const stack = clientStack.concat(this.middlewareStack);
-
-    const { logger } = configuration;
-    const clientName = "PersonalizeClient";
-    const commandName = "CreateDatasetImportJobCommand";
-    const handlerExecutionContext: HandlerExecutionContext = {
-      logger,
-      clientName,
-      commandName,
-      inputFilterSensitiveLog: CreateDatasetImportJobRequest.filterSensitiveLog,
-      outputFilterSensitiveLog: CreateDatasetImportJobResponse.filterSensitiveLog,
-    };
-    const { requestHandler } = configuration;
-    return stack.resolve(
-      (request: FinalizeHandlerArguments<any>) =>
-        requestHandler.handle(request.request as __HttpRequest, options || {}),
-      handlerExecutionContext
-    );
-  }
-
-  private serialize(input: CreateDatasetImportJobCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
-    return serializeAws_json1_1CreateDatasetImportJobCommand(input, context);
-  }
-
-  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<CreateDatasetImportJobCommandOutput> {
-    return deserializeAws_json1_1CreateDatasetImportJobCommand(output, context);
-  }
-
-  // Start section: command_body_extra
-  // End section: command_body_extra
-}