@aws-sdk/client-personalize 3.42.0 → 3.47.0

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

@@ -10,7 +10,8 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad
  * <p>Creates an Amazon Personalize schema from the specified schema string. The schema you create
  *       must be in Avro JSON format.</p>
  *          <p>Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset
- *       type and has a set of required field and keywords.
+ *       type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you
+ *     provide the domain of the Domain dataset group.
  *       You specify a schema when you call <a>CreateDataset</a>.</p>
  *
  *          <p class="title">

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

@@ -7,7 +7,7 @@ export interface CreateSolutionVersionCommandInput extends CreateSolutionVersion
 export interface CreateSolutionVersionCommandOutput extends CreateSolutionVersionResponse, __MetadataBearer {
 }
 /**
- * <p>Trains or retrains an active solution. A solution is created using the <a>CreateSolution</a> operation and must be in the ACTIVE state before calling
+ * <p>Trains or retrains an active solution in a Custom dataset group. A solution is created using the <a>CreateSolution</a> operation and must be in the ACTIVE state before calling
  *         <code>CreateSolutionVersion</code>. A new version of the solution is created every time you
  *       call this operation.</p>
  *          <p>

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

@@ -0,0 +1,36 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { DeleteRecommenderRequest } from "../models/models_0";
+import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
+export interface DeleteRecommenderCommandInput extends DeleteRecommenderRequest {
+}
+export interface DeleteRecommenderCommandOutput extends __MetadataBearer {
+}
+/**
+ * <p>Deactivates and removes a recommender. A deleted recommender can no longer be specified in a <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
+ *     request.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PersonalizeClient, DeleteRecommenderCommand } from "@aws-sdk/client-personalize"; // ES Modules import
+ * // const { PersonalizeClient, DeleteRecommenderCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
+ * const client = new PersonalizeClient(config);
+ * const command = new DeleteRecommenderCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link DeleteRecommenderCommandInput} for command's `input` shape.
+ * @see {@link DeleteRecommenderCommandOutput} for command's `response` shape.
+ * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
+ *
+ */
+export declare class DeleteRecommenderCommand extends $Command<DeleteRecommenderCommandInput, DeleteRecommenderCommandOutput, PersonalizeClientResolvedConfig> {
+    readonly input: DeleteRecommenderCommandInput;
+    constructor(input: DeleteRecommenderCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRecommenderCommandInput, DeleteRecommenderCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,37 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { DescribeBatchSegmentJobRequest, DescribeBatchSegmentJobResponse } from "../models/models_0";
+import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
+export interface DescribeBatchSegmentJobCommandInput extends DescribeBatchSegmentJobRequest {
+}
+export interface DescribeBatchSegmentJobCommandOutput extends DescribeBatchSegmentJobResponse, __MetadataBearer {
+}
+/**
+ * <p>Gets the properties of a batch segment job including name, Amazon Resource Name (ARN),
+ *       status, input and output configurations, and the ARN of the solution version used to generate
+ *       segments.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PersonalizeClient, DescribeBatchSegmentJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
+ * // const { PersonalizeClient, DescribeBatchSegmentJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
+ * const client = new PersonalizeClient(config);
+ * const command = new DescribeBatchSegmentJobCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link DescribeBatchSegmentJobCommandInput} for command's `input` shape.
+ * @see {@link DescribeBatchSegmentJobCommandOutput} for command's `response` shape.
+ * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
+ *
+ */
+export declare class DescribeBatchSegmentJobCommand extends $Command<DescribeBatchSegmentJobCommandInput, DescribeBatchSegmentJobCommandOutput, PersonalizeClientResolvedConfig> {
+    readonly input: DescribeBatchSegmentJobCommandInput;
+    constructor(input: DescribeBatchSegmentJobCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeBatchSegmentJobCommandInput, DescribeBatchSegmentJobCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,47 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { DescribeRecommenderRequest, DescribeRecommenderResponse } from "../models/models_0";
+import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
+export interface DescribeRecommenderCommandInput extends DescribeRecommenderRequest {
+}
+export interface DescribeRecommenderCommandOutput extends DescribeRecommenderResponse, __MetadataBearer {
+}
+/**
+ * <p>Describes the given recommender, including its status.</p>
+ *          <p>A recommender 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>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the
+ *       <code>failureReason</code> key, which describes why.</p>
+ *          <p>For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PersonalizeClient, DescribeRecommenderCommand } from "@aws-sdk/client-personalize"; // ES Modules import
+ * // const { PersonalizeClient, DescribeRecommenderCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
+ * const client = new PersonalizeClient(config);
+ * const command = new DescribeRecommenderCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link DescribeRecommenderCommandInput} for command's `input` shape.
+ * @see {@link DescribeRecommenderCommandOutput} for command's `response` shape.
+ * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
+ *
+ */
+export declare class DescribeRecommenderCommand extends $Command<DescribeRecommenderCommandInput, DescribeRecommenderCommandOutput, PersonalizeClientResolvedConfig> {
+    readonly input: DescribeRecommenderCommandInput;
+    constructor(input: DescribeRecommenderCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRecommenderCommandInput, DescribeRecommenderCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,36 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ListBatchSegmentJobsRequest, ListBatchSegmentJobsResponse } from "../models/models_0";
+import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
+export interface ListBatchSegmentJobsCommandInput extends ListBatchSegmentJobsRequest {
+}
+export interface ListBatchSegmentJobsCommandOutput extends ListBatchSegmentJobsResponse, __MetadataBearer {
+}
+/**
+ * <p>Gets a list of the batch segment jobs that have been performed off of a solution
+ *       version that you specify.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PersonalizeClient, ListBatchSegmentJobsCommand } from "@aws-sdk/client-personalize"; // ES Modules import
+ * // const { PersonalizeClient, ListBatchSegmentJobsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
+ * const client = new PersonalizeClient(config);
+ * const command = new ListBatchSegmentJobsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListBatchSegmentJobsCommandInput} for command's `input` shape.
+ * @see {@link ListBatchSegmentJobsCommandOutput} for command's `response` shape.
+ * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
+ *
+ */
+export declare class ListBatchSegmentJobsCommand extends $Command<ListBatchSegmentJobsCommandInput, ListBatchSegmentJobsCommandOutput, PersonalizeClientResolvedConfig> {
+    readonly input: ListBatchSegmentJobsCommandInput;
+    constructor(input: ListBatchSegmentJobsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBatchSegmentJobsCommandInput, ListBatchSegmentJobsCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,38 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ListRecommendersRequest, ListRecommendersResponse } from "../models/models_0";
+import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
+export interface ListRecommendersCommandInput extends ListRecommendersRequest {
+}
+export interface ListRecommendersCommandOutput extends ListRecommendersResponse, __MetadataBearer {
+}
+/**
+ * <p>Returns a list of recommenders in a given Domain dataset group.
+ *       When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
+ *       The response provides the properties for each recommender, including the Amazon Resource Name (ARN).
+ *       For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PersonalizeClient, ListRecommendersCommand } from "@aws-sdk/client-personalize"; // ES Modules import
+ * // const { PersonalizeClient, ListRecommendersCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
+ * const client = new PersonalizeClient(config);
+ * const command = new ListRecommendersCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListRecommendersCommandInput} for command's `input` shape.
+ * @see {@link ListRecommendersCommandOutput} for command's `response` shape.
+ * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
+ *
+ */
+export declare class ListRecommendersCommand extends $Command<ListRecommendersCommandInput, ListRecommendersCommandOutput, PersonalizeClientResolvedConfig> {
+    readonly input: ListRecommendersCommandInput;
+    constructor(input: ListRecommendersCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRecommendersCommandInput, ListRecommendersCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,35 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { UpdateRecommenderRequest, UpdateRecommenderResponse } from "../models/models_0";
+import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
+export interface UpdateRecommenderCommandInput extends UpdateRecommenderRequest {
+}
+export interface UpdateRecommenderCommandOutput extends UpdateRecommenderResponse, __MetadataBearer {
+}
+/**
+ * <p>Updates the recommender to modify the recommender configuration.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PersonalizeClient, UpdateRecommenderCommand } from "@aws-sdk/client-personalize"; // ES Modules import
+ * // const { PersonalizeClient, UpdateRecommenderCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
+ * const client = new PersonalizeClient(config);
+ * const command = new UpdateRecommenderCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdateRecommenderCommandInput} for command's `input` shape.
+ * @see {@link UpdateRecommenderCommandOutput} for command's `response` shape.
+ * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
+ *
+ */
+export declare class UpdateRecommenderCommand extends $Command<UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput, PersonalizeClientResolvedConfig> {
+    readonly input: UpdateRecommenderCommandInput;
+    constructor(input: UpdateRecommenderCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -1,4 +1,5 @@
 export * from "./CreateBatchInferenceJobCommand";
+export * from "./CreateBatchSegmentJobCommand";
 export * from "./CreateCampaignCommand";
 export * from "./CreateDatasetCommand";
 export * from "./CreateDatasetExportJobCommand";
@@ -6,6 +7,7 @@ export * from "./CreateDatasetGroupCommand";
 export * from "./CreateDatasetImportJobCommand";
 export * from "./CreateEventTrackerCommand";
 export * from "./CreateFilterCommand";
+export * from "./CreateRecommenderCommand";
 export * from "./CreateSchemaCommand";
 export * from "./CreateSolutionCommand";
 export * from "./CreateSolutionVersionCommand";
@@ -14,10 +16,12 @@ export * from "./DeleteDatasetCommand";
 export * from "./DeleteDatasetGroupCommand";
 export * from "./DeleteEventTrackerCommand";
 export * from "./DeleteFilterCommand";
+export * from "./DeleteRecommenderCommand";
 export * from "./DeleteSchemaCommand";
 export * from "./DeleteSolutionCommand";
 export * from "./DescribeAlgorithmCommand";
 export * from "./DescribeBatchInferenceJobCommand";
+export * from "./DescribeBatchSegmentJobCommand";
 export * from "./DescribeCampaignCommand";
 export * from "./DescribeDatasetCommand";
 export * from "./DescribeDatasetExportJobCommand";
@@ -27,11 +31,13 @@ export * from "./DescribeEventTrackerCommand";
 export * from "./DescribeFeatureTransformationCommand";
 export * from "./DescribeFilterCommand";
 export * from "./DescribeRecipeCommand";
+export * from "./DescribeRecommenderCommand";
 export * from "./DescribeSchemaCommand";
 export * from "./DescribeSolutionCommand";
 export * from "./DescribeSolutionVersionCommand";
 export * from "./GetSolutionMetricsCommand";
 export * from "./ListBatchInferenceJobsCommand";
+export * from "./ListBatchSegmentJobsCommand";
 export * from "./ListCampaignsCommand";
 export * from "./ListDatasetExportJobsCommand";
 export * from "./ListDatasetGroupsCommand";
@@ -40,8 +46,10 @@ export * from "./ListDatasetsCommand";
 export * from "./ListEventTrackersCommand";
 export * from "./ListFiltersCommand";
 export * from "./ListRecipesCommand";
+export * from "./ListRecommendersCommand";
 export * from "./ListSchemasCommand";
 export * from "./ListSolutionVersionsCommand";
 export * from "./ListSolutionsCommand";
 export * from "./StopSolutionVersionCreationCommand";
 export * from "./UpdateCampaignCommand";
+export * from "./UpdateRecommenderCommand";