GetCapacityManagerSupportabilityScores
Scores how well each instance type and Availability Zone combination can support a capacity request, based on current Amazon EC2 capacity. The response includes a score for each combination and an aggregate score for all combinations in the request. This action doesn't launch or reserve instances, and a score doesn't guarantee that a later launch will succeed.
Call this action in the Region where you turned on Capacity Manager. A single request can include Availability Zones in any Region. Real-time supportability checks are available only to AWS Support customers on the Unified Operations plan.
For more information, see Check supportability in the Amazon EC2 User Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- CapacityAmount
-
The amount of capacity that you need, in the unit that you specify for
CapacityUnit. Each score is relative to this amount.Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
- CapacityAvailabilityZoneId.N
-
The IDs of the Availability Zones to score, such as
use1-az1. You can specify Availability Zones in different Regions. You can specify up to 10 Availability Zones.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
- CapacityUnit
-
The unit for
CapacityAmount.Type: String
Valid Values:
vcpus | instancesRequired: Yes
- DryRun
-
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.Type: Boolean
Required: No
- InstanceRequirementsWithMetadata
-
The attributes that the instance types must have, such as vCPU and memory ranges. Capacity Manager resolves the attributes into matching instance types and scores each one.
Specify either
InstanceTypesorInstanceRequirementsWithMetadata, but not both.Type: InstanceRequirementsWithMetadataRequest object
Required: No
- InstanceType.N
-
The instance types to score. You can specify up to 50 instance types.
Specify either
InstanceTypesorInstanceRequirementsWithMetadata, but not both.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- MarketType
-
The capacity market to score.
Type: String
Valid Values:
on-demand | spotRequired: Yes
Response Elements
The following elements are returned by the service.
- aggregateScore
-
The score for all instance type and Availability Zone combinations in the request together. A
highaggregate score with lower individual scores means that no single combination can support the full request, but the combinations together can.Type: String
Valid Values:
high | medium | low - capacityManagerSupportabilityScoreSet
-
The score for each instance type and Availability Zone combination in the request.
Type: Array of CapacityManagerSupportabilityScore objects
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common Error Types.
Examples
Example
This example scores three instance types in one Availability Zone for a request of 50 On-Demand Instances.
Sample Request
https://ec2.amazonaws.com/?Action=GetCapacityManagerSupportabilityScores
&MarketType=on-demand
&CapacityAmount=50
&CapacityUnit=instances
&CapacityAvailabilityZoneId.1=use1-az1
&InstanceType.1=c6g.xlarge
&InstanceType.2=c7g.xlarge
&InstanceType.3=m6g.xlarge
&AUTHPARAMS
Sample Response
<GetCapacityManagerSupportabilityScoresResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestId>
<aggregateScore>high</aggregateScore>
<capacityManagerSupportabilityScoreSet>
<item>
<instanceType>c6g.xlarge</instanceType>
<availabilityZoneId>use1-az1</availabilityZoneId>
<score>high</score>
</item>
<item>
<instanceType>c7g.xlarge</instanceType>
<availabilityZoneId>use1-az1</availabilityZoneId>
<score>high</score>
</item>
<item>
<instanceType>m6g.xlarge</instanceType>
<availabilityZoneId>use1-az1</availabilityZoneId>
<score>medium</score>
</item>
</capacityManagerSupportabilityScoreSet>
</GetCapacityManagerSupportabilityScoresResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: