EC2 / Waiter / SpotInstanceRequestFulfilled

SpotInstanceRequestFulfilled#

class EC2.Waiter.SpotInstanceRequestFulfilled#

waiter = client.get_waiter('spot_instance_request_fulfilled')

wait(**kwargs)#

Polls EC2.Client.describe_spot_instance_requests() every 15 seconds until a successful state is reached. An error is raised after 40 failed checks.

Request Syntax

waiter.wait(
    NextToken='string',
    MaxResults=123,
    DryRun=True|False,
    SpotInstanceRequestIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults (integer) – The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
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.
SpotInstanceRequestIds (list) –
The IDs of the Spot Instance requests.
- (string) –
Filters (list) –
The filters.
- availability-zone-group - The Availability Zone group.
- create-time - The time stamp when the Spot Instance request was created.
- fault-code - The fault code related to the request.
- fault-message - The fault message related to the request.
- instance-id - The ID of the instance that fulfilled the request.
- launch-group - The Spot Instance launch group.
- launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
- launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
- launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
- launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
- launch.block-device-mapping.volume-type - The type of EBS volume: gp2 or gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic.
- launch.group-id - The ID of the security group for the instance.
- launch.group-name - The name of the security group for the instance.
- launch.image-id - The ID of the AMI.
- launch.instance-type - The type of instance (for example, m3.medium).
- launch.kernel-id - The kernel ID.
- launch.key-name - The name of the key pair the instance launched with.
- launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.
- launch.ramdisk-id - The RAM disk ID.
- launched-availability-zone - The Availability Zone in which the request is launched.
- network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
- network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
- network-interface.description - A description of the network interface.
- network-interface.device-index - The index of the device for the network interface attachment on the instance.
- network-interface.group-id - The ID of the security group associated with the network interface.
- network-interface.network-interface-id - The ID of the network interface.
- network-interface.private-ip-address - The primary private IP address of the network interface.
- network-interface.subnet-id - The ID of the subnet for the instance.
- product-description - The product description associated with the instance ( Linux/UNIX | Windows).
- spot-instance-request-id - The Spot Instance request ID.
- spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
- state - The state of the Spot Instance request ( open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide.
- status-code - The short code describing the most recent evaluation of your Spot Instance request.
- status-message - The message explaining the status of the Spot Instance request.
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- type - The type of Spot Instance request ( one-time | persistent).
- valid-from - The start date of the request.
- valid-until - The end date of the request.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  
  The amount of time in seconds to wait between attempts. Default: 15
- MaxAttempts (integer) –
  
  The maximum number of attempts to be made. Default: 40

Returns:

None