@aws-sdk/client-lookoutequipment 3.409.0 → 3.413.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 (113) hide show
  1. package/README.md +64 -0
  2. package/dist-cjs/LookoutEquipment.js +16 -0
  3. package/dist-cjs/commands/CreateRetrainingSchedulerCommand.js +46 -0
  4. package/dist-cjs/commands/DeleteRetrainingSchedulerCommand.js +46 -0
  5. package/dist-cjs/commands/DescribeRetrainingSchedulerCommand.js +46 -0
  6. package/dist-cjs/commands/ListRetrainingSchedulersCommand.js +46 -0
  7. package/dist-cjs/commands/StartRetrainingSchedulerCommand.js +46 -0
  8. package/dist-cjs/commands/StopRetrainingSchedulerCommand.js +46 -0
  9. package/dist-cjs/commands/UpdateModelCommand.js +46 -0
  10. package/dist-cjs/commands/UpdateRetrainingSchedulerCommand.js +46 -0
  11. package/dist-cjs/commands/index.js +8 -0
  12. package/dist-cjs/models/models_0.js +28 -6
  13. package/dist-cjs/pagination/ListRetrainingSchedulersPaginator.js +29 -0
  14. package/dist-cjs/pagination/index.js +1 -0
  15. package/dist-cjs/protocols/Aws_json1_0.js +502 -2
  16. package/dist-cjs/runtimeExtensions.js +3 -0
  17. package/dist-es/LookoutEquipment.js +16 -0
  18. package/dist-es/commands/CreateRetrainingSchedulerCommand.js +42 -0
  19. package/dist-es/commands/DeleteRetrainingSchedulerCommand.js +42 -0
  20. package/dist-es/commands/DescribeRetrainingSchedulerCommand.js +42 -0
  21. package/dist-es/commands/ListRetrainingSchedulersCommand.js +42 -0
  22. package/dist-es/commands/StartRetrainingSchedulerCommand.js +42 -0
  23. package/dist-es/commands/StopRetrainingSchedulerCommand.js +42 -0
  24. package/dist-es/commands/UpdateModelCommand.js +42 -0
  25. package/dist-es/commands/UpdateRetrainingSchedulerCommand.js +42 -0
  26. package/dist-es/commands/index.js +8 -0
  27. package/dist-es/models/models_0.js +27 -5
  28. package/dist-es/pagination/ListRetrainingSchedulersPaginator.js +25 -0
  29. package/dist-es/pagination/index.js +1 -0
  30. package/dist-es/protocols/Aws_json1_0.js +484 -0
  31. package/dist-es/runtimeExtensions.js +3 -0
  32. package/dist-types/LookoutEquipment.d.ts +56 -0
  33. package/dist-types/LookoutEquipmentClient.d.ts +10 -2
  34. package/dist-types/commands/CreateDatasetCommand.d.ts +2 -2
  35. package/dist-types/commands/CreateInferenceSchedulerCommand.d.ts +2 -2
  36. package/dist-types/commands/CreateLabelCommand.d.ts +3 -5
  37. package/dist-types/commands/CreateLabelGroupCommand.d.ts +3 -5
  38. package/dist-types/commands/CreateModelCommand.d.ts +7 -7
  39. package/dist-types/commands/CreateRetrainingSchedulerCommand.d.ts +147 -0
  40. package/dist-types/commands/DeleteDatasetCommand.d.ts +2 -2
  41. package/dist-types/commands/DeleteInferenceSchedulerCommand.d.ts +4 -4
  42. package/dist-types/commands/DeleteLabelCommand.d.ts +3 -5
  43. package/dist-types/commands/DeleteLabelGroupCommand.d.ts +3 -5
  44. package/dist-types/commands/DeleteModelCommand.d.ts +4 -5
  45. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -2
  46. package/dist-types/commands/DeleteRetrainingSchedulerCommand.d.ts +106 -0
  47. package/dist-types/commands/DescribeDataIngestionJobCommand.d.ts +2 -2
  48. package/dist-types/commands/DescribeDatasetCommand.d.ts +2 -2
  49. package/dist-types/commands/DescribeInferenceSchedulerCommand.d.ts +2 -2
  50. package/dist-types/commands/DescribeLabelCommand.d.ts +3 -5
  51. package/dist-types/commands/DescribeLabelGroupCommand.d.ts +3 -5
  52. package/dist-types/commands/DescribeModelCommand.d.ts +15 -5
  53. package/dist-types/commands/DescribeModelVersionCommand.d.ts +6 -2
  54. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +2 -2
  55. package/dist-types/commands/DescribeRetrainingSchedulerCommand.d.ts +125 -0
  56. package/dist-types/commands/ImportDatasetCommand.d.ts +2 -2
  57. package/dist-types/commands/ImportModelVersionCommand.d.ts +3 -2
  58. package/dist-types/commands/ListDataIngestionJobsCommand.d.ts +2 -2
  59. package/dist-types/commands/ListDatasetsCommand.d.ts +2 -2
  60. package/dist-types/commands/ListInferenceEventsCommand.d.ts +2 -2
  61. package/dist-types/commands/ListInferenceExecutionsCommand.d.ts +4 -2
  62. package/dist-types/commands/ListInferenceSchedulersCommand.d.ts +2 -2
  63. package/dist-types/commands/ListLabelGroupsCommand.d.ts +3 -5
  64. package/dist-types/commands/ListLabelsCommand.d.ts +3 -5
  65. package/dist-types/commands/ListModelVersionsCommand.d.ts +5 -5
  66. package/dist-types/commands/ListModelsCommand.d.ts +7 -2
  67. package/dist-types/commands/ListRetrainingSchedulersCommand.d.ts +143 -0
  68. package/dist-types/commands/ListSensorStatisticsCommand.d.ts +2 -2
  69. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
  70. package/dist-types/commands/PutResourcePolicyCommand.d.ts +2 -2
  71. package/dist-types/commands/StartDataIngestionJobCommand.d.ts +3 -4
  72. package/dist-types/commands/StartInferenceSchedulerCommand.d.ts +2 -2
  73. package/dist-types/commands/StartRetrainingSchedulerCommand.d.ts +116 -0
  74. package/dist-types/commands/StopInferenceSchedulerCommand.d.ts +2 -2
  75. package/dist-types/commands/StopRetrainingSchedulerCommand.d.ts +116 -0
  76. package/dist-types/commands/TagResourceCommand.d.ts +6 -6
  77. package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
  78. package/dist-types/commands/UpdateActiveModelVersionCommand.d.ts +2 -2
  79. package/dist-types/commands/UpdateInferenceSchedulerCommand.d.ts +2 -2
  80. package/dist-types/commands/UpdateLabelGroupCommand.d.ts +3 -5
  81. package/dist-types/commands/UpdateModelCommand.d.ts +116 -0
  82. package/dist-types/commands/UpdateRetrainingSchedulerCommand.d.ts +111 -0
  83. package/dist-types/commands/index.d.ts +8 -0
  84. package/dist-types/extensionConfiguration.d.ts +2 -1
  85. package/dist-types/models/models_0.d.ts +895 -433
  86. package/dist-types/pagination/ListRetrainingSchedulersPaginator.d.ts +7 -0
  87. package/dist-types/pagination/index.d.ts +1 -0
  88. package/dist-types/protocols/Aws_json1_0.d.ts +72 -0
  89. package/dist-types/runtimeConfig.browser.d.ts +4 -1
  90. package/dist-types/runtimeConfig.d.ts +4 -1
  91. package/dist-types/runtimeConfig.native.d.ts +4 -1
  92. package/dist-types/runtimeExtensions.d.ts +1 -1
  93. package/dist-types/ts3.4/LookoutEquipment.d.ts +136 -0
  94. package/dist-types/ts3.4/LookoutEquipmentClient.d.ts +50 -2
  95. package/dist-types/ts3.4/commands/CreateRetrainingSchedulerCommand.d.ts +42 -0
  96. package/dist-types/ts3.4/commands/DeleteRetrainingSchedulerCommand.d.ts +38 -0
  97. package/dist-types/ts3.4/commands/DescribeRetrainingSchedulerCommand.d.ts +42 -0
  98. package/dist-types/ts3.4/commands/ListRetrainingSchedulersCommand.d.ts +42 -0
  99. package/dist-types/ts3.4/commands/StartRetrainingSchedulerCommand.d.ts +42 -0
  100. package/dist-types/ts3.4/commands/StopRetrainingSchedulerCommand.d.ts +42 -0
  101. package/dist-types/ts3.4/commands/UpdateModelCommand.d.ts +33 -0
  102. package/dist-types/ts3.4/commands/UpdateRetrainingSchedulerCommand.d.ts +38 -0
  103. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  104. package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
  105. package/dist-types/ts3.4/models/models_0.d.ts +137 -9
  106. package/dist-types/ts3.4/pagination/ListRetrainingSchedulersPaginator.d.ts +11 -0
  107. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  108. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +96 -0
  109. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +8 -1
  110. package/dist-types/ts3.4/runtimeConfig.d.ts +8 -1
  111. package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -1
  112. package/dist-types/ts3.4/runtimeExtensions.d.ts +3 -1
  113. package/package.json +28 -28
@@ -0,0 +1,106 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient";
5
+ import { DeleteRetrainingSchedulerRequest } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteRetrainingSchedulerCommand}.
14
+ */
15
+ export interface DeleteRetrainingSchedulerCommandInput extends DeleteRetrainingSchedulerRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteRetrainingSchedulerCommand}.
21
+ */
22
+ export interface DeleteRetrainingSchedulerCommandOutput extends __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Deletes a retraining scheduler from a model. The retraining scheduler must be in the
27
+ * <code>STOPPED</code> status. </p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { LookoutEquipmentClient, DeleteRetrainingSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
32
+ * // const { LookoutEquipmentClient, DeleteRetrainingSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
33
+ * const client = new LookoutEquipmentClient(config);
34
+ * const input = { // DeleteRetrainingSchedulerRequest
35
+ * ModelName: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new DeleteRetrainingSchedulerCommand(input);
38
+ * const response = await client.send(command);
39
+ * // {};
40
+ *
41
+ * ```
42
+ *
43
+ * @param DeleteRetrainingSchedulerCommandInput - {@link DeleteRetrainingSchedulerCommandInput}
44
+ * @returns {@link DeleteRetrainingSchedulerCommandOutput}
45
+ * @see {@link DeleteRetrainingSchedulerCommandInput} for command's `input` shape.
46
+ * @see {@link DeleteRetrainingSchedulerCommandOutput} for command's `response` shape.
47
+ * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape.
48
+ *
49
+ * @throws {@link AccessDeniedException} (client fault)
50
+ * <p>The request could not be completed because you do not have access to the resource.
51
+ * </p>
52
+ *
53
+ * @throws {@link ConflictException} (client fault)
54
+ * <p> The request could not be completed due to a conflict with the current state of the
55
+ * target resource. </p>
56
+ *
57
+ * @throws {@link InternalServerException} (server fault)
58
+ * <p> Processing of the request has failed because of an unknown error, exception or failure.
59
+ * </p>
60
+ *
61
+ * @throws {@link ResourceNotFoundException} (client fault)
62
+ * <p> The resource requested could not be found. Verify the resource ID and retry your
63
+ * request. </p>
64
+ *
65
+ * @throws {@link ThrottlingException} (client fault)
66
+ * <p>The request was denied due to request throttling.</p>
67
+ *
68
+ * @throws {@link ValidationException} (client fault)
69
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
70
+ * service that's being utilized. </p>
71
+ *
72
+ * @throws {@link LookoutEquipmentServiceException}
73
+ * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
74
+ *
75
+ * @example Deletes a retraining scheduler
76
+ * ```javascript
77
+ * //
78
+ * const input = {
79
+ * "ModelName": "sample-model"
80
+ * };
81
+ * const command = new DeleteRetrainingSchedulerCommand(input);
82
+ * await client.send(command);
83
+ * // example id: deletes-a-retraining-scheduler-1694019240097
84
+ * ```
85
+ *
86
+ */
87
+ export declare class DeleteRetrainingSchedulerCommand extends $Command<DeleteRetrainingSchedulerCommandInput, DeleteRetrainingSchedulerCommandOutput, LookoutEquipmentClientResolvedConfig> {
88
+ readonly input: DeleteRetrainingSchedulerCommandInput;
89
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
90
+ /**
91
+ * @public
92
+ */
93
+ constructor(input: DeleteRetrainingSchedulerCommandInput);
94
+ /**
95
+ * @internal
96
+ */
97
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LookoutEquipmentClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRetrainingSchedulerCommandInput, DeleteRetrainingSchedulerCommandOutput>;
98
+ /**
99
+ * @internal
100
+ */
101
+ private serialize;
102
+ /**
103
+ * @internal
104
+ */
105
+ private deserialize;
106
+ }
@@ -115,8 +115,8 @@ export interface DescribeDataIngestionJobCommandOutput extends DescribeDataInges
115
115
  * <p>The request was denied due to request throttling.</p>
116
116
  *
117
117
  * @throws {@link ValidationException} (client fault)
118
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
119
- * related Amazon Web Services service that's being utilized. </p>
118
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
119
+ * service that's being utilized. </p>
120
120
  *
121
121
  * @throws {@link LookoutEquipmentServiceException}
122
122
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -115,8 +115,8 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
115
115
  * <p>The request was denied due to request throttling.</p>
116
116
  *
117
117
  * @throws {@link ValidationException} (client fault)
118
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
119
- * related Amazon Web Services service that's being utilized. </p>
118
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
119
+ * service that's being utilized. </p>
120
120
  *
121
121
  * @throws {@link LookoutEquipmentServiceException}
122
122
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -93,8 +93,8 @@ export interface DescribeInferenceSchedulerCommandOutput extends DescribeInferen
93
93
  * <p>The request was denied due to request throttling.</p>
94
94
  *
95
95
  * @throws {@link ValidationException} (client fault)
96
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
97
- * related Amazon Web Services service that's being utilized. </p>
96
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
97
+ * service that's being utilized. </p>
98
98
  *
99
99
  * @throws {@link LookoutEquipmentServiceException}
100
100
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -23,9 +23,7 @@ export interface DescribeLabelCommandOutput extends DescribeLabelResponse, __Met
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Returns the name of the label.
28
- * </p>
26
+ * <p> Returns the name of the label. </p>
29
27
  * @example
30
28
  * Use a bare-bones client and the command you need to make an API call.
31
29
  * ```javascript
@@ -75,8 +73,8 @@ export interface DescribeLabelCommandOutput extends DescribeLabelResponse, __Met
75
73
  * <p>The request was denied due to request throttling.</p>
76
74
  *
77
75
  * @throws {@link ValidationException} (client fault)
78
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
79
- * related Amazon Web Services service that's being utilized. </p>
76
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
77
+ * service that's being utilized. </p>
80
78
  *
81
79
  * @throws {@link LookoutEquipmentServiceException}
82
80
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -23,9 +23,7 @@ export interface DescribeLabelGroupCommandOutput extends DescribeLabelGroupRespo
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Returns information about the label group.
28
- * </p>
26
+ * <p> Returns information about the label group. </p>
29
27
  * @example
30
28
  * Use a bare-bones client and the command you need to make an API call.
31
29
  * ```javascript
@@ -71,8 +69,8 @@ export interface DescribeLabelGroupCommandOutput extends DescribeLabelGroupRespo
71
69
  * <p>The request was denied due to request throttling.</p>
72
70
  *
73
71
  * @throws {@link ValidationException} (client fault)
74
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
75
- * related Amazon Web Services service that's being utilized. </p>
72
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
73
+ * service that's being utilized. </p>
76
74
  *
77
75
  * @throws {@link LookoutEquipmentServiceException}
78
76
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -23,9 +23,9 @@ export interface DescribeModelCommandOutput extends DescribeModelResponse, __Met
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Provides a JSON containing the overall information about a specific ML model, including
27
- * model name and ARN, dataset, training and evaluation information, status, and so on.
28
- * </p>
26
+ * <p>Provides a JSON containing the overall information about a specific machine learning
27
+ * model, including model name and ARN, dataset, training and evaluation information, status,
28
+ * and so on. </p>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
31
31
  * ```javascript
@@ -76,6 +76,16 @@ export interface DescribeModelCommandOutput extends DescribeModelResponse, __Met
76
76
  * // PreviousActiveModelVersion: Number("long"),
77
77
  * // PreviousActiveModelVersionArn: "STRING_VALUE",
78
78
  * // PreviousModelVersionActivatedAt: new Date("TIMESTAMP"),
79
+ * // PriorModelMetrics: "STRING_VALUE",
80
+ * // LatestScheduledRetrainingFailedReason: "STRING_VALUE",
81
+ * // LatestScheduledRetrainingStatus: "IN_PROGRESS" || "SUCCESS" || "FAILED" || "IMPORT_IN_PROGRESS" || "CANCELED",
82
+ * // LatestScheduledRetrainingModelVersion: Number("long"),
83
+ * // LatestScheduledRetrainingStartTime: new Date("TIMESTAMP"),
84
+ * // LatestScheduledRetrainingAvailableDataInDays: Number("int"),
85
+ * // NextScheduledRetrainingStartDate: new Date("TIMESTAMP"),
86
+ * // AccumulatedInferenceDataStartTime: new Date("TIMESTAMP"),
87
+ * // AccumulatedInferenceDataEndTime: new Date("TIMESTAMP"),
88
+ * // RetrainingSchedulerStatus: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED",
79
89
  * // };
80
90
  *
81
91
  * ```
@@ -102,8 +112,8 @@ export interface DescribeModelCommandOutput extends DescribeModelResponse, __Met
102
112
  * <p>The request was denied due to request throttling.</p>
103
113
  *
104
114
  * @throws {@link ValidationException} (client fault)
105
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
106
- * related Amazon Web Services service that's being utilized. </p>
115
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
116
+ * service that's being utilized. </p>
107
117
  *
108
118
  * @throws {@link LookoutEquipmentServiceException}
109
119
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -73,6 +73,10 @@ export interface DescribeModelVersionCommandOutput extends DescribeModelVersionR
73
73
  * // ImportJobStartTime: new Date("TIMESTAMP"),
74
74
  * // ImportJobEndTime: new Date("TIMESTAMP"),
75
75
  * // ImportedDataSizeInBytes: Number("long"),
76
+ * // PriorModelMetrics: "STRING_VALUE",
77
+ * // RetrainingAvailableDataInDays: Number("int"),
78
+ * // AutoPromotionResult: "MODEL_PROMOTED" || "MODEL_NOT_PROMOTED" || "RETRAINING_INTERNAL_ERROR" || "RETRAINING_CUSTOMER_ERROR" || "RETRAINING_CANCELLED",
79
+ * // AutoPromotionResultReason: "STRING_VALUE",
76
80
  * // };
77
81
  *
78
82
  * ```
@@ -99,8 +103,8 @@ export interface DescribeModelVersionCommandOutput extends DescribeModelVersionR
99
103
  * <p>The request was denied due to request throttling.</p>
100
104
  *
101
105
  * @throws {@link ValidationException} (client fault)
102
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
103
- * related Amazon Web Services service that's being utilized. </p>
106
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
107
+ * service that's being utilized. </p>
104
108
  *
105
109
  * @throws {@link LookoutEquipmentServiceException}
106
110
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -66,8 +66,8 @@ export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePol
66
66
  * <p>The request was denied due to request throttling.</p>
67
67
  *
68
68
  * @throws {@link ValidationException} (client fault)
69
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
70
- * related Amazon Web Services service that's being utilized. </p>
69
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
70
+ * service that's being utilized. </p>
71
71
  *
72
72
  * @throws {@link LookoutEquipmentServiceException}
73
73
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -0,0 +1,125 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient";
5
+ import { DescribeRetrainingSchedulerRequest, DescribeRetrainingSchedulerResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeRetrainingSchedulerCommand}.
14
+ */
15
+ export interface DescribeRetrainingSchedulerCommandInput extends DescribeRetrainingSchedulerRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeRetrainingSchedulerCommand}.
21
+ */
22
+ export interface DescribeRetrainingSchedulerCommandOutput extends DescribeRetrainingSchedulerResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Provides a description of the retraining scheduler, including information such as the
27
+ * model name and retraining parameters. </p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { LookoutEquipmentClient, DescribeRetrainingSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
32
+ * // const { LookoutEquipmentClient, DescribeRetrainingSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
33
+ * const client = new LookoutEquipmentClient(config);
34
+ * const input = { // DescribeRetrainingSchedulerRequest
35
+ * ModelName: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new DescribeRetrainingSchedulerCommand(input);
38
+ * const response = await client.send(command);
39
+ * // { // DescribeRetrainingSchedulerResponse
40
+ * // ModelName: "STRING_VALUE",
41
+ * // ModelArn: "STRING_VALUE",
42
+ * // RetrainingStartDate: new Date("TIMESTAMP"),
43
+ * // RetrainingFrequency: "STRING_VALUE",
44
+ * // LookbackWindow: "STRING_VALUE",
45
+ * // Status: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED",
46
+ * // PromoteMode: "MANAGED" || "MANUAL",
47
+ * // CreatedAt: new Date("TIMESTAMP"),
48
+ * // UpdatedAt: new Date("TIMESTAMP"),
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param DescribeRetrainingSchedulerCommandInput - {@link DescribeRetrainingSchedulerCommandInput}
54
+ * @returns {@link DescribeRetrainingSchedulerCommandOutput}
55
+ * @see {@link DescribeRetrainingSchedulerCommandInput} for command's `input` shape.
56
+ * @see {@link DescribeRetrainingSchedulerCommandOutput} for command's `response` shape.
57
+ * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape.
58
+ *
59
+ * @throws {@link AccessDeniedException} (client fault)
60
+ * <p>The request could not be completed because you do not have access to the resource.
61
+ * </p>
62
+ *
63
+ * @throws {@link InternalServerException} (server fault)
64
+ * <p> Processing of the request has failed because of an unknown error, exception or failure.
65
+ * </p>
66
+ *
67
+ * @throws {@link ResourceNotFoundException} (client fault)
68
+ * <p> The resource requested could not be found. Verify the resource ID and retry your
69
+ * request. </p>
70
+ *
71
+ * @throws {@link ThrottlingException} (client fault)
72
+ * <p>The request was denied due to request throttling.</p>
73
+ *
74
+ * @throws {@link ValidationException} (client fault)
75
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
76
+ * service that's being utilized. </p>
77
+ *
78
+ * @throws {@link LookoutEquipmentServiceException}
79
+ * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
80
+ *
81
+ * @example Describes a retraining scheduler
82
+ * ```javascript
83
+ * //
84
+ * const input = {
85
+ * "ModelName": "sample-model"
86
+ * };
87
+ * const command = new DescribeRetrainingSchedulerCommand(input);
88
+ * const response = await client.send(command);
89
+ * /* response ==
90
+ * {
91
+ * "CreatedAt": "2023-10-01T15:00:00Z",
92
+ * "LookbackWindow": "P360D",
93
+ * "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
94
+ * "ModelName": "sample-model",
95
+ * "PromoteMode": "MANAGED",
96
+ * "RetrainingFrequency": "P1M",
97
+ * "RetrainingStartDate": "2023-11-01T00:00:00Z",
98
+ * "Status": "RUNNING",
99
+ * "UpdatedAt": "2023-10-01T15:00:00Z"
100
+ * }
101
+ * *\/
102
+ * // example id: describes-a-retraining-scheduler-1694019344252
103
+ * ```
104
+ *
105
+ */
106
+ export declare class DescribeRetrainingSchedulerCommand extends $Command<DescribeRetrainingSchedulerCommandInput, DescribeRetrainingSchedulerCommandOutput, LookoutEquipmentClientResolvedConfig> {
107
+ readonly input: DescribeRetrainingSchedulerCommandInput;
108
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
109
+ /**
110
+ * @public
111
+ */
112
+ constructor(input: DescribeRetrainingSchedulerCommandInput);
113
+ /**
114
+ * @internal
115
+ */
116
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LookoutEquipmentClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRetrainingSchedulerCommandInput, DescribeRetrainingSchedulerCommandOutput>;
117
+ /**
118
+ * @internal
119
+ */
120
+ private serialize;
121
+ /**
122
+ * @internal
123
+ */
124
+ private deserialize;
125
+ }
@@ -82,8 +82,8 @@ export interface ImportDatasetCommandOutput extends ImportDatasetResponse, __Met
82
82
  * <p>The request was denied due to request throttling.</p>
83
83
  *
84
84
  * @throws {@link ValidationException} (client fault)
85
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
86
- * related Amazon Web Services service that's being utilized. </p>
85
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
86
+ * service that's being utilized. </p>
87
87
  *
88
88
  * @throws {@link LookoutEquipmentServiceException}
89
89
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -50,6 +50,7 @@ export interface ImportModelVersionCommandOutput extends ImportModelVersionRespo
50
50
  * Value: "STRING_VALUE", // required
51
51
  * },
52
52
  * ],
53
+ * InferenceDataImportStrategy: "NO_IMPORT" || "ADD_WHEN_EMPTY" || "OVERWRITE",
53
54
  * };
54
55
  * const command = new ImportModelVersionCommand(input);
55
56
  * const response = await client.send(command);
@@ -92,8 +93,8 @@ export interface ImportModelVersionCommandOutput extends ImportModelVersionRespo
92
93
  * <p>The request was denied due to request throttling.</p>
93
94
  *
94
95
  * @throws {@link ValidationException} (client fault)
95
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
96
- * related Amazon Web Services service that's being utilized. </p>
96
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
97
+ * service that's being utilized. </p>
97
98
  *
98
99
  * @throws {@link LookoutEquipmentServiceException}
99
100
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -78,8 +78,8 @@ export interface ListDataIngestionJobsCommandOutput extends ListDataIngestionJob
78
78
  * <p>The request was denied due to request throttling.</p>
79
79
  *
80
80
  * @throws {@link ValidationException} (client fault)
81
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
82
- * related Amazon Web Services service that's being utilized. </p>
81
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
82
+ * service that's being utilized. </p>
83
83
  *
84
84
  * @throws {@link LookoutEquipmentServiceException}
85
85
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -70,8 +70,8 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
70
70
  * <p>The request was denied due to request throttling.</p>
71
71
  *
72
72
  * @throws {@link ValidationException} (client fault)
73
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
74
- * related Amazon Web Services service that's being utilized. </p>
73
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
74
+ * service that's being utilized. </p>
75
75
  *
76
76
  * @throws {@link LookoutEquipmentServiceException}
77
77
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -78,8 +78,8 @@ export interface ListInferenceEventsCommandOutput extends ListInferenceEventsRes
78
78
  * <p>The request was denied due to request throttling.</p>
79
79
  *
80
80
  * @throws {@link ValidationException} (client fault)
81
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
82
- * related Amazon Web Services service that's being utilized. </p>
81
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
82
+ * service that's being utilized. </p>
83
83
  *
84
84
  * @throws {@link LookoutEquipmentServiceException}
85
85
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -76,6 +76,8 @@ export interface ListInferenceExecutionsCommandOutput extends ListInferenceExecu
76
76
  * // },
77
77
  * // Status: "IN_PROGRESS" || "SUCCESS" || "FAILED",
78
78
  * // FailedReason: "STRING_VALUE",
79
+ * // ModelVersion: Number("long"),
80
+ * // ModelVersionArn: "STRING_VALUE",
79
81
  * // },
80
82
  * // ],
81
83
  * // };
@@ -104,8 +106,8 @@ export interface ListInferenceExecutionsCommandOutput extends ListInferenceExecu
104
106
  * <p>The request was denied due to request throttling.</p>
105
107
  *
106
108
  * @throws {@link ValidationException} (client fault)
107
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
108
- * related Amazon Web Services service that's being utilized. </p>
109
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
110
+ * service that's being utilized. </p>
109
111
  *
110
112
  * @throws {@link LookoutEquipmentServiceException}
111
113
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -76,8 +76,8 @@ export interface ListInferenceSchedulersCommandOutput extends ListInferenceSched
76
76
  * <p>The request was denied due to request throttling.</p>
77
77
  *
78
78
  * @throws {@link ValidationException} (client fault)
79
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
80
- * related Amazon Web Services service that's being utilized. </p>
79
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
80
+ * service that's being utilized. </p>
81
81
  *
82
82
  * @throws {@link LookoutEquipmentServiceException}
83
83
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -23,9 +23,7 @@ export interface ListLabelGroupsCommandOutput extends ListLabelGroupsResponse, _
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Returns a list of the label groups.
28
- * </p>
26
+ * <p> Returns a list of the label groups. </p>
29
27
  * @example
30
28
  * Use a bare-bones client and the command you need to make an API call.
31
29
  * ```javascript
@@ -71,8 +69,8 @@ export interface ListLabelGroupsCommandOutput extends ListLabelGroupsResponse, _
71
69
  * <p>The request was denied due to request throttling.</p>
72
70
  *
73
71
  * @throws {@link ValidationException} (client fault)
74
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
75
- * related Amazon Web Services service that's being utilized. </p>
72
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
73
+ * service that's being utilized. </p>
76
74
  *
77
75
  * @throws {@link LookoutEquipmentServiceException}
78
76
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -23,9 +23,7 @@ export interface ListLabelsCommandOutput extends ListLabelsResponse, __MetadataB
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
27
- * Provides a list of labels.
28
- * </p>
26
+ * <p> Provides a list of labels. </p>
29
27
  * @example
30
28
  * Use a bare-bones client and the command you need to make an API call.
31
29
  * ```javascript
@@ -80,8 +78,8 @@ export interface ListLabelsCommandOutput extends ListLabelsResponse, __MetadataB
80
78
  * <p>The request was denied due to request throttling.</p>
81
79
  *
82
80
  * @throws {@link ValidationException} (client fault)
83
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
84
- * related Amazon Web Services service that's being utilized. </p>
81
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
82
+ * service that's being utilized. </p>
85
83
  *
86
84
  * @throws {@link LookoutEquipmentServiceException}
87
85
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -23,9 +23,9 @@ export interface ListModelVersionsCommandOutput extends ListModelVersionsRespons
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Generates a list of all model versions for a given model,
27
- * including the model version, model version ARN, and status. To list a
28
- * subset of versions, use the <code>MaxModelVersion</code> and <code>MinModelVersion</code> fields.</p>
26
+ * <p>Generates a list of all model versions for a given model, including the model version,
27
+ * model version ARN, and status. To list a subset of versions, use the
28
+ * <code>MaxModelVersion</code> and <code>MinModelVersion</code> fields.</p>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
31
31
  * ```javascript
@@ -84,8 +84,8 @@ export interface ListModelVersionsCommandOutput extends ListModelVersionsRespons
84
84
  * <p>The request was denied due to request throttling.</p>
85
85
  *
86
86
  * @throws {@link ValidationException} (client fault)
87
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
88
- * related Amazon Web Services service that's being utilized. </p>
87
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
88
+ * service that's being utilized. </p>
89
89
  *
90
90
  * @throws {@link LookoutEquipmentServiceException}
91
91
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>
@@ -52,6 +52,11 @@ export interface ListModelsCommandOutput extends ListModelsResponse, __MetadataB
52
52
  * // CreatedAt: new Date("TIMESTAMP"),
53
53
  * // ActiveModelVersion: Number("long"),
54
54
  * // ActiveModelVersionArn: "STRING_VALUE",
55
+ * // LatestScheduledRetrainingStatus: "IN_PROGRESS" || "SUCCESS" || "FAILED" || "IMPORT_IN_PROGRESS" || "CANCELED",
56
+ * // LatestScheduledRetrainingModelVersion: Number("long"),
57
+ * // LatestScheduledRetrainingStartTime: new Date("TIMESTAMP"),
58
+ * // NextScheduledRetrainingStartDate: new Date("TIMESTAMP"),
59
+ * // RetrainingSchedulerStatus: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED",
55
60
  * // },
56
61
  * // ],
57
62
  * // };
@@ -76,8 +81,8 @@ export interface ListModelsCommandOutput extends ListModelsResponse, __MetadataB
76
81
  * <p>The request was denied due to request throttling.</p>
77
82
  *
78
83
  * @throws {@link ValidationException} (client fault)
79
- * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
80
- * related Amazon Web Services service that's being utilized. </p>
84
+ * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
85
+ * service that's being utilized. </p>
81
86
  *
82
87
  * @throws {@link LookoutEquipmentServiceException}
83
88
  * <p>Base exception class for all service exceptions from LookoutEquipment service.</p>