AWS SDK for C++  1.7.231
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::DescribeSpotInstanceRequestsRequest Class Reference

#include <DescribeSpotInstanceRequestsRequest.h>

+ Inheritance diagram for Aws::EC2::Model::DescribeSpotInstanceRequestsRequest:

Public Member Functions

 DescribeSpotInstanceRequestsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeSpotInstanceRequestsRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeSpotInstanceRequestsRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeSpotInstanceRequestsRequestAddFilters (const Filter &value)
 
DescribeSpotInstanceRequestsRequestAddFilters (Filter &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeSpotInstanceRequestsRequestWithDryRun (bool value)
 
const Aws::Vector< Aws::String > & GetSpotInstanceRequestIds () const
 
bool SpotInstanceRequestIdsHasBeenSet () const
 
void SetSpotInstanceRequestIds (const Aws::Vector< Aws::String > &value)
 
void SetSpotInstanceRequestIds (Aws::Vector< Aws::String > &&value)
 
DescribeSpotInstanceRequestsRequestWithSpotInstanceRequestIds (const Aws::Vector< Aws::String > &value)
 
DescribeSpotInstanceRequestsRequestWithSpotInstanceRequestIds (Aws::Vector< Aws::String > &&value)
 
DescribeSpotInstanceRequestsRequestAddSpotInstanceRequestIds (const Aws::String &value)
 
DescribeSpotInstanceRequestsRequestAddSpotInstanceRequestIds (Aws::String &&value)
 
DescribeSpotInstanceRequestsRequestAddSpotInstanceRequestIds (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeSpotInstanceRequestsRequestWithNextToken (const Aws::String &value)
 
DescribeSpotInstanceRequestsRequestWithNextToken (Aws::String &&value)
 
DescribeSpotInstanceRequestsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeSpotInstanceRequestsRequestWithMaxResults (int value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Contains the parameters for DescribeSpotInstanceRequests.

See Also:

AWS API Reference

Definition at line 37 of file DescribeSpotInstanceRequestsRequest.h.

Constructor & Destructor Documentation

◆ DescribeSpotInstanceRequestsRequest()

Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::DescribeSpotInstanceRequestsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::AddFilters ( const Filter value)
inline

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

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

Definition at line 592 of file DescribeSpotInstanceRequestsRequest.h.

◆ AddFilters() [2/2]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::AddFilters ( Filter &&  value)
inline

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

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

Definition at line 669 of file DescribeSpotInstanceRequestsRequest.h.

◆ AddSpotInstanceRequestIds() [1/3]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::AddSpotInstanceRequestIds ( const Aws::String value)
inline

One or more Spot Instance request IDs.

Definition at line 738 of file DescribeSpotInstanceRequestsRequest.h.

◆ AddSpotInstanceRequestIds() [2/3]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::AddSpotInstanceRequestIds ( Aws::String &&  value)
inline

One or more Spot Instance request IDs.

Definition at line 743 of file DescribeSpotInstanceRequestsRequest.h.

◆ AddSpotInstanceRequestIds() [3/3]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::AddSpotInstanceRequestIds ( const char *  value)
inline

One or more Spot Instance request IDs.

Definition at line 748 of file DescribeSpotInstanceRequestsRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::DryRunHasBeenSet ( ) const
inline

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.

Definition at line 686 of file DescribeSpotInstanceRequestsRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ FiltersHasBeenSet()

bool Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::FiltersHasBeenSet ( ) const
inline

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

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

Definition at line 207 of file DescribeSpotInstanceRequestsRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::GetDryRun ( ) const
inline

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.

Definition at line 678 of file DescribeSpotInstanceRequestsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::GetFilters ( ) const
inline

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

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

Definition at line 130 of file DescribeSpotInstanceRequestsRequest.h.

◆ GetMaxResults()

int Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::GetMaxResults ( ) const
inline

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.

Definition at line 805 of file DescribeSpotInstanceRequestsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::GetNextToken ( ) const
inline

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

Definition at line 755 of file DescribeSpotInstanceRequestsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetSpotInstanceRequestIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::GetSpotInstanceRequestIds ( ) const
inline

One or more Spot Instance request IDs.

Definition at line 708 of file DescribeSpotInstanceRequestsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::MaxResultsHasBeenSet ( ) const
inline

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.

Definition at line 812 of file DescribeSpotInstanceRequestsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::NextTokenHasBeenSet ( ) const
inline

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

Definition at line 761 of file DescribeSpotInstanceRequestsRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

void Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SetDryRun ( bool  value)
inline

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.

Definition at line 694 of file DescribeSpotInstanceRequestsRequest.h.

◆ SetFilters() [1/2]

void Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

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

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

Definition at line 284 of file DescribeSpotInstanceRequestsRequest.h.

◆ SetFilters() [2/2]

void Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

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

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

Definition at line 361 of file DescribeSpotInstanceRequestsRequest.h.

◆ SetMaxResults()

void Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SetMaxResults ( int  value)
inline

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.

Definition at line 819 of file DescribeSpotInstanceRequestsRequest.h.

◆ SetNextToken() [1/3]

void Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SetNextToken ( const Aws::String value)
inline

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

Definition at line 767 of file DescribeSpotInstanceRequestsRequest.h.

◆ SetNextToken() [2/3]

void Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SetNextToken ( Aws::String &&  value)
inline

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

Definition at line 773 of file DescribeSpotInstanceRequestsRequest.h.

◆ SetNextToken() [3/3]

void Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SetNextToken ( const char *  value)
inline

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

Definition at line 779 of file DescribeSpotInstanceRequestsRequest.h.

◆ SetSpotInstanceRequestIds() [1/2]

void Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SetSpotInstanceRequestIds ( const Aws::Vector< Aws::String > &  value)
inline

One or more Spot Instance request IDs.

Definition at line 718 of file DescribeSpotInstanceRequestsRequest.h.

◆ SetSpotInstanceRequestIds() [2/2]

void Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SetSpotInstanceRequestIds ( Aws::Vector< Aws::String > &&  value)
inline

One or more Spot Instance request IDs.

Definition at line 723 of file DescribeSpotInstanceRequestsRequest.h.

◆ SpotInstanceRequestIdsHasBeenSet()

bool Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::SpotInstanceRequestIdsHasBeenSet ( ) const
inline

One or more Spot Instance request IDs.

Definition at line 713 of file DescribeSpotInstanceRequestsRequest.h.

◆ WithDryRun()

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::WithDryRun ( bool  value)
inline

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.

Definition at line 702 of file DescribeSpotInstanceRequestsRequest.h.

◆ WithFilters() [1/2]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

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

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

Definition at line 438 of file DescribeSpotInstanceRequestsRequest.h.

◆ WithFilters() [2/2]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

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

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

Definition at line 515 of file DescribeSpotInstanceRequestsRequest.h.

◆ WithMaxResults()

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::WithMaxResults ( int  value)
inline

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.

Definition at line 826 of file DescribeSpotInstanceRequestsRequest.h.

◆ WithNextToken() [1/3]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::WithNextToken ( const Aws::String value)
inline

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

Definition at line 785 of file DescribeSpotInstanceRequestsRequest.h.

◆ WithNextToken() [2/3]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::WithNextToken ( Aws::String &&  value)
inline

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

Definition at line 791 of file DescribeSpotInstanceRequestsRequest.h.

◆ WithNextToken() [3/3]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::WithNextToken ( const char *  value)
inline

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

Definition at line 797 of file DescribeSpotInstanceRequestsRequest.h.

◆ WithSpotInstanceRequestIds() [1/2]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::WithSpotInstanceRequestIds ( const Aws::Vector< Aws::String > &  value)
inline

One or more Spot Instance request IDs.

Definition at line 728 of file DescribeSpotInstanceRequestsRequest.h.

◆ WithSpotInstanceRequestIds() [2/2]

DescribeSpotInstanceRequestsRequest& Aws::EC2::Model::DescribeSpotInstanceRequestsRequest::WithSpotInstanceRequestIds ( Aws::Vector< Aws::String > &&  value)
inline

One or more Spot Instance request IDs.

Definition at line 733 of file DescribeSpotInstanceRequestsRequest.h.


The documentation for this class was generated from the following file: