GetSpotPlacementScores - Amazon Elastic Compute Cloud

GetSpotPlacementScores

Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.

You can specify your compute requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using InstanceTypes.

For more information, see Spot placement score 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.

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 is UnauthorizedOperation.

Type: Boolean

Required: No

InstanceRequirementsWithMetadata

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

If you specify InstanceRequirementsWithMetadata, you can't specify InstanceTypes.

Type: InstanceRequirementsWithMetadataRequest object

Required: No

InstanceType.N

The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an m3.xlarge with and without instance storage), the returned placement score will always be low.

If you specify InstanceTypes, you can't specify InstanceRequirementsWithMetadata.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1000 items.

Required: No

MaxResults

The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 1000.

Required: No

NextToken

The token for the next set of results.

Type: String

Required: No

RegionName.N

The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, us-east-1.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

SingleAvailabilityZone

Specify true so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.

A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.

Type: Boolean

Required: No

TargetCapacity

The target capacity.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 2000000000.

Required: Yes

TargetCapacityUnitType

The unit for the target capacity.

Default: units (translates to number of instances)

Type: String

Valid Values: vcpu | memory-mib | units

Required: No

Response Elements

The following elements are returned by the service.

nextToken

The token for the next set of results.

Type: String

requestId

The ID of the request.

Type: String

spotPlacementScoreSet

The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale from 1 to 10. Each score
 reflects how likely it is that each Region or Availability Zone will succeed at fulfilling the specified target capacity
 at the time of the Spot placement score request. A score of 10 means that your Spot capacity request is highly likely to succeed in that Region or Availability Zone.

If you request a Spot placement score for Regions, a high score assumes that your fleet request will be configured to use all Availability Zones and the capacity-optimized allocation strategy. If you request a Spot placement score for Availability Zones, a high score assumes that your fleet request will be configured to use a single Availability Zone and the capacity-optimized allocation strategy.

Different
 Regions or Availability Zones might return the same score.

Note

The Spot placement score serves as a recommendation only. No score guarantees that your Spot request will be fully or partially fulfilled.

Type: Array of SpotPlacementScore objects

Errors

For information about the errors that are common to all actions, see Common client error codes.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: