EC2 / Client / modify_fleet

modify_fleet#

EC2.Client.modify_fleet(**kwargs)#

Modifies the specified EC2 Fleet.

You can only modify an EC2 Fleet request of type maintain.

While the EC2 Fleet is being modified, it is in the modifying state.

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.

See also: AWS API Documentation

Request Syntax

response = client.modify_fleet(
    DryRun=True|False,
    ExcessCapacityTerminationPolicy='no-termination'|'termination',
    LaunchTemplateConfigs=[
        {
            'LaunchTemplateSpecification': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': 'string'
            },
            'Overrides': [
                {
                    'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge',
                    'MaxPrice': 'string',
                    'SubnetId': 'string',
                    'AvailabilityZone': 'string',
                    'WeightedCapacity': 123.0,
                    'Priority': 123.0,
                    'Placement': {
                        'AvailabilityZone': 'string',
                        'Affinity': 'string',
                        'GroupName': 'string',
                        'PartitionNumber': 123,
                        'HostId': 'string',
                        'Tenancy': 'default'|'dedicated'|'host',
                        'SpreadDomain': 'string',
                        'HostResourceGroupArn': 'string',
                        'GroupId': 'string'
                    },
                    'InstanceRequirements': {
                        'VCpuCount': {
                            'Min': 123,
                            'Max': 123
                        },
                        'MemoryMiB': {
                            'Min': 123,
                            'Max': 123
                        },
                        'CpuManufacturers': [
                            'intel'|'amd'|'amazon-web-services',
                        ],
                        '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': [
                            'nvidia'|'amd'|'amazon-web-services'|'xilinx',
                        ],
                        'AcceleratorNames': [
                            'a100'|'v100'|'k80'|'t4'|'m60'|'radeon-pro-v520'|'vu9p'|'inferentia'|'k520',
                        ],
                        'AcceleratorTotalMemoryMiB': {
                            'Min': 123,
                            'Max': 123
                        },
                        'NetworkBandwidthGbps': {
                            'Min': 123.0,
                            'Max': 123.0
                        },
                        'AllowedInstanceTypes': [
                            'string',
                        ]
                    },
                    'ImageId': 'string'
                },
            ]
        },
    ],
    FleetId='string',
    TargetCapacitySpecification={
        'TotalTargetCapacity': 123,
        'OnDemandTargetCapacity': 123,
        'SpotTargetCapacity': 123,
        'DefaultTargetCapacityType': 'spot'|'on-demand',
        'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units'
    },
    Context='string'
)
Parameters:

  • 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.

  • ExcessCapacityTerminationPolicy (string) –

    Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

    Supported only for fleets of type maintain.

  • LaunchTemplateConfigs (list) –

    The launch template and overrides.

    • (dict) –

      Describes a launch template and overrides.

      • LaunchTemplateSpecification (dict) –

        The launch template to use. You must specify either the launch template ID or launch template name in the request.

        • LaunchTemplateId (string) –

          The ID of the launch template.

          You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.

        • LaunchTemplateName (string) –

          The name of the launch template.

          You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.

        • Version (string) –

          The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

          If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

          If the value is $Default, Amazon EC2 uses the default version of the launch template.

      • Overrides (list) –

        Any parameters that you specify override the same parameters in the launch template.

        For fleets of type request and maintain, a maximum of 300 items is allowed across all launch templates.

        • (dict) –

          Describes overrides for a launch template.

          • InstanceType (string) –

            The instance type.

            mac1.metal is not supported as a launch template override.

            Note

            If you specify InstanceType, you can’t specify InstanceRequirements.

          • MaxPrice (string) –

            The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

            Warning

            If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

          • SubnetId (string) –

            The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.

          • AvailabilityZone (string) –

            The Availability Zone in which to launch the instances.

          • WeightedCapacity (float) –

            The number of units provided by the specified instance type.

          • Priority (float) –

            The priority for the launch template override. The highest priority is launched first.

            If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

            If the Spot AllocationStrategy is set to capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

            Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.

          • Placement (dict) –

            The location where the instance launched, if applicable.

            • AvailabilityZone (string) –

              The Availability Zone of the instance.

              If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

              This parameter is not supported for CreateFleet.

            • Affinity (string) –

              The affinity setting for the instance on the Dedicated Host.

              This parameter is not supported for CreateFleet or ImportInstance.

            • GroupName (string) –

              The name of the placement group that the instance is in. If you specify GroupName, you can’t specify GroupId.

            • PartitionNumber (integer) –

              The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.

              This parameter is not supported for CreateFleet.

            • HostId (string) –

              The ID of the Dedicated Host on which the instance resides.

              This parameter is not supported for CreateFleet or ImportInstance.

            • Tenancy (string) –

              The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

              This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

            • SpreadDomain (string) –

              Reserved for future use.

            • HostResourceGroupArn (string) –

              The ARN of the host resource group in which to launch the instances.

              If you specify this parameter, either omit the Tenancy parameter or set it to host.

              This parameter is not supported for CreateFleet.

            • GroupId (string) –

              The ID of the placement group that the instance is in. If you specify GroupId, you can’t specify GroupName.

          • InstanceRequirements (dict) –

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

            Note

            If you specify InstanceRequirements, you can’t specify InstanceType.

            • 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.

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

              The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

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

              To turn off price protection, 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: 100

            • OnDemandMaxPricePercentageOverLowestPrice (integer) –

              The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

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

              To turn off price protection, 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.

              • To include instance types with inference hardware, specify inference.

              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 NVIDIA devices, specify nvidia.

              • For instance types with AMD devices, specify amd.

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

              • 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 A100 GPUs, specify a100.

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

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

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

              • 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 Xilinx VU9P FPGAs, specify vu9p.

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

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

              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 network bandwidth, in gigabits per second (Gbps).

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

          • ImageId (string) –

            The ID of the AMI. An AMI is required to launch an instance. The AMI ID must be specified here or in the launch template.

  • FleetId (string) –

    [REQUIRED]

    The ID of the EC2 Fleet.

  • TargetCapacitySpecification (dict) –

    The size of the EC2 Fleet.

    • TotalTargetCapacity (integer) – [REQUIRED]

      The number of units to request, filled using DefaultTargetCapacityType.

    • OnDemandTargetCapacity (integer) –

      The number of On-Demand units to request.

    • SpotTargetCapacity (integer) –

      The number of Spot units to request.

    • DefaultTargetCapacityType (string) –

      The default TotalTargetCapacity, which is either Spot or On-Demand.

    • TargetCapacityUnitType (string) –

      The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

      Default: units (translates to number of instances)

  • Context (string) – Reserved.

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

  • (dict) –

    • Return (boolean) –

      If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.