UpdateEndpointWeightsAndCapacities
Updates variant weight of one or more variants associated with an existing
endpoint, or capacity of one variant associated with an existing endpoint. When it
receives the request, SageMaker sets the endpoint status to Updating. After
updating the endpoint, it sets the status to InService. To check the status
of an endpoint, use the DescribeEndpoint API.
Request Syntax
{
"DesiredWeightsAndCapacities": [
{
"DesiredInstanceCount": number,
"DesiredWeight": number,
"ServerlessUpdateConfig": {
"MaxConcurrency": number,
"ProvisionedConcurrency": number
},
"VariantName": "string"
}
],
"EndpointName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DesiredWeightsAndCapacities
-
An object that provides new capacity and weight values for a variant.
Type: Array of DesiredWeightAndCapacity objects
Array Members: Minimum number of 1 item.
Required: Yes
- EndpointName
-
The name of an existing SageMaker endpoint.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
Response Syntax
{
"EndpointArn": "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.
- EndpointArn
-
The Amazon Resource Name (ARN) of the updated endpoint.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:endpoint/.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceLimitExceeded
-
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
