Amazon Elastic Compute Cloud

2016/08/18 - Amazon Elastic Compute Cloud - 4 new1 updated api methods

Changes  Update ec2 client to latest version

DescribeHostReservations (new) Link ¶

Describes Dedicated Host Reservations which are associated with Dedicated Hosts in your account.

Request Syntax

client.describe_host_reservations(
    HostReservationIdSet=[
        'string',
    ],
    Filter=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
type HostReservationIdSet:

list

param HostReservationIdSet:

One or more host reservation IDs.

  • (string) --

type Filter:

list

param Filter:

One or more filters.

  • instance-family - The instance family (e.g., m4).

  • payment-option - The payment option ( No Upfront | Partial Upfront | All Upfront).

  • state - The state of the reservation ( payment-pending | payment-failed | active | retired).

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      One or more filter values. Filter values are case-sensitive.

      • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'HostReservationSet': [
        {
            'HostReservationId': 'string',
            'HostIdSet': [
                'string',
            ],
            'OfferingId': 'string',
            'InstanceFamily': 'string',
            'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
            'HourlyPrice': 'string',
            'UpfrontPrice': 'string',
            'CurrencyCode': 'USD',
            'Count': 123,
            'Duration': 123,
            'End': datetime(2015, 1, 1),
            'Start': datetime(2015, 1, 1),
            'State': 'payment-pending'|'payment-failed'|'active'|'retired'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • HostReservationSet (list) --

      Details about the reservation's configuration.

      • (dict) --

        Details about the Dedicated Host Reservation and associated Dedicated Hosts.

        • HostReservationId (string) --

          The ID of the reservation that specifies the associated Dedicated Hosts.

        • HostIdSet (list) --

          The IDs of the Dedicated Hosts associated with the reservation.

          • (string) --

        • OfferingId (string) --

          The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.

        • InstanceFamily (string) --

          The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.

        • PaymentOption (string) --

          The payment option selected for this reservation.

        • HourlyPrice (string) --

          The hourly price of the reservation.

        • UpfrontPrice (string) --

          The upfront price of the reservation.

        • CurrencyCode (string) --

          The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.

        • Count (integer) --

          The number of Dedicated Hosts the reservation is associated with.

        • Duration (integer) --

          The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years) | 157680000 (5 years).

        • End (datetime) --

          The date and time that the reservation ends.

        • Start (datetime) --

          The date and time that the reservation started.

        • State (string) --

          The state of the reservation.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeHostReservationOfferings (new) Link ¶

Describes the Dedicated Host Reservations that are available to purchase.

The results describe all the Dedicated Host Reservation offerings, including offerings that may not match the instance family and region of your Dedicated Hosts. When purchasing an offering, ensure that the the instance family and region of the offering matches that of the Dedicated Host/s it will be associated with. For an overview of supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.

Request Syntax

client.describe_host_reservation_offerings(
    OfferingId='string',
    MinDuration=123,
    MaxDuration=123,
    Filter=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
type OfferingId:

string

param OfferingId:

The ID of the reservation offering.

type MinDuration:

integer

param MinDuration:

This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in 1, 3, and 5 year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1, 3, or 5). For example, specify 94608000 for 3 years.

type MaxDuration:

integer

param MaxDuration:

This is the maximum duration of the reservation you'd like to purchase, specified in seconds.Reservations are available in 1, 3, and 5 year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1, 3, or 5). For example, specify 157680000 for 5 years.

type Filter:

list

param Filter:

One or more filters.

  • instance-family - The instance family of the offering (e.g., m4).

  • payment-option - The payment option ( No Upfront | Partial Upfront | All Upfront).

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      One or more filter values. Filter values are case-sensitive.

      • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'OfferingSet': [
        {
            'OfferingId': 'string',
            'InstanceFamily': 'string',
            'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
            'UpfrontPrice': 'string',
            'HourlyPrice': 'string',
            'CurrencyCode': 'USD',
            'Duration': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • OfferingSet (list) --

      Information about the offerings.

      • (dict) --

        Details about the Dedicated Host Reservation offering.

        • OfferingId (string) --

          The ID of the offering.

        • InstanceFamily (string) --

          The instance family that the offering covers.

        • PaymentOption (string) --

          The available payment option.

        • UpfrontPrice (string) --

          The upfront price of the offering. Does not apply to No Upfront offerings.

        • HourlyPrice (string) --

          The hourly price of the offering.

        • CurrencyCode (string) --

          The currency of the offering.

        • Duration (integer) --

          The duration of the offering (in seconds).

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

PurchaseHostReservation (new) Link ¶

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

Request Syntax

client.purchase_host_reservation(
    OfferingId='string',
    HostIdSet=[
        'string',
    ],
    LimitPrice='string',
    CurrencyCode='USD',
    ClientToken='string'
)
type OfferingId:

string

param OfferingId:

[REQUIRED]

The ID of the offering.

type HostIdSet:

list

param HostIdSet:

[REQUIRED]

The ID/s of the Dedicated Host/s that the reservation will be associated with.

  • (string) --

type LimitPrice:

string

param LimitPrice:

The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request will fail. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

type CurrencyCode:

string

param CurrencyCode:

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

type ClientToken:

string

param ClientToken:

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

rtype:

dict

returns:

Response Syntax

{
    'Purchase': [
        {
            'HostReservationId': 'string',
            'HostIdSet': [
                'string',
            ],
            'InstanceFamily': 'string',
            'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
            'UpfrontPrice': 'string',
            'HourlyPrice': 'string',
            'CurrencyCode': 'USD',
            'Duration': 123
        },
    ],
    'TotalUpfrontPrice': 'string',
    'TotalHourlyPrice': 'string',
    'CurrencyCode': 'USD',
    'ClientToken': 'string'
}

Response Structure

  • (dict) --

    • Purchase (list) --

      Describes the details of the purchase.

      • (dict) --

        Describes the result of the purchase.

        • HostReservationId (string) --

          The ID of the reservation.

        • HostIdSet (list) --

          The IDs of the Dedicated Hosts associated with the reservation.

          • (string) --

        • InstanceFamily (string) --

          The instance family on the Dedicated Host that the reservation can be associated with.

        • PaymentOption (string) --

          The payment option for the reservation.

        • UpfrontPrice (string) --

          The upfront price of the reservation.

        • HourlyPrice (string) --

          The hourly price of the reservation per hour.

        • CurrencyCode (string) --

          The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.

        • Duration (integer) --

          The duration of the reservation's term in seconds.

    • TotalUpfrontPrice (string) --

      The total amount that will be charged to your account when you purchase the reservation.

    • TotalHourlyPrice (string) --

      The total hourly price of the reservation calculated per hour.

    • CurrencyCode (string) --

      The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

    • ClientToken (string) --

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide

GetHostReservationPurchasePreview (new) Link ¶

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

Request Syntax

client.get_host_reservation_purchase_preview(
    OfferingId='string',
    HostIdSet=[
        'string',
    ]
)
type OfferingId:

string

param OfferingId:

[REQUIRED]

The offering ID of the reservation.

type HostIdSet:

list

param HostIdSet:

[REQUIRED]

The ID/s of the Dedicated Host/s that the reservation will be associated with.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Purchase': [
        {
            'HostReservationId': 'string',
            'HostIdSet': [
                'string',
            ],
            'InstanceFamily': 'string',
            'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
            'UpfrontPrice': 'string',
            'HourlyPrice': 'string',
            'CurrencyCode': 'USD',
            'Duration': 123
        },
    ],
    'TotalUpfrontPrice': 'string',
    'TotalHourlyPrice': 'string',
    'CurrencyCode': 'USD'
}

Response Structure

  • (dict) --

    • Purchase (list) --

      The purchase information of the Dedicated Host Reservation and the Dedicated Hosts associated with it.

      • (dict) --

        Describes the result of the purchase.

        • HostReservationId (string) --

          The ID of the reservation.

        • HostIdSet (list) --

          The IDs of the Dedicated Hosts associated with the reservation.

          • (string) --

        • InstanceFamily (string) --

          The instance family on the Dedicated Host that the reservation can be associated with.

        • PaymentOption (string) --

          The payment option for the reservation.

        • UpfrontPrice (string) --

          The upfront price of the reservation.

        • HourlyPrice (string) --

          The hourly price of the reservation per hour.

        • CurrencyCode (string) --

          The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.

        • Duration (integer) --

          The duration of the reservation's term in seconds.

    • TotalUpfrontPrice (string) --

      The potential total upfront price. This is billed immediately.

    • TotalHourlyPrice (string) --

      The potential total hourly price of the reservation per hour.

    • CurrencyCode (string) --

      The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

DescribeSpotFleetRequests (updated) Link ¶
Changes (response)
{'SpotFleetRequestConfigs': {'ActivityStatus': 'error | pending_fulfillment | '
                                               'pending_termination | '
                                               'fulfilled'}}

Describes your Spot fleet requests.

Request Syntax

client.describe_spot_fleet_requests(
    DryRun=True|False,
    SpotFleetRequestIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
type DryRun:

boolean

param DryRun:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

type SpotFleetRequestIds:

list

param SpotFleetRequestIds:

The IDs of the Spot fleet requests.

  • (string) --

type NextToken:

string

param NextToken:

The token for the next set of results.

type MaxResults:

integer

param MaxResults:

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

rtype:

dict

returns:

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'|'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'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'x1.4xlarge'|'x1.8xlarge'|'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'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge',
                        'Placement': {
                            'AvailabilityZone': 'string',
                            'GroupName': 'string'
                        },
                        '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
                            },
                        ],
                        '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'
            },
            '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.

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

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

                • (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 IP address of the network interface. Applies only if creating a network interface when launching an instance.

                  • 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 IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

                    • (dict) --

                      Describes a secondary private IP address for a network interface.

                      • PrivateIpAddress (string) --

                        The private IP addresses.

                      • Primary (boolean) --

                        Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

                  • SecondaryPrivateIpAddressCount (integer) --

                    The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

                  • AssociatePublicIpAddress (boolean) --

                    Indicates whether to assign a public IP 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.

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

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