amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeSpotInstanceRequests

Description

Describes the specified Spot Instance requests.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.

Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeSpotInstanceRequests Source #

Contains the parameters for DescribeSpotInstanceRequests.

See: newDescribeSpotInstanceRequests smart constructor.

Constructors

DescribeSpotInstanceRequests' 

Fields

  • dryRun :: Maybe Bool

    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.

  • filters :: Maybe [Filter]

    One or more 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 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for 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 for Linux Instances.
    • 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.
  • maxResults :: Maybe Int

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

  • nextToken :: Maybe Text

    The token to request the next set of results. This value is null when there are no more results to return.

  • spotInstanceRequestIds :: Maybe [Text]

    One or more Spot Instance request IDs.

Instances

Instances details
ToHeaders DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

toHeaders :: DescribeSpotInstanceRequests -> [Header] #

ToPath DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

toPath :: DescribeSpotInstanceRequests -> ByteString #

ToQuery DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

toQuery :: DescribeSpotInstanceRequests -> QueryString #

AWSPager DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

page :: DescribeSpotInstanceRequests -> AWSResponse DescribeSpotInstanceRequests -> Maybe DescribeSpotInstanceRequests #

AWSRequest DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Associated Types

type AWSResponse DescribeSpotInstanceRequests #

Methods

request :: (Service -> Service) -> DescribeSpotInstanceRequests -> Request DescribeSpotInstanceRequests #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSpotInstanceRequests -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSpotInstanceRequests))) #

Generic DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Associated Types

type Rep DescribeSpotInstanceRequests :: Type -> Type #

Methods

from :: DescribeSpotInstanceRequests -> Rep DescribeSpotInstanceRequests x #

to :: Rep DescribeSpotInstanceRequests x -> DescribeSpotInstanceRequests #

Read DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

readsPrec :: Int -> ReadS DescribeSpotInstanceRequests #

readList :: ReadS [DescribeSpotInstanceRequests] #

readPrec :: ReadPrec DescribeSpotInstanceRequests #

readListPrec :: ReadPrec [DescribeSpotInstanceRequests] #

Show DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

showsPrec :: Int -> DescribeSpotInstanceRequests -> ShowS #

show :: DescribeSpotInstanceRequests -> String #

showList :: [DescribeSpotInstanceRequests] -> ShowS #

NFData DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

rnf :: DescribeSpotInstanceRequests -> () #

Eq DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

(==) :: DescribeSpotInstanceRequests -> DescribeSpotInstanceRequests -> Bool #

(/=) :: DescribeSpotInstanceRequests -> DescribeSpotInstanceRequests -> Bool #

Hashable DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

hashWithSalt :: Int -> DescribeSpotInstanceRequests -> Int #

hash :: DescribeSpotInstanceRequests -> Int #

type AWSResponse DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

type AWSResponse DescribeSpotInstanceRequests = DescribeSpotInstanceRequestsResponse
type Rep DescribeSpotInstanceRequests Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

type Rep DescribeSpotInstanceRequests = D1 ('MetaData "DescribeSpotInstanceRequests" "Amazonka.EC2.DescribeSpotInstanceRequests" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSpotInstanceRequests'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "spotInstanceRequestIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeSpotInstanceRequests :: DescribeSpotInstanceRequests Source #

Create a value of DescribeSpotInstanceRequests with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeSpotInstanceRequests', describeSpotInstanceRequests_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.

$sel:filters:DescribeSpotInstanceRequests', describeSpotInstanceRequests_filters - One or more 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 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for 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 for Linux Instances.
  • 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.

$sel:maxResults:DescribeSpotInstanceRequests', describeSpotInstanceRequests_maxResults - The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

DescribeSpotInstanceRequests, describeSpotInstanceRequests_nextToken - The token to request the next set of results. This value is null when there are no more results to return.

$sel:spotInstanceRequestIds:DescribeSpotInstanceRequests', describeSpotInstanceRequests_spotInstanceRequestIds - One or more Spot Instance request IDs.

Request Lenses

describeSpotInstanceRequests_dryRun :: Lens' DescribeSpotInstanceRequests (Maybe Bool) Source #

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.

describeSpotInstanceRequests_filters :: Lens' DescribeSpotInstanceRequests (Maybe [Filter]) Source #

One or more 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 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for 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 for Linux Instances.
  • 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.

describeSpotInstanceRequests_maxResults :: Lens' DescribeSpotInstanceRequests (Maybe Int) Source #

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

describeSpotInstanceRequests_nextToken :: Lens' DescribeSpotInstanceRequests (Maybe Text) Source #

The token to request the next set of results. This value is null when there are no more results to return.

describeSpotInstanceRequests_spotInstanceRequestIds :: Lens' DescribeSpotInstanceRequests (Maybe [Text]) Source #

One or more Spot Instance request IDs.

Destructuring the Response

data DescribeSpotInstanceRequestsResponse Source #

Contains the output of DescribeSpotInstanceRequests.

See: newDescribeSpotInstanceRequestsResponse smart constructor.

Constructors

DescribeSpotInstanceRequestsResponse' 

Fields

Instances

Instances details
Generic DescribeSpotInstanceRequestsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Associated Types

type Rep DescribeSpotInstanceRequestsResponse :: Type -> Type #

Methods

from :: DescribeSpotInstanceRequestsResponse -> Rep DescribeSpotInstanceRequestsResponse x #

to :: Rep DescribeSpotInstanceRequestsResponse x -> DescribeSpotInstanceRequestsResponse #

Read DescribeSpotInstanceRequestsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

readsPrec :: Int -> ReadS DescribeSpotInstanceRequestsResponse #

readList :: ReadS [DescribeSpotInstanceRequestsResponse] #

readPrec :: ReadPrec DescribeSpotInstanceRequestsResponse #

readListPrec :: ReadPrec [DescribeSpotInstanceRequestsResponse] #

Show DescribeSpotInstanceRequestsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

showsPrec :: Int -> DescribeSpotInstanceRequestsResponse -> ShowS #

show :: DescribeSpotInstanceRequestsResponse -> String #

showList :: [DescribeSpotInstanceRequestsResponse] -> ShowS #

NFData DescribeSpotInstanceRequestsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

rnf :: DescribeSpotInstanceRequestsResponse -> () #

Eq DescribeSpotInstanceRequestsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

Methods

(==) :: DescribeSpotInstanceRequestsResponse -> DescribeSpotInstanceRequestsResponse -> Bool #

(/=) :: DescribeSpotInstanceRequestsResponse -> DescribeSpotInstanceRequestsResponse -> Bool #

type Rep DescribeSpotInstanceRequestsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSpotInstanceRequests

type Rep DescribeSpotInstanceRequestsResponse = D1 ('MetaData "DescribeSpotInstanceRequestsResponse" "Amazonka.EC2.DescribeSpotInstanceRequests" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSpotInstanceRequestsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "spotInstanceRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SpotInstanceRequest])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSpotInstanceRequestsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeSpotInstanceRequestsResponse'

-> DescribeSpotInstanceRequestsResponse 

Create a value of DescribeSpotInstanceRequestsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSpotInstanceRequests, describeSpotInstanceRequestsResponse_nextToken - The token to use to retrieve the next set of results. This value is null when there are no more results to return.

$sel:spotInstanceRequests:DescribeSpotInstanceRequestsResponse', describeSpotInstanceRequestsResponse_spotInstanceRequests - One or more Spot Instance requests.

$sel:httpStatus:DescribeSpotInstanceRequestsResponse', describeSpotInstanceRequestsResponse_httpStatus - The response's http status code.

Response Lenses

describeSpotInstanceRequestsResponse_nextToken :: Lens' DescribeSpotInstanceRequestsResponse (Maybe Text) Source #

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

describeSpotInstanceRequestsResponse_spotInstanceRequests :: Lens' DescribeSpotInstanceRequestsResponse (Maybe [SpotInstanceRequest]) Source #

One or more Spot Instance requests.

describeSpotInstanceRequestsResponse_httpStatus :: Lens' DescribeSpotInstanceRequestsResponse Int Source #

The response's http status code.