@aws-sdk/client-personalize 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/dist-types/Personalize.d.ts +67 -0
  2. package/dist-types/PersonalizeClient.d.ts +24 -4
  3. package/dist-types/commands/CreateBatchInferenceJobCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateBatchSegmentJobCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateCampaignCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateEventTrackerCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateFilterCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateMetricAttributionCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateRecommenderCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateSchemaCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateSolutionCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateSolutionVersionCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteCampaignCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteEventTrackerCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteFilterCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteMetricAttributionCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteRecommenderCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteSchemaCommand.d.ts +16 -0
  25. package/dist-types/commands/DeleteSolutionCommand.d.ts +16 -0
  26. package/dist-types/commands/DescribeAlgorithmCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribeBatchInferenceJobCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeBatchSegmentJobCommand.d.ts +16 -0
  29. package/dist-types/commands/DescribeCampaignCommand.d.ts +16 -0
  30. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeEventTrackerCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeFeatureTransformationCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeFilterCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribeMetricAttributionCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeRecipeCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeRecommenderCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribeSchemaCommand.d.ts +16 -0
  41. package/dist-types/commands/DescribeSolutionCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeSolutionVersionCommand.d.ts +16 -0
  43. package/dist-types/commands/GetSolutionMetricsCommand.d.ts +16 -0
  44. package/dist-types/commands/ListBatchInferenceJobsCommand.d.ts +16 -0
  45. package/dist-types/commands/ListBatchSegmentJobsCommand.d.ts +16 -0
  46. package/dist-types/commands/ListCampaignsCommand.d.ts +16 -0
  47. package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +16 -0
  48. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +16 -0
  49. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +16 -0
  50. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  51. package/dist-types/commands/ListEventTrackersCommand.d.ts +16 -0
  52. package/dist-types/commands/ListFiltersCommand.d.ts +16 -0
  53. package/dist-types/commands/ListMetricAttributionMetricsCommand.d.ts +16 -0
  54. package/dist-types/commands/ListMetricAttributionsCommand.d.ts +16 -0
  55. package/dist-types/commands/ListRecipesCommand.d.ts +16 -0
  56. package/dist-types/commands/ListRecommendersCommand.d.ts +16 -0
  57. package/dist-types/commands/ListSchemasCommand.d.ts +16 -0
  58. package/dist-types/commands/ListSolutionVersionsCommand.d.ts +16 -0
  59. package/dist-types/commands/ListSolutionsCommand.d.ts +16 -0
  60. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  61. package/dist-types/commands/StartRecommenderCommand.d.ts +16 -0
  62. package/dist-types/commands/StopRecommenderCommand.d.ts +16 -0
  63. package/dist-types/commands/StopSolutionVersionCreationCommand.d.ts +16 -0
  64. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  65. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  66. package/dist-types/commands/UpdateCampaignCommand.d.ts +16 -0
  67. package/dist-types/commands/UpdateMetricAttributionCommand.d.ts +16 -0
  68. package/dist-types/commands/UpdateRecommenderCommand.d.ts +16 -0
  69. package/dist-types/models/PersonalizeServiceException.d.ts +2 -0
  70. package/dist-types/models/models_0.d.ts +456 -0
  71. package/dist-types/pagination/Interfaces.d.ts +3 -0
  72. package/dist-types/pagination/ListBatchInferenceJobsPaginator.d.ts +3 -0
  73. package/dist-types/pagination/ListBatchSegmentJobsPaginator.d.ts +3 -0
  74. package/dist-types/pagination/ListCampaignsPaginator.d.ts +3 -0
  75. package/dist-types/pagination/ListDatasetExportJobsPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListDatasetGroupsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListDatasetImportJobsPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  79. package/dist-types/pagination/ListEventTrackersPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListFiltersPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListMetricAttributionMetricsPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListMetricAttributionsPaginator.d.ts +3 -0
  83. package/dist-types/pagination/ListRecipesPaginator.d.ts +3 -0
  84. package/dist-types/pagination/ListRecommendersPaginator.d.ts +3 -0
  85. package/dist-types/pagination/ListSchemasPaginator.d.ts +3 -0
  86. package/dist-types/pagination/ListSolutionVersionsPaginator.d.ts +3 -0
  87. package/dist-types/pagination/ListSolutionsPaginator.d.ts +3 -0
  88. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateSolutionVersionRequest, CreateSolutionVersionResponse } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateSolutionVersionCommand}.
8
10
  */
9
11
  export interface CreateSolutionVersionCommandInput extends CreateSolutionVersionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateSolutionVersionCommand}.
13
17
  */
14
18
  export interface CreateSolutionVersionCommandOutput extends CreateSolutionVersionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Trains or retrains an active solution in a Custom dataset group. A solution is created using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
18
23
  * operation and must be in the ACTIVE state before calling
19
24
  * <code>CreateSolutionVersion</code>. A new version of the solution is created every time you
@@ -91,6 +96,8 @@ export interface CreateSolutionVersionCommandOutput extends CreateSolutionVersio
91
96
  * const response = await client.send(command);
92
97
  * ```
93
98
  *
99
+ * @param CreateSolutionVersionCommandInput - {@link CreateSolutionVersionCommandInput}
100
+ * @returns {@link CreateSolutionVersionCommandOutput}
94
101
  * @see {@link CreateSolutionVersionCommandInput} for command's `input` shape.
95
102
  * @see {@link CreateSolutionVersionCommandOutput} for command's `response` shape.
96
103
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -118,11 +125,20 @@ export interface CreateSolutionVersionCommandOutput extends CreateSolutionVersio
118
125
  export declare class CreateSolutionVersionCommand extends $Command<CreateSolutionVersionCommandInput, CreateSolutionVersionCommandOutput, PersonalizeClientResolvedConfig> {
119
126
  readonly input: CreateSolutionVersionCommandInput;
120
127
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
128
+ /**
129
+ * @public
130
+ */
121
131
  constructor(input: CreateSolutionVersionCommandInput);
122
132
  /**
123
133
  * @internal
124
134
  */
125
135
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSolutionVersionCommandInput, CreateSolutionVersionCommandOutput>;
136
+ /**
137
+ * @internal
138
+ */
126
139
  private serialize;
140
+ /**
141
+ * @internal
142
+ */
127
143
  private deserialize;
128
144
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteCampaignRequest } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteCampaignCommand}.
8
10
  */
9
11
  export interface DeleteCampaignCommandInput extends DeleteCampaignRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteCampaignCommand}.
13
17
  */
14
18
  export interface DeleteCampaignCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a campaign by deleting the solution deployment. The solution that
18
23
  * the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no
19
24
  * longer be specified in a
@@ -30,6 +35,8 @@ export interface DeleteCampaignCommandOutput extends __MetadataBearer {
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DeleteCampaignCommandInput - {@link DeleteCampaignCommandInput}
39
+ * @returns {@link DeleteCampaignCommandOutput}
33
40
  * @see {@link DeleteCampaignCommandInput} for command's `input` shape.
34
41
  * @see {@link DeleteCampaignCommandOutput} for command's `response` shape.
35
42
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DeleteCampaignCommandOutput extends __MetadataBearer {
48
55
  export declare class DeleteCampaignCommand extends $Command<DeleteCampaignCommandInput, DeleteCampaignCommandOutput, PersonalizeClientResolvedConfig> {
49
56
  readonly input: DeleteCampaignCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DeleteCampaignCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCampaignCommandInput, DeleteCampaignCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteDatasetRequest } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDatasetCommand}.
8
10
  */
9
11
  export interface DeleteDatasetCommandInput extends DeleteDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDatasetCommand}.
13
17
  */
14
18
  export interface DeleteDatasetCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a dataset. You can't delete a dataset if an associated
18
23
  * <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the
19
24
  * CREATE PENDING or IN PROGRESS state. For more information on datasets, see
@@ -28,6 +33,8 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteDatasetCommandInput - {@link DeleteDatasetCommandInput}
37
+ * @returns {@link DeleteDatasetCommandOutput}
31
38
  * @see {@link DeleteDatasetCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteDatasetCommandOutput} for command's `response` shape.
33
40
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {
46
53
  export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, PersonalizeClientResolvedConfig> {
47
54
  readonly input: DeleteDatasetCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteDatasetCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDatasetCommandInput, DeleteDatasetCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteDatasetGroupRequest } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDatasetGroupCommand}.
8
10
  */
9
11
  export interface DeleteDatasetGroupCommandInput extends DeleteDatasetGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDatasetGroupCommand}.
13
17
  */
14
18
  export interface DeleteDatasetGroupCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a dataset group. Before you delete a dataset group, you must
18
23
  * delete the following:</p>
19
24
  * <ul>
@@ -37,6 +42,8 @@ export interface DeleteDatasetGroupCommandOutput extends __MetadataBearer {
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param DeleteDatasetGroupCommandInput - {@link DeleteDatasetGroupCommandInput}
46
+ * @returns {@link DeleteDatasetGroupCommandOutput}
40
47
  * @see {@link DeleteDatasetGroupCommandInput} for command's `input` shape.
41
48
  * @see {@link DeleteDatasetGroupCommandOutput} for command's `response` shape.
42
49
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -55,11 +62,20 @@ export interface DeleteDatasetGroupCommandOutput extends __MetadataBearer {
55
62
  export declare class DeleteDatasetGroupCommand extends $Command<DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput, PersonalizeClientResolvedConfig> {
56
63
  readonly input: DeleteDatasetGroupCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: DeleteDatasetGroupCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteEventTrackerRequest } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteEventTrackerCommand}.
8
10
  */
9
11
  export interface DeleteEventTrackerCommandInput extends DeleteEventTrackerRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteEventTrackerCommand}.
13
17
  */
14
18
  export interface DeleteEventTrackerCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the event tracker. Does not delete the event-interactions dataset from
18
23
  * the associated dataset group. For more
19
24
  * information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
@@ -27,6 +32,8 @@ export interface DeleteEventTrackerCommandOutput extends __MetadataBearer {
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteEventTrackerCommandInput - {@link DeleteEventTrackerCommandInput}
36
+ * @returns {@link DeleteEventTrackerCommandOutput}
30
37
  * @see {@link DeleteEventTrackerCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteEventTrackerCommandOutput} for command's `response` shape.
32
39
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -45,11 +52,20 @@ export interface DeleteEventTrackerCommandOutput extends __MetadataBearer {
45
52
  export declare class DeleteEventTrackerCommand extends $Command<DeleteEventTrackerCommandInput, DeleteEventTrackerCommandOutput, PersonalizeClientResolvedConfig> {
46
53
  readonly input: DeleteEventTrackerCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: DeleteEventTrackerCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteEventTrackerCommandInput, DeleteEventTrackerCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteFilterRequest } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteFilterCommand}.
8
10
  */
9
11
  export interface DeleteFilterCommandInput extends DeleteFilterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteFilterCommand}.
13
17
  */
14
18
  export interface DeleteFilterCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a filter.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteFilterCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteFilterCommandInput - {@link DeleteFilterCommandInput}
34
+ * @returns {@link DeleteFilterCommandOutput}
28
35
  * @see {@link DeleteFilterCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteFilterCommandOutput} for command's `response` shape.
30
37
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DeleteFilterCommandOutput extends __MetadataBearer {
43
50
  export declare class DeleteFilterCommand extends $Command<DeleteFilterCommandInput, DeleteFilterCommandOutput, PersonalizeClientResolvedConfig> {
44
51
  readonly input: DeleteFilterCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DeleteFilterCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteFilterCommandInput, DeleteFilterCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteMetricAttributionRequest } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteMetricAttributionCommand}.
8
10
  */
9
11
  export interface DeleteMetricAttributionCommandInput extends DeleteMetricAttributionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteMetricAttributionCommand}.
13
17
  */
14
18
  export interface DeleteMetricAttributionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a metric attribution.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteMetricAttributionCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteMetricAttributionCommandInput - {@link DeleteMetricAttributionCommandInput}
34
+ * @returns {@link DeleteMetricAttributionCommandOutput}
28
35
  * @see {@link DeleteMetricAttributionCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteMetricAttributionCommandOutput} for command's `response` shape.
30
37
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DeleteMetricAttributionCommandOutput extends __MetadataBearer {
43
50
  export declare class DeleteMetricAttributionCommand extends $Command<DeleteMetricAttributionCommandInput, DeleteMetricAttributionCommandOutput, PersonalizeClientResolvedConfig> {
44
51
  readonly input: DeleteMetricAttributionCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DeleteMetricAttributionCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteMetricAttributionCommandInput, DeleteMetricAttributionCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteRecommenderRequest } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteRecommenderCommand}.
8
10
  */
9
11
  export interface DeleteRecommenderCommandInput extends DeleteRecommenderRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteRecommenderCommand}.
13
17
  */
14
18
  export interface DeleteRecommenderCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * request.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteRecommenderCommandOutput extends __MetadataBearer {
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteRecommenderCommandInput - {@link DeleteRecommenderCommandInput}
35
+ * @returns {@link DeleteRecommenderCommandOutput}
29
36
  * @see {@link DeleteRecommenderCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteRecommenderCommandOutput} for command's `response` shape.
31
38
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DeleteRecommenderCommandOutput extends __MetadataBearer {
44
51
  export declare class DeleteRecommenderCommand extends $Command<DeleteRecommenderCommandInput, DeleteRecommenderCommandOutput, PersonalizeClientResolvedConfig> {
45
52
  readonly input: DeleteRecommenderCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DeleteRecommenderCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRecommenderCommandInput, DeleteRecommenderCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteSchemaRequest } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSchemaCommand}.
8
10
  */
9
11
  export interface DeleteSchemaCommandInput extends DeleteSchemaRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSchemaCommand}.
13
17
  */
14
18
  export interface DeleteSchemaCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a schema. Before deleting a schema, you must delete all
18
23
  * datasets referencing the schema. For more information on schemas, see
19
24
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
@@ -27,6 +32,8 @@ export interface DeleteSchemaCommandOutput extends __MetadataBearer {
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteSchemaCommandInput - {@link DeleteSchemaCommandInput}
36
+ * @returns {@link DeleteSchemaCommandOutput}
30
37
  * @see {@link DeleteSchemaCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteSchemaCommandOutput} for command's `response` shape.
32
39
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -45,11 +52,20 @@ export interface DeleteSchemaCommandOutput extends __MetadataBearer {
45
52
  export declare class DeleteSchemaCommand extends $Command<DeleteSchemaCommandInput, DeleteSchemaCommandOutput, PersonalizeClientResolvedConfig> {
46
53
  readonly input: DeleteSchemaCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: DeleteSchemaCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSchemaCommandInput, DeleteSchemaCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteSolutionRequest } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSolutionCommand}.
8
10
  */
9
11
  export interface DeleteSolutionCommandInput extends DeleteSolutionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSolutionCommand}.
13
17
  */
14
18
  export interface DeleteSolutionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes all versions of a solution and the <code>Solution</code> object itself.
18
23
  * Before deleting a solution, you must delete all campaigns based on
19
24
  * the solution. To determine what campaigns are using the solution, call
@@ -31,6 +36,8 @@ export interface DeleteSolutionCommandOutput extends __MetadataBearer {
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param DeleteSolutionCommandInput - {@link DeleteSolutionCommandInput}
40
+ * @returns {@link DeleteSolutionCommandOutput}
34
41
  * @see {@link DeleteSolutionCommandInput} for command's `input` shape.
35
42
  * @see {@link DeleteSolutionCommandOutput} for command's `response` shape.
36
43
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteSolutionCommandOutput extends __MetadataBearer {
49
56
  export declare class DeleteSolutionCommand extends $Command<DeleteSolutionCommandInput, DeleteSolutionCommandOutput, PersonalizeClientResolvedConfig> {
50
57
  readonly input: DeleteSolutionCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteSolutionCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSolutionCommandInput, DeleteSolutionCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAlgorithmRequest, DescribeAlgorithmResponse } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAlgorithmCommand}.
8
10
  */
9
11
  export interface DescribeAlgorithmCommandInput extends DescribeAlgorithmRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAlgorithmCommand}.
13
17
  */
14
18
  export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the given algorithm.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAlgorithmCommandInput - {@link DescribeAlgorithmCommandInput}
34
+ * @returns {@link DescribeAlgorithmCommandOutput}
28
35
  * @see {@link DescribeAlgorithmCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAlgorithmCommandOutput} for command's `response` shape.
30
37
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -40,11 +47,20 @@ export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmRespons
40
47
  export declare class DescribeAlgorithmCommand extends $Command<DescribeAlgorithmCommandInput, DescribeAlgorithmCommandOutput, PersonalizeClientResolvedConfig> {
41
48
  readonly input: DescribeAlgorithmCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: DescribeAlgorithmCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAlgorithmCommandInput, DescribeAlgorithmCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeBatchInferenceJobRequest, DescribeBatchInferenceJobResponse } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeBatchInferenceJobCommand}.
8
10
  */
9
11
  export interface DescribeBatchInferenceJobCommandInput extends DescribeBatchInferenceJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeBatchInferenceJobCommand}.
13
17
  */
14
18
  export interface DescribeBatchInferenceJobCommandOutput extends DescribeBatchInferenceJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the properties of a batch inference job including name, Amazon Resource Name (ARN),
18
23
  * status, input and output configurations, and the ARN of the solution version used to generate
19
24
  * the recommendations.</p>
@@ -27,6 +32,8 @@ export interface DescribeBatchInferenceJobCommandOutput extends DescribeBatchInf
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeBatchInferenceJobCommandInput - {@link DescribeBatchInferenceJobCommandInput}
36
+ * @returns {@link DescribeBatchInferenceJobCommandOutput}
30
37
  * @see {@link DescribeBatchInferenceJobCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeBatchInferenceJobCommandOutput} for command's `response` shape.
32
39
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DescribeBatchInferenceJobCommandOutput extends DescribeBatchInf
42
49
  export declare class DescribeBatchInferenceJobCommand extends $Command<DescribeBatchInferenceJobCommandInput, DescribeBatchInferenceJobCommandOutput, PersonalizeClientResolvedConfig> {
43
50
  readonly input: DescribeBatchInferenceJobCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DescribeBatchInferenceJobCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeBatchInferenceJobCommandInput, DescribeBatchInferenceJobCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeBatchSegmentJobRequest, DescribeBatchSegmentJobResponse } from "../models/models_0";
5
5
  import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeBatchSegmentJobCommand}.
8
10
  */
9
11
  export interface DescribeBatchSegmentJobCommandInput extends DescribeBatchSegmentJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeBatchSegmentJobCommand}.
13
17
  */
14
18
  export interface DescribeBatchSegmentJobCommandOutput extends DescribeBatchSegmentJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the properties of a batch segment job including name, Amazon Resource Name (ARN),
18
23
  * status, input and output configurations, and the ARN of the solution version used to generate
19
24
  * segments.</p>
@@ -27,6 +32,8 @@ export interface DescribeBatchSegmentJobCommandOutput extends DescribeBatchSegme
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeBatchSegmentJobCommandInput - {@link DescribeBatchSegmentJobCommandInput}
36
+ * @returns {@link DescribeBatchSegmentJobCommandOutput}
30
37
  * @see {@link DescribeBatchSegmentJobCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeBatchSegmentJobCommandOutput} for command's `response` shape.
32
39
  * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DescribeBatchSegmentJobCommandOutput extends DescribeBatchSegme
42
49
  export declare class DescribeBatchSegmentJobCommand extends $Command<DescribeBatchSegmentJobCommandInput, DescribeBatchSegmentJobCommandOutput, PersonalizeClientResolvedConfig> {
43
50
  readonly input: DescribeBatchSegmentJobCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DescribeBatchSegmentJobCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeBatchSegmentJobCommandInput, DescribeBatchSegmentJobCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }