StopInferenceScheduler - Amazon Lookout for Equipment

StopInferenceScheduler

Stops an inference scheduler.

Request Syntax

{ "InferenceSchedulerName": "string" }

Request Parameters

The request accepts the following data in JSON format.

InferenceSchedulerName

The name of the inference scheduler to be stopped.

Type: String

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

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

Required: Yes

Response Syntax

{ "InferenceSchedulerArn": "string", "InferenceSchedulerName": "string", "ModelArn": "string", "ModelName": "string", "Status": "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.

InferenceSchedulerArn

The Amazon Resource Name (ARN) of the inference schedule being stopped.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:inference-scheduler\/.+

InferenceSchedulerName

The name of the inference scheduler being stopped.

Type: String

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

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

ModelArn

The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being stopped.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+

ModelName

The name of the ML model used by the inference scheduler being stopped.

Type: String

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

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

Status

Indicates the status of the inference scheduler.

Type: String

Valid Values: PENDING | RUNNING | STOPPING | STOPPED

Errors

AccessDeniedException

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

HTTP Status Code: 400

ConflictException

The request could not be completed due to a conflict with the current state of the target 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: