Get Spot Placement Scores

ec2_get_spot_placement_scores

R Documentation

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

Description

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.

Usage

ec2_get_spot_placement_scores(InstanceTypes, TargetCapacity,
  TargetCapacityUnitType, SingleAvailabilityZone, RegionNames,
  InstanceRequirementsWithMetadata, DryRun, MaxResults, NextToken)

Arguments

InstanceTypes

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.

TargetCapacity

[required] The target capacity.

TargetCapacityUnitType

The unit for the target capacity.

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.

RegionNames

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

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.

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.

MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Value

A list with the following syntax:

list(
  SpotPlacementScores = list(
    list(
      Region = "string",
      AvailabilityZoneId = "string",
      Score = 123
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_spot_placement_scores(
  InstanceTypes = list(
    "string"
  ),
  TargetCapacity = 123,
  TargetCapacityUnitType = "vcpu"|"memory-mib"|"units",
  SingleAvailabilityZone = TRUE|FALSE,
  RegionNames = list(
    "string"
  ),
  InstanceRequirementsWithMetadata = list(
    ArchitectureTypes = list(
      "i386"|"x86_64"|"arm64"|"x86_64_mac"|"arm64_mac"
    ),
    VirtualizationTypes = list(
      "hvm"|"paravirtual"
    ),
    InstanceRequirements = list(
      VCpuCount = list(
        Min = 123,
        Max = 123
      ),
      MemoryMiB = list(
        Min = 123,
        Max = 123
      ),
      CpuManufacturers = list(
        "intel"|"amd"|"amazon-web-services"
      ),
      MemoryGiBPerVCpu = list(
        Min = 123.0,
        Max = 123.0
      ),
      ExcludedInstanceTypes = list(
        "string"
      ),
      InstanceGenerations = list(
        "current"|"previous"
      ),
      SpotMaxPricePercentageOverLowestPrice = 123,
      OnDemandMaxPricePercentageOverLowestPrice = 123,
      BareMetal = "included"|"required"|"excluded",
      BurstablePerformance = "included"|"required"|"excluded",
      RequireHibernateSupport = TRUE|FALSE,
      NetworkInterfaceCount = list(
        Min = 123,
        Max = 123
      ),
      LocalStorage = "included"|"required"|"excluded",
      LocalStorageTypes = list(
        "hdd"|"ssd"
      ),
      TotalLocalStorageGB = list(
        Min = 123.0,
        Max = 123.0
      ),
      BaselineEbsBandwidthMbps = list(
        Min = 123,
        Max = 123
      ),
      AcceleratorTypes = list(
        "gpu"|"fpga"|"inference"
      ),
      AcceleratorCount = list(
        Min = 123,
        Max = 123
      ),
      AcceleratorManufacturers = list(
        "amazon-web-services"|"amd"|"nvidia"|"xilinx"|"habana"
      ),
      AcceleratorNames = list(
        "a100"|"inferentia"|"k520"|"k80"|"m60"|"radeon-pro-v520"|"t4"|"vu9p"|"v100"|"a10g"|"h100"|"t4g"
      ),
      AcceleratorTotalMemoryMiB = list(
        Min = 123,
        Max = 123
      ),
      NetworkBandwidthGbps = list(
        Min = 123.0,
        Max = 123.0
      ),
      AllowedInstanceTypes = list(
        "string"
      ),
      MaxSpotPriceAsPercentageOfOptimalOnDemandPrice = 123
    )
  ),
  DryRun = TRUE|FALSE,
  MaxResults = 123,
  NextToken = "string"
)