2017/01/26 - Amazon Elastic Compute Cloud - 3 updated api methods
Changes Adds instance health check functionality to replace unhealthy EC2 Spot fleet instances with fresh ones
{'ActiveInstances': {'InstanceHealth': 'healthy | unhealthy'}}
Describes the running instances for the specified Spot fleet.
See also: AWS API Documentation
Request Syntax
client.describe_spot_fleet_instances(
DryRun=True|False,
SpotFleetRequestId='string',
NextToken='string',
MaxResults=123
)
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 .
string
[REQUIRED]
The ID of the Spot fleet request.
string
The token for the next set of results.
integer
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.
dict
Response Syntax
{
'SpotFleetRequestId': 'string',
'ActiveInstances': [
{
'InstanceType': 'string',
'InstanceId': 'string',
'SpotInstanceRequestId': 'string',
'InstanceHealth': 'healthy'|'unhealthy'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeSpotFleetInstances.
SpotFleetRequestId (string) --
The ID of the Spot fleet request.
ActiveInstances (list) --
The running instances. Note that this list is refreshed periodically and might be out of date.
(dict) --
Describes a running instance in a Spot fleet.
InstanceType (string) --
The instance type.
InstanceId (string) --
The ID of the instance.
SpotInstanceRequestId (string) --
The ID of the Spot instance request.
InstanceHealth (string) --
The health status of the instance. If the status of both the instance status check and the system status check is impaired , the health status of the instance is unhealthy . Otherwise, the health status is healthy .
NextToken (string) --
The token required to retrieve the next set of results. This value is null when there are no more results to return.
{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'ReplaceUnhealthyInstances': 'boolean'}}}
Describes your Spot fleet requests.
Spot fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
See also: AWS API Documentation
Request Syntax
client.describe_spot_fleet_requests(
DryRun=True|False,
SpotFleetRequestIds=[
'string',
],
NextToken='string',
MaxResults=123
)
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 .
list
The IDs of the Spot fleet requests.
(string) --
string
The token for the next set of results.
integer
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.
dict
Response Syntax
{
'SpotFleetRequestConfigs': [
{
'SpotFleetRequestId': 'string',
'SpotFleetRequestState': 'submitted'|'active'|'cancelled'|'failed'|'cancelled_running'|'cancelled_terminating'|'modifying',
'SpotFleetRequestConfig': {
'ClientToken': 'string',
'SpotPrice': 'string',
'TargetCapacity': 123,
'ValidFrom': datetime(2015, 1, 1),
'ValidUntil': datetime(2015, 1, 1),
'TerminateInstancesWithExpiration': True|False,
'IamFleetRole': 'string',
'LaunchSpecifications': [
{
'ImageId': 'string',
'KeyName': 'string',
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'UserData': 'string',
'AddressingType': 'string',
'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
'Placement': {
'AvailabilityZone': 'string',
'GroupName': 'string',
'Tenancy': 'default'|'dedicated'|'host'
},
'KernelId': 'string',
'RamdiskId': 'string',
'BlockDeviceMappings': [
{
'VirtualName': 'string',
'DeviceName': 'string',
'Ebs': {
'SnapshotId': 'string',
'VolumeSize': 123,
'DeleteOnTermination': True|False,
'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1',
'Iops': 123,
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'Monitoring': {
'Enabled': True|False
},
'SubnetId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'DeviceIndex': 123,
'SubnetId': 'string',
'Description': 'string',
'PrivateIpAddress': 'string',
'Groups': [
'string',
],
'DeleteOnTermination': True|False,
'PrivateIpAddresses': [
{
'PrivateIpAddress': 'string',
'Primary': True|False
},
],
'SecondaryPrivateIpAddressCount': 123,
'AssociatePublicIpAddress': True|False,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'Ipv6AddressCount': 123
},
],
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'EbsOptimized': True|False,
'WeightedCapacity': 123.0,
'SpotPrice': 'string'
},
],
'ExcessCapacityTerminationPolicy': 'noTermination'|'default',
'AllocationStrategy': 'lowestPrice'|'diversified',
'FulfilledCapacity': 123.0,
'Type': 'request'|'maintain',
'ReplaceUnhealthyInstances': True|False
},
'CreateTime': datetime(2015, 1, 1),
'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeSpotFleetRequests.
SpotFleetRequestConfigs (list) --
Information about the configuration of your Spot fleet.
(dict) --
Describes a Spot fleet request.
SpotFleetRequestId (string) --
The ID of the Spot fleet request.
SpotFleetRequestState (string) --
The state of the Spot fleet request.
SpotFleetRequestConfig (dict) --
Information about the configuration of the Spot fleet request.
ClientToken (string) --
A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
SpotPrice (string) --
The bid price per unit hour.
TargetCapacity (integer) --
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.
ValidFrom (datetime) --
The start date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The default is to start fulfilling the request immediately.
ValidUntil (datetime) --
The end date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). At this point, no new Spot instance requests are placed or enabled to fulfill the request.
TerminateInstancesWithExpiration (boolean) --
Indicates whether running Spot instances should be terminated when the Spot fleet request expires.
IamFleetRole (string) --
Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration .
LaunchSpecifications (list) --
Information about the launch specifications for the Spot fleet request.
(dict) --
Describes the launch specification for one or more Spot instances.
ImageId (string) --
The ID of the AMI.
KeyName (string) --
The name of the key pair.
SecurityGroups (list) --
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
UserData (string) --
The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
AddressingType (string) --
Deprecated.
InstanceType (string) --
The instance type. Note that T2 and HS1 instance types are not supported.
Placement (dict) --
The placement information.
AvailabilityZone (string) --
The Availability Zone.
[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
GroupName (string) --
The name of the placement group (for cluster instances).
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot instances.
KernelId (string) --
The ID of the kernel.
RamdiskId (string) --
The ID of the RAM disk.
BlockDeviceMappings (list) --
One or more block device mapping entries.
(dict) --
Describes a block device mapping.
VirtualName (string) --
The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
DeviceName (string) --
The device name exposed to the instance (for example, /dev/sdh or xvdh ).
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiB.
Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
VolumeType (string) --
The volume type: gp2 , io1 , st1 , sc1 , or standard .
Default: standard
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
Encrypted (boolean) --
Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
NoDevice (string) --
Suppresses the specified device included in the block device mapping of the AMI.
Monitoring (dict) --
Enable or disable monitoring for the instances.
Enabled (boolean) --
Enables monitoring for the instance.
Default: false
SubnetId (string) --
The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-a61dafcf, subnet-65ea5f08".
NetworkInterfaces (list) --
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The ID of the network interface.
DeviceIndex (integer) --
The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
SubnetId (string) --
The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
Description (string) --
The description of the network interface. Applies only if creating a network interface when launching an instance.
PrivateIpAddress (string) --
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
Groups (list) --
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
(string) --
DeleteOnTermination (boolean) --
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
PrivateIpAddresses (list) --
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
(dict) --
Describes a secondary private IPv4 address for a network interface.
PrivateIpAddress (string) --
The private IPv4 addresses.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
AssociatePublicIpAddress (boolean) --
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
Ipv6Addresses (list) --
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
Ipv6AddressCount (integer) --
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
EbsOptimized (boolean) --
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
WeightedCapacity (float) --
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).
If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.
SpotPrice (string) --
The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity .
ExcessCapacityTerminationPolicy (string) --
Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.
AllocationStrategy (string) --
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice .
FulfilledCapacity (float) --
The number of units fulfilled by this request compared to the set target capacity.
Type (string) --
The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain .
ReplaceUnhealthyInstances (boolean) --
Indicates whether Spot fleet should replace unhealthy instances.
CreateTime (datetime) --
The creation date and time of the request.
ActivityStatus (string) --
The progress of the Spot fleet request. If there is an error, the status is error . After all bids are placed, the status is pending_fulfillment . If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled . If the size of the fleet is decreased, the status is pending_termination while Spot instances are terminating.
NextToken (string) --
The token required to retrieve the next set of results. This value is null when there are no more results to return.
{'SpotFleetRequestConfig': {'ReplaceUnhealthyInstances': 'boolean'}}
Creates a Spot fleet request.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.
For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
client.request_spot_fleet(
DryRun=True|False,
SpotFleetRequestConfig={
'ClientToken': 'string',
'SpotPrice': 'string',
'TargetCapacity': 123,
'ValidFrom': datetime(2015, 1, 1),
'ValidUntil': datetime(2015, 1, 1),
'TerminateInstancesWithExpiration': True|False,
'IamFleetRole': 'string',
'LaunchSpecifications': [
{
'ImageId': 'string',
'KeyName': 'string',
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'UserData': 'string',
'AddressingType': 'string',
'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
'Placement': {
'AvailabilityZone': 'string',
'GroupName': 'string',
'Tenancy': 'default'|'dedicated'|'host'
},
'KernelId': 'string',
'RamdiskId': 'string',
'BlockDeviceMappings': [
{
'VirtualName': 'string',
'DeviceName': 'string',
'Ebs': {
'SnapshotId': 'string',
'VolumeSize': 123,
'DeleteOnTermination': True|False,
'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1',
'Iops': 123,
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'Monitoring': {
'Enabled': True|False
},
'SubnetId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'DeviceIndex': 123,
'SubnetId': 'string',
'Description': 'string',
'PrivateIpAddress': 'string',
'Groups': [
'string',
],
'DeleteOnTermination': True|False,
'PrivateIpAddresses': [
{
'PrivateIpAddress': 'string',
'Primary': True|False
},
],
'SecondaryPrivateIpAddressCount': 123,
'AssociatePublicIpAddress': True|False,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'Ipv6AddressCount': 123
},
],
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'EbsOptimized': True|False,
'WeightedCapacity': 123.0,
'SpotPrice': 'string'
},
],
'ExcessCapacityTerminationPolicy': 'noTermination'|'default',
'AllocationStrategy': 'lowestPrice'|'diversified',
'FulfilledCapacity': 123.0,
'Type': 'request'|'maintain',
'ReplaceUnhealthyInstances': True|False
}
)
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 .
dict
[REQUIRED]
The configuration for the Spot fleet request.
ClientToken (string) --
A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
SpotPrice (string) -- [REQUIRED]
The bid price per unit hour.
TargetCapacity (integer) -- [REQUIRED]
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.
ValidFrom (datetime) --
The start date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The default is to start fulfilling the request immediately.
ValidUntil (datetime) --
The end date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). At this point, no new Spot instance requests are placed or enabled to fulfill the request.
TerminateInstancesWithExpiration (boolean) --
Indicates whether running Spot instances should be terminated when the Spot fleet request expires.
IamFleetRole (string) -- [REQUIRED]
Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration .
LaunchSpecifications (list) -- [REQUIRED]
Information about the launch specifications for the Spot fleet request.
(dict) --
Describes the launch specification for one or more Spot instances.
ImageId (string) --
The ID of the AMI.
KeyName (string) --
The name of the key pair.
SecurityGroups (list) --
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
UserData (string) --
The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
AddressingType (string) --
Deprecated.
InstanceType (string) --
The instance type. Note that T2 and HS1 instance types are not supported.
Placement (dict) --
The placement information.
AvailabilityZone (string) --
The Availability Zone.
[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
GroupName (string) --
The name of the placement group (for cluster instances).
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot instances.
KernelId (string) --
The ID of the kernel.
RamdiskId (string) --
The ID of the RAM disk.
BlockDeviceMappings (list) --
One or more block device mapping entries.
(dict) --
Describes a block device mapping.
VirtualName (string) --
The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
DeviceName (string) --
The device name exposed to the instance (for example, /dev/sdh or xvdh ).
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiB.
Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
VolumeType (string) --
The volume type: gp2 , io1 , st1 , sc1 , or standard .
Default: standard
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
Encrypted (boolean) --
Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
NoDevice (string) --
Suppresses the specified device included in the block device mapping of the AMI.
Monitoring (dict) --
Enable or disable monitoring for the instances.
Enabled (boolean) --
Enables monitoring for the instance.
Default: false
SubnetId (string) --
The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-a61dafcf, subnet-65ea5f08".
NetworkInterfaces (list) --
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The ID of the network interface.
DeviceIndex (integer) --
The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
SubnetId (string) --
The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
Description (string) --
The description of the network interface. Applies only if creating a network interface when launching an instance.
PrivateIpAddress (string) --
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
Groups (list) --
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
(string) --
DeleteOnTermination (boolean) --
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
PrivateIpAddresses (list) --
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
(dict) --
Describes a secondary private IPv4 address for a network interface.
PrivateIpAddress (string) -- [REQUIRED]
The private IPv4 addresses.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
AssociatePublicIpAddress (boolean) --
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
Ipv6Addresses (list) --
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
Ipv6AddressCount (integer) --
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
EbsOptimized (boolean) --
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
WeightedCapacity (float) --
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).
If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.
SpotPrice (string) --
The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity .
ExcessCapacityTerminationPolicy (string) --
Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.
AllocationStrategy (string) --
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice .
FulfilledCapacity (float) --
The number of units fulfilled by this request compared to the set target capacity.
Type (string) --
The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain .
ReplaceUnhealthyInstances (boolean) --
Indicates whether Spot fleet should replace unhealthy instances.
dict
Response Syntax
{
'SpotFleetRequestId': 'string'
}
Response Structure
(dict) --
Contains the output of RequestSpotFleet.
SpotFleetRequestId (string) --
The ID of the Spot fleet request.