Amazon Lookout for Equipment is no longer open to new customers.
Existing customers can continue to use the service as normal.
For capabilities similar to Amazon Lookout for Equipment see our
blog post
UpdateActiveModelVersion
Sets the active model version for a given machine learning model.
Request Syntax
{
"ModelName": "string",
"ModelVersion": number
}Request Parameters
The request accepts the following data in JSON format.
- ModelName
-
The name of the machine learning model for which the active model version is being set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z_-]{1,200}$Required: Yes
- ModelVersion
-
The version of the machine learning model for which the active model version is being set.
Type: Long
Valid Range: Minimum value of 1.
Required: Yes
Response Syntax
{
"CurrentActiveVersion": number,
"CurrentActiveVersionArn": "string",
"ModelArn": "string",
"ModelName": "string",
"PreviousActiveVersion": number,
"PreviousActiveVersionArn": "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.
- CurrentActiveVersion
-
The version that is currently active of the machine learning model for which the active model version was set.
Type: Long
Valid Range: Minimum value of 1.
- CurrentActiveVersionArn
-
The Amazon Resource Name (ARN) of the machine learning model version that is the current active model version.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$ - ModelArn
-
The Amazon Resource Name (ARN) of the machine learning model for which the active model version was set.
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 machine learning model for which the active model version was set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z_-]{1,200}$ - PreviousActiveVersion
-
The previous version that was active of the machine learning model for which the active model version was set.
Type: Long
Valid Range: Minimum value of 1.
- PreviousActiveVersionArn
-
The Amazon Resource Name (ARN) of the machine learning model version that was the previous active model version.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$
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:
