ListInferenceExecutions - Amazon Lookout for Equipment

ListInferenceExecutions

Lists all inference executions that have been performed by the specified inference scheduler.

Request Syntax

{ "DataEndTimeBefore": number, "DataStartTimeAfter": number, "InferenceSchedulerName": "string", "MaxResults": number, "NextToken": "string", "Status": "string" }

Request Parameters

The request accepts the following data in JSON format.

DataEndTimeBefore

The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the inference execution.

Type: Timestamp

Required: No

DataStartTimeAfter

The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference execution.

Type: Timestamp

Required: No

InferenceSchedulerName

The name of the inference scheduler for the inference execution listed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z_-]{1,200}$

Required: Yes

MaxResults

Specifies the maximum number of inference executions to list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

An opaque pagination token indicating where to continue the listing of inference executions.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Required: No

Status

The status of the inference execution.

Type: String

Valid Values: IN_PROGRESS | SUCCESS | FAILED

Required: No

Response Syntax

{ "InferenceExecutionSummaries": [ { "CustomerResultObject": { "Bucket": "string", "Key": "string" }, "DataEndTime": number, "DataInputConfiguration": { "InferenceInputNameConfiguration": { "ComponentTimestampDelimiter": "string", "TimestampFormat": "string" }, "InputTimeZoneOffset": "string", "S3InputConfiguration": { "Bucket": "string", "Prefix": "string" } }, "DataOutputConfiguration": { "KmsKeyId": "string", "S3OutputConfiguration": { "Bucket": "string", "Prefix": "string" } }, "DataStartTime": number, "FailedReason": "string", "InferenceSchedulerArn": "string", "InferenceSchedulerName": "string", "ModelArn": "string", "ModelName": "string", "ModelVersion": number, "ModelVersionArn": "string", "ScheduledStartTime": number, "Status": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InferenceExecutionSummaries

Provides an array of information about the individual inference executions returned from the ListInferenceExecutions operation, including model used, inference scheduler, data configuration, and so on.

Note

If you don't supply the InferenceSchedulerName request parameter, or if you supply the name of an inference scheduler that doesn't exist, ListInferenceExecutions returns an empty array in InferenceExecutionSummaries.

Type: Array of InferenceExecutionSummary objects

NextToken

An opaque pagination token indicating where to continue the listing of inference executions.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Errors

AccessDeniedException

The request could not be completed because you do not have access to the resource.

HTTP Status Code: 400

InternalServerException

Processing of the request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource requested could not be found. Verify the resource ID and retry your request.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: