get_capacity_manager_supportability_scores¶
Operation¶
get_capacity_manager_supportability_scores
¶
get_capacity_manager_supportability_scores(request: GetCapacityManagerSupportabilityScoresInput | GetCapacityManagerSupportabilityScoresInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCapacityManagerSupportabilityScoresInputDict]) -> GetCapacityManagerSupportabilityScoresOutput
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 Amazon Web Services Support customers on the Unified Operations plan.
For more information, see Check supportability in the Amazon EC2 User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetCapacityManagerSupportabilityScoresInput | GetCapacityManagerSupportabilityScoresInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetCapacityManagerSupportabilityScoresInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetCapacityManagerSupportabilityScoresOutput
|
An instance of |
get_capacity_manager_supportability_scores
async
¶
get_capacity_manager_supportability_scores(request: GetCapacityManagerSupportabilityScoresInput | GetCapacityManagerSupportabilityScoresInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCapacityManagerSupportabilityScoresInputDict]) -> GetCapacityManagerSupportabilityScoresOutput
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 Amazon Web Services Support customers on the Unified Operations plan.
For more information, see Check supportability in the Amazon EC2 User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetCapacityManagerSupportabilityScoresInput | GetCapacityManagerSupportabilityScoresInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetCapacityManagerSupportabilityScoresInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetCapacityManagerSupportabilityScoresOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetCapacityManagerSupportabilityScoresInputDict
¶
Bases: TypedDict
Dictionary form of GetCapacityManagerSupportabilityScoresInput.
Attributes¶
capacity_amount
instance-attribute
¶
The amount of capacity that you need, in the unit that you specify for
CapacityUnit. Each score is relative to this amount.
capacity_availability_zone_ids
instance-attribute
¶
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.
dry_run
instance-attribute
¶
dry_run: bool | None
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 is UnauthorizedOperation.
instance_requirements_with_metadata
instance-attribute
¶
instance_requirements_with_metadata: InstanceRequirementsWithMetadataRequest | InstanceRequirementsWithMetadataRequestDict | None
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 InstanceTypes or InstanceRequirementsWithMetadata,
but not both.
instance_types
instance-attribute
¶
The instance types to score. You can specify up to 50 instance types.
Specify either InstanceTypes or InstanceRequirementsWithMetadata,
but not both.
GetCapacityManagerSupportabilityScoresInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetCapacityManagerSupportabilityScoresInput structure.
Attributes¶
capacity_amount
class-attribute
instance-attribute
¶
capacity_amount: int | None = ...
The amount of capacity that you need, in the unit that you specify for
CapacityUnit. Each score is relative to this amount.
capacity_availability_zone_ids
class-attribute
instance-attribute
¶
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.
capacity_unit
class-attribute
instance-attribute
¶
capacity_unit: str | None = ...
The unit for CapacityAmount.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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 is UnauthorizedOperation.
instance_requirements_with_metadata
class-attribute
instance-attribute
¶
instance_requirements_with_metadata: InstanceRequirementsWithMetadataRequest | None = ...
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 InstanceTypes or InstanceRequirementsWithMetadata,
but not both.
instance_types
class-attribute
instance-attribute
¶
The instance types to score. You can specify up to 50 instance types.
Specify either InstanceTypes or InstanceRequirementsWithMetadata,
but not both.
Output¶
GetCapacityManagerSupportabilityScoresOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetCapacityManagerSupportabilityScoresOutput structure.
Attributes¶
aggregate_score
class-attribute
instance-attribute
¶
aggregate_score: str | None = ...
The score for all instance type and Availability Zone combinations in
the request together. A high aggregate score with lower individual
scores means that no single combination can support the full request,
but the combinations together can.
capacity_manager_supportability_scores
class-attribute
instance-attribute
¶
capacity_manager_supportability_scores: list[CapacityManagerSupportabilityScore] | None = ...
The score for each instance type and Availability Zone combination in the request.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.