- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListInferenceSchedulersCommand
Retrieves a list of all inference schedulers currently available for your account.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LookoutEquipmentClient, ListInferenceSchedulersCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
// const { LookoutEquipmentClient, ListInferenceSchedulersCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
const client = new LookoutEquipmentClient(config);
const input = { // ListInferenceSchedulersRequest
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
InferenceSchedulerNameBeginsWith: "STRING_VALUE",
ModelName: "STRING_VALUE",
Status: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED",
};
const command = new ListInferenceSchedulersCommand(input);
const response = await client.send(command);
// { // ListInferenceSchedulersResponse
// NextToken: "STRING_VALUE",
// InferenceSchedulerSummaries: [ // InferenceSchedulerSummaries
// { // InferenceSchedulerSummary
// ModelName: "STRING_VALUE",
// ModelArn: "STRING_VALUE",
// InferenceSchedulerName: "STRING_VALUE",
// InferenceSchedulerArn: "STRING_VALUE",
// Status: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED",
// DataDelayOffsetInMinutes: Number("long"),
// DataUploadFrequency: "PT5M" || "PT10M" || "PT15M" || "PT30M" || "PT1H",
// LatestInferenceResult: "ANOMALOUS" || "NORMAL",
// },
// ],
// };
ListInferenceSchedulersCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
InferenceSchedulerNameBeginsWith | string | undefined | The beginning of the name of the inference schedulers to be listed. |
MaxResults | number | undefined | Specifies the maximum number of inference schedulers to list. |
ModelName | string | undefined | The name of the machine learning model used by the inference scheduler to be listed. |
NextToken | string | undefined | An opaque pagination token indicating where to continue the listing of inference schedulers. |
Status | InferenceSchedulerStatus | undefined | Specifies the current status of the inference schedulers. |
ListInferenceSchedulersCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
InferenceSchedulerSummaries | InferenceSchedulerSummary[] | undefined | Provides information about the specified inference scheduler, including data upload frequency, model name and ARN, and status. |
NextToken | string | undefined | An opaque pagination token indicating where to continue the listing of inference schedulers. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The request could not be completed because you do not have access to the resource. |
InternalServerException | server | Processing of the request has failed because of an unknown error, exception or failure. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized. |
LookoutEquipmentServiceException | Base exception class for all service exceptions from LookoutEquipment service. |