ListUltraServersByReservedCapacity
Lists all UltraServers that are part of a specified reserved capacity.
Request Syntax
{ "MaxResults": number, "NextToken": "string", "ReservedCapacityArn": "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.
- MaxResults
-
The maximum number of UltraServers to return in the response. The default value is 10.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.*Required: No
- ReservedCapacityArn
-
The ARN of the reserved capacity to list UltraServers for.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:reserved-capacity/.*Required: Yes
Response Syntax
{ "NextToken": "string", "UltraServers": [ { "AvailabilityZone": "string", "AvailableInstanceCount": number, "AvailableSpareInstanceCount": number, "ConfiguredSpareInstanceCount": number, "HealthStatus": "string", "InstanceType": "string", "InUseInstanceCount": number, "TotalInstanceCount": number, "UltraServerId": "string", "UltraServerType": "string", "UnhealthyInstanceCount": number } ] }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.
- NextToken
-
If the response is truncated, SageMaker returns this token. Use it in the next request to retrieve the next set of UltraServers.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.* - UltraServers
-
A list of UltraServers that are part of the specified reserved capacity.
Type: Array of UltraServer objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: