EC2 / Paginator / GetSpotPlacementScores

GetSpotPlacementScores

class EC2.Paginator.GetSpotPlacementScores

paginator = client.get_paginator('get_spot_placement_scores')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.get_spot_placement_scores().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceTypes=[
        'string',
    ],
    TargetCapacity=123,
    TargetCapacityUnitType='vcpu'|'memory-mib'|'units',
    SingleAvailabilityZone=True|False,
    RegionNames=[
        'string',
    ],
    InstanceRequirementsWithMetadata={
        'ArchitectureTypes': [
            'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac',
        ],
        'VirtualizationTypes': [
            'hvm'|'paravirtual',
        ],
        'InstanceRequirements': {
            'VCpuCount': {
                'Min': 123,
                'Max': 123
            },
            'MemoryMiB': {
                'Min': 123,
                'Max': 123
            },
            'CpuManufacturers': [
                'intel'|'amd'|'amazon-web-services'|'apple',
            ],
            'MemoryGiBPerVCpu': {
                'Min': 123.0,
                'Max': 123.0
            },
            'ExcludedInstanceTypes': [
                'string',
            ],
            'InstanceGenerations': [
                'current'|'previous',
            ],
            'SpotMaxPricePercentageOverLowestPrice': 123,
            'OnDemandMaxPricePercentageOverLowestPrice': 123,
            'BareMetal': 'included'|'required'|'excluded',
            'BurstablePerformance': 'included'|'required'|'excluded',
            'RequireHibernateSupport': True|False,
            'NetworkInterfaceCount': {
                'Min': 123,
                'Max': 123
            },
            'LocalStorage': 'included'|'required'|'excluded',
            'LocalStorageTypes': [
                'hdd'|'ssd',
            ],
            'TotalLocalStorageGB': {
                'Min': 123.0,
                'Max': 123.0
            },
            'BaselineEbsBandwidthMbps': {
                'Min': 123,
                'Max': 123
            },
            'AcceleratorTypes': [
                'gpu'|'fpga'|'inference',
            ],
            'AcceleratorCount': {
                'Min': 123,
                'Max': 123
            },
            'AcceleratorManufacturers': [
                'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana',
            ],
            'AcceleratorNames': [
                'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g',
            ],
            'AcceleratorTotalMemoryMiB': {
                'Min': 123,
                'Max': 123
            },
            'NetworkBandwidthGbps': {
                'Min': 123.0,
                'Max': 123.0
            },
            'AllowedInstanceTypes': [
                'string',
            ],
            'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123,
            'BaselinePerformanceFactors': {
                'Cpu': {
                    'References': [
                        {
                            'InstanceFamily': 'string'
                        },
                    ]
                }
            }
        }
    },
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InstanceTypes (list) –

  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.

  • (string) –

• TargetCapacity (integer) –

  [REQUIRED]

  The target capacity.

• TargetCapacityUnitType (string) – The unit for the target capacity.

• SingleAvailabilityZone (boolean) –

  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 (list) –

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

  • (string) –

• InstanceRequirementsWithMetadata (dict) –

  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.

  • ArchitectureTypes (list) –

    The architecture type.

    • (string) –

  • VirtualizationTypes (list) –

    The virtualization type.

    • (string) –

  • InstanceRequirements (dict) –

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

    • VCpuCount (dict) – [REQUIRED]

      The minimum and maximum number of vCPUs.

      • Min (integer) – [REQUIRED]

        The minimum number of vCPUs. To specify no minimum limit, specify 0.

      • Max (integer) –

        The maximum number of vCPUs. To specify no maximum limit, omit this parameter.

    • MemoryMiB (dict) – [REQUIRED]

      The minimum and maximum amount of memory, in MiB.

      • Min (integer) – [REQUIRED]

        The minimum amount of memory, in MiB. To specify no minimum limit, specify 0.

      • Max (integer) –

        The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.

    • CpuManufacturers (list) –

      The CPU manufacturers to include.

      • For instance types with Intel CPUs, specify intel.

      • For instance types with AMD CPUs, specify amd.

      • For instance types with Amazon Web Services CPUs, specify amazon-web-services.

      • For instance types with Apple CPUs, specify apple.

      Note

      Don’t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.

      Default: Any manufacturer

      • (string) –

    • MemoryGiBPerVCpu (dict) –

      The minimum and maximum amount of memory per vCPU, in GiB.

      Default: No minimum or maximum limits

      • Min (float) –

        The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.

      • Max (float) –

        The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.

    • ExcludedInstanceTypes (list) –

      The instance types to exclude.

      You can use strings with one or more wild cards, represented by an asterisk ( *), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

      For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.

      Note

      If you specify ExcludedInstanceTypes, you can’t specify AllowedInstanceTypes.

      Default: No excluded instance types

      • (string) –

    • InstanceGenerations (list) –

      Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.

      For current generation instance types, specify current.

      For previous generation instance types, specify previous.

      Default: Current and previous generation instance types

      • (string) –

    • SpotMaxPricePercentageOverLowestPrice (integer) –

      [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.

      The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

      If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.

      This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

      Note

      Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.

      Default: 100

    • OnDemandMaxPricePercentageOverLowestPrice (integer) –

      [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.

      The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

      To indicate no price protection threshold, specify a high value, such as 999999.

      This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

      Note

      If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.

      Default: 20

    • BareMetal (string) –

      Indicates whether bare metal instance types must be included, excluded, or required.

      • To include bare metal instance types, specify included.

      • To require only bare metal instance types, specify required.

      • To exclude bare metal instance types, specify excluded.

      Default: excluded

    • BurstablePerformance (string) –

      Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.

      • To include burstable performance instance types, specify included.

      • To require only burstable performance instance types, specify required.

      • To exclude burstable performance instance types, specify excluded.

      Default: excluded

    • RequireHibernateSupport (boolean) –

      Indicates whether instance types must support hibernation for On-Demand Instances.

      This parameter is not supported for GetSpotPlacementScores.

      Default: false

    • NetworkInterfaceCount (dict) –

      The minimum and maximum number of network interfaces.

      Default: No minimum or maximum limits

      • Min (integer) –

        The minimum number of network interfaces. To specify no minimum limit, omit this parameter.

      • Max (integer) –

        The maximum number of network interfaces. To specify no maximum limit, omit this parameter.

    • LocalStorage (string) –

      Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.

      • To include instance types with instance store volumes, specify included.

      • To require only instance types with instance store volumes, specify required.

      • To exclude instance types with instance store volumes, specify excluded.

      Default: included

    • LocalStorageTypes (list) –

      The type of local storage that is required.

      • For instance types with hard disk drive (HDD) storage, specify hdd.

      • For instance types with solid state drive (SSD) storage, specify ssd.

      Default: hdd and ssd

      • (string) –

    • TotalLocalStorageGB (dict) –

      The minimum and maximum amount of total local storage, in GB.

      Default: No minimum or maximum limits

      • Min (float) –

        The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.

      • Max (float) –

        The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.

    • BaselineEbsBandwidthMbps (dict) –

      The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.

      Default: No minimum or maximum limits

      • Min (integer) –

        The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.

      • Max (integer) –

        The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.

    • AcceleratorTypes (list) –

      The accelerator types that must be on the instance type.

      • To include instance types with GPU hardware, specify gpu.

      • To include instance types with FPGA hardware, specify fpga.

      Default: Any accelerator type

      • (string) –

    • AcceleratorCount (dict) –

      The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.

      To exclude accelerator-enabled instance types, set Max to 0.

      Default: No minimum or maximum limits

      • Min (integer) –

        The minimum number of accelerators. To specify no minimum limit, omit this parameter.

      • Max (integer) –

        The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0.

    • AcceleratorManufacturers (list) –

      Indicates whether instance types must have accelerators by specific manufacturers.

      • For instance types with Amazon Web Services devices, specify amazon-web-services.

      • For instance types with AMD devices, specify amd.

      • For instance types with Habana devices, specify habana.

      • For instance types with NVIDIA devices, specify nvidia.

      • For instance types with Xilinx devices, specify xilinx.

      Default: Any manufacturer

      • (string) –

    • AcceleratorNames (list) –

      The accelerators that must be on the instance type.

      • For instance types with NVIDIA A10G GPUs, specify a10g.

      • For instance types with NVIDIA A100 GPUs, specify a100.

      • For instance types with NVIDIA H100 GPUs, specify h100.

      • For instance types with Amazon Web Services Inferentia chips, specify inferentia.

      • For instance types with NVIDIA GRID K520 GPUs, specify k520.

      • For instance types with NVIDIA K80 GPUs, specify k80.

      • For instance types with NVIDIA M60 GPUs, specify m60.

      • For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.

      • For instance types with NVIDIA T4 GPUs, specify t4.

      • For instance types with NVIDIA T4G GPUs, specify t4g.

      • For instance types with Xilinx VU9P FPGAs, specify vu9p.

      • For instance types with NVIDIA V100 GPUs, specify v100.

      Default: Any accelerator

      • (string) –

    • AcceleratorTotalMemoryMiB (dict) –

      The minimum and maximum amount of total accelerator memory, in MiB.

      Default: No minimum or maximum limits

      • Min (integer) –

        The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.

      • Max (integer) –

        The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.

    • NetworkBandwidthGbps (dict) –

      The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see Amazon EC2 instance network bandwidth in the Amazon EC2 User Guide.

      Default: No minimum or maximum limits

      • Min (float) –

        The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.

      • Max (float) –

        The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.

    • AllowedInstanceTypes (list) –

      The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.

      You can use strings with one or more wild cards, represented by an asterisk ( *), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

      For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.

      Note

      If you specify AllowedInstanceTypes, you can’t specify ExcludedInstanceTypes.

      Default: All instance types

      • (string) –

    • MaxSpotPriceAsPercentageOfOptimalOnDemandPrice (integer) –

      [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.

      The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

      If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.

      Note

      Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.

    • BaselinePerformanceFactors (dict) –

      The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the Amazon EC2 User Guide.

      • Cpu (dict) –

        The CPU performance to consider, using an instance family as the baseline reference.

        • References (list) –

          Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences.

          Note

          Currently, only one instance family can be specified in the list.

          • (dict) –

            Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture.

            Note

            Currently, only one instance family can be specified in the list.

            • InstanceFamily (string) –

              The instance family to use as a baseline reference.

              Note

              Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( .) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.

              The following instance families are not supported for performance protection:

              • c1

              • g3 | g3s

              • hpc7g

              • m1 | m2

              • mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro

              • p3dn | p4d | p5

              • t1

              • u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb

              If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.

              If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for and an exception for , , , and .

• DryRun (boolean) – 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'SpotPlacementScores': [
        {
            'Region': 'string',
            'AvailabilityZoneId': 'string',
            'Score': 123
        },
    ],

}

Response Structure

• (dict) –

  • SpotPlacementScores (list) –

    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.

• (dict) –

  The Spot placement score for this Region or Availability Zone. The score is calculated based on the assumption that the capacity-optimized allocation strategy is used and that all of the Availability Zones in the Region can be used.

  • Region (string) –

    The Region.

  • AvailabilityZoneId (string) –

    The Availability Zone.

  • Score (integer) –

    The placement score, on a scale from 1 to 10. A score of 10 indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of 1 indicates that your Spot request is not likely to succeed.