- 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.
ListInferenceExecutionsCommand
Lists all inference executions that have been performed by the specified inference scheduler.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LookoutEquipmentClient, ListInferenceExecutionsCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
// const { LookoutEquipmentClient, ListInferenceExecutionsCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
const client = new LookoutEquipmentClient(config);
const input = { // ListInferenceExecutionsRequest
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
InferenceSchedulerName: "STRING_VALUE", // required
DataStartTimeAfter: new Date("TIMESTAMP"),
DataEndTimeBefore: new Date("TIMESTAMP"),
Status: "IN_PROGRESS" || "SUCCESS" || "FAILED",
};
const command = new ListInferenceExecutionsCommand(input);
const response = await client.send(command);
// { // ListInferenceExecutionsResponse
// NextToken: "STRING_VALUE",
// InferenceExecutionSummaries: [ // InferenceExecutionSummaries
// { // InferenceExecutionSummary
// ModelName: "STRING_VALUE",
// ModelArn: "STRING_VALUE",
// InferenceSchedulerName: "STRING_VALUE",
// InferenceSchedulerArn: "STRING_VALUE",
// ScheduledStartTime: new Date("TIMESTAMP"),
// DataStartTime: new Date("TIMESTAMP"),
// DataEndTime: new Date("TIMESTAMP"),
// DataInputConfiguration: { // InferenceInputConfiguration
// S3InputConfiguration: { // InferenceS3InputConfiguration
// Bucket: "STRING_VALUE", // required
// Prefix: "STRING_VALUE",
// },
// InputTimeZoneOffset: "STRING_VALUE",
// InferenceInputNameConfiguration: { // InferenceInputNameConfiguration
// TimestampFormat: "STRING_VALUE",
// ComponentTimestampDelimiter: "STRING_VALUE",
// },
// },
// DataOutputConfiguration: { // InferenceOutputConfiguration
// S3OutputConfiguration: { // InferenceS3OutputConfiguration
// Bucket: "STRING_VALUE", // required
// Prefix: "STRING_VALUE",
// },
// KmsKeyId: "STRING_VALUE",
// },
// CustomerResultObject: { // S3Object
// Bucket: "STRING_VALUE", // required
// Key: "STRING_VALUE", // required
// },
// Status: "IN_PROGRESS" || "SUCCESS" || "FAILED",
// FailedReason: "STRING_VALUE",
// ModelVersion: Number("long"),
// ModelVersionArn: "STRING_VALUE",
// },
// ],
// };
ListInferenceExecutionsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
InferenceSchedulerName Required | string | undefined | The name of the inference scheduler for the inference execution listed. |
DataEndTimeBefore | Date | undefined | The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the inference execution. |
DataStartTimeAfter | Date | undefined | The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference execution. |
MaxResults | number | undefined | Specifies the maximum number of inference executions to list. |
NextToken | string | undefined | An opaque pagination token indicating where to continue the listing of inference executions. |
Status | InferenceExecutionStatus | undefined | The status of the inference execution. |
ListInferenceExecutionsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
InferenceExecutionSummaries | InferenceExecutionSummary[] | undefined | Provides an array of information about the individual inference executions returned from the If you don't supply the |
NextToken | string | undefined | An opaque pagination token indicating where to continue the listing of inference executions. |
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. |
ResourceNotFoundException | client | The resource requested could not be found. Verify the resource ID and retry your request. |
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. |