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

#include <DescribeCapacityReservationsRequest.h>

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

Public Member Functions

 DescribeCapacityReservationsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetCapacityReservationIds () const
 
bool CapacityReservationIdsHasBeenSet () const
 
void SetCapacityReservationIds (const Aws::Vector< Aws::String > &value)
 
void SetCapacityReservationIds (Aws::Vector< Aws::String > &&value)
 
DescribeCapacityReservationsRequestWithCapacityReservationIds (const Aws::Vector< Aws::String > &value)
 
DescribeCapacityReservationsRequestWithCapacityReservationIds (Aws::Vector< Aws::String > &&value)
 
DescribeCapacityReservationsRequestAddCapacityReservationIds (const Aws::String &value)
 
DescribeCapacityReservationsRequestAddCapacityReservationIds (Aws::String &&value)
 
DescribeCapacityReservationsRequestAddCapacityReservationIds (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)
 
DescribeCapacityReservationsRequestWithNextToken (const Aws::String &value)
 
DescribeCapacityReservationsRequestWithNextToken (Aws::String &&value)
 
DescribeCapacityReservationsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeCapacityReservationsRequestWithMaxResults (int value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeCapacityReservationsRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeCapacityReservationsRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeCapacityReservationsRequestAddFilters (const Filter &value)
 
DescribeCapacityReservationsRequestAddFilters (Filter &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeCapacityReservationsRequestWithDryRun (bool 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

Definition at line 33 of file DescribeCapacityReservationsRequest.h.

Constructor & Destructor Documentation

◆ DescribeCapacityReservationsRequest()

Aws::EC2::Model::DescribeCapacityReservationsRequest::DescribeCapacityReservationsRequest ( )

Member Function Documentation

◆ AddCapacityReservationIds() [1/3]

DescribeCapacityReservationsRequest& Aws::EC2::Model::DescribeCapacityReservationsRequest::AddCapacityReservationIds ( const Aws::String value)
inline

The ID of the Capacity Reservation.

Definition at line 84 of file DescribeCapacityReservationsRequest.h.

◆ AddCapacityReservationIds() [2/3]

DescribeCapacityReservationsRequest& Aws::EC2::Model::DescribeCapacityReservationsRequest::AddCapacityReservationIds ( Aws::String &&  value)
inline

The ID of the Capacity Reservation.

Definition at line 89 of file DescribeCapacityReservationsRequest.h.

◆ AddCapacityReservationIds() [3/3]

DescribeCapacityReservationsRequest& Aws::EC2::Model::DescribeCapacityReservationsRequest::AddCapacityReservationIds ( const char *  value)
inline

The ID of the Capacity Reservation.

Definition at line 94 of file DescribeCapacityReservationsRequest.h.

◆ AddFilters() [1/2]

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

One or more filters.

  • instance-type - The type of instance for which the Capacity Reservation reserves capacity.

  • owner-id - The ID of the AWS account that owns the Capacity Reservation.

  • availability-zone-id - The Availability Zone ID of the Capacity Reservation.

  • instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

  • availability-zone - The Availability Zone ID of the Capacity Reservation.

  • tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

    • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

    • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

  • state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active- The Capacity Reservation is active and the capacity is available for your use.

    • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

    • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

    • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

  • end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

  • end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

    • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

    • limited - The Capacity Reservation expires automatically at a specified date and time.

  • instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

    • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

    • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Definition at line 522 of file DescribeCapacityReservationsRequest.h.

◆ AddFilters() [2/2]

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

One or more filters.

  • instance-type - The type of instance for which the Capacity Reservation reserves capacity.

  • owner-id - The ID of the AWS account that owns the Capacity Reservation.

  • availability-zone-id - The Availability Zone ID of the Capacity Reservation.

  • instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

  • availability-zone - The Availability Zone ID of the Capacity Reservation.

  • tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

    • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

    • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

  • state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active- The Capacity Reservation is active and the capacity is available for your use.

    • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

    • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

    • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

  • end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

  • end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

    • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

    • limited - The Capacity Reservation expires automatically at a specified date and time.

  • instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

    • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

    • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Definition at line 573 of file DescribeCapacityReservationsRequest.h.

◆ CapacityReservationIdsHasBeenSet()

bool Aws::EC2::Model::DescribeCapacityReservationsRequest::CapacityReservationIdsHasBeenSet ( ) const
inline

The ID of the Capacity Reservation.

Definition at line 59 of file DescribeCapacityReservationsRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::DescribeCapacityReservationsRequest::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 590 of file DescribeCapacityReservationsRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeCapacityReservationsRequest::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::DescribeCapacityReservationsRequest::FiltersHasBeenSet ( ) const
inline

One or more filters.

  • instance-type - The type of instance for which the Capacity Reservation reserves capacity.

  • owner-id - The ID of the AWS account that owns the Capacity Reservation.

  • availability-zone-id - The Availability Zone ID of the Capacity Reservation.

  • instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

  • availability-zone - The Availability Zone ID of the Capacity Reservation.

  • tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

    • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

    • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

  • state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active- The Capacity Reservation is active and the capacity is available for your use.

    • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

    • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

    • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

  • end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

  • end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

    • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

    • limited - The Capacity Reservation expires automatically at a specified date and time.

  • instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

    • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

    • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Definition at line 267 of file DescribeCapacityReservationsRequest.h.

◆ GetCapacityReservationIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeCapacityReservationsRequest::GetCapacityReservationIds ( ) const
inline

The ID of the Capacity Reservation.

Definition at line 54 of file DescribeCapacityReservationsRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::DescribeCapacityReservationsRequest::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 582 of file DescribeCapacityReservationsRequest.h.

◆ GetFilters()

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

One or more filters.

  • instance-type - The type of instance for which the Capacity Reservation reserves capacity.

  • owner-id - The ID of the AWS account that owns the Capacity Reservation.

  • availability-zone-id - The Availability Zone ID of the Capacity Reservation.

  • instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

  • availability-zone - The Availability Zone ID of the Capacity Reservation.

  • tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

    • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

    • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

  • state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active- The Capacity Reservation is active and the capacity is available for your use.

    • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

    • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

    • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

  • end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

  • end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

    • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

    • limited - The Capacity Reservation expires automatically at a specified date and time.

  • instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

    • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

    • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Definition at line 216 of file DescribeCapacityReservationsRequest.h.

◆ GetMaxResults()

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

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.

Definition at line 143 of file DescribeCapacityReservationsRequest.h.

◆ GetNextToken()

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

The token to retrieve the next page of results.

Definition at line 100 of file DescribeCapacityReservationsRequest.h.

◆ GetServiceRequestName()

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

◆ MaxResultsHasBeenSet()

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

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.

Definition at line 150 of file DescribeCapacityReservationsRequest.h.

◆ NextTokenHasBeenSet()

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

The token to retrieve the next page of results.

Definition at line 105 of file DescribeCapacityReservationsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCapacityReservationIds() [1/2]

void Aws::EC2::Model::DescribeCapacityReservationsRequest::SetCapacityReservationIds ( const Aws::Vector< Aws::String > &  value)
inline

The ID of the Capacity Reservation.

Definition at line 64 of file DescribeCapacityReservationsRequest.h.

◆ SetCapacityReservationIds() [2/2]

void Aws::EC2::Model::DescribeCapacityReservationsRequest::SetCapacityReservationIds ( Aws::Vector< Aws::String > &&  value)
inline

The ID of the Capacity Reservation.

Definition at line 69 of file DescribeCapacityReservationsRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::DescribeCapacityReservationsRequest::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 598 of file DescribeCapacityReservationsRequest.h.

◆ SetFilters() [1/2]

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

One or more filters.

  • instance-type - The type of instance for which the Capacity Reservation reserves capacity.

  • owner-id - The ID of the AWS account that owns the Capacity Reservation.

  • availability-zone-id - The Availability Zone ID of the Capacity Reservation.

  • instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

  • availability-zone - The Availability Zone ID of the Capacity Reservation.

  • tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

    • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

    • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

  • state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active- The Capacity Reservation is active and the capacity is available for your use.

    • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

    • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

    • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

  • end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

  • end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

    • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

    • limited - The Capacity Reservation expires automatically at a specified date and time.

  • instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

    • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

    • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Definition at line 318 of file DescribeCapacityReservationsRequest.h.

◆ SetFilters() [2/2]

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

One or more filters.

  • instance-type - The type of instance for which the Capacity Reservation reserves capacity.

  • owner-id - The ID of the AWS account that owns the Capacity Reservation.

  • availability-zone-id - The Availability Zone ID of the Capacity Reservation.

  • instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

  • availability-zone - The Availability Zone ID of the Capacity Reservation.

  • tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

    • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

    • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

  • state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active- The Capacity Reservation is active and the capacity is available for your use.

    • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

    • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

    • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

  • end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

  • end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

    • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

    • limited - The Capacity Reservation expires automatically at a specified date and time.

  • instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

    • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

    • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Definition at line 369 of file DescribeCapacityReservationsRequest.h.

◆ SetMaxResults()

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

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.

Definition at line 157 of file DescribeCapacityReservationsRequest.h.

◆ SetNextToken() [1/3]

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

The token to retrieve the next page of results.

Definition at line 110 of file DescribeCapacityReservationsRequest.h.

◆ SetNextToken() [2/3]

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

The token to retrieve the next page of results.

Definition at line 115 of file DescribeCapacityReservationsRequest.h.

◆ SetNextToken() [3/3]

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

The token to retrieve the next page of results.

Definition at line 120 of file DescribeCapacityReservationsRequest.h.

◆ WithCapacityReservationIds() [1/2]

DescribeCapacityReservationsRequest& Aws::EC2::Model::DescribeCapacityReservationsRequest::WithCapacityReservationIds ( const Aws::Vector< Aws::String > &  value)
inline

The ID of the Capacity Reservation.

Definition at line 74 of file DescribeCapacityReservationsRequest.h.

◆ WithCapacityReservationIds() [2/2]

DescribeCapacityReservationsRequest& Aws::EC2::Model::DescribeCapacityReservationsRequest::WithCapacityReservationIds ( Aws::Vector< Aws::String > &&  value)
inline

The ID of the Capacity Reservation.

Definition at line 79 of file DescribeCapacityReservationsRequest.h.

◆ WithDryRun()

DescribeCapacityReservationsRequest& Aws::EC2::Model::DescribeCapacityReservationsRequest::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 606 of file DescribeCapacityReservationsRequest.h.

◆ WithFilters() [1/2]

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

One or more filters.

  • instance-type - The type of instance for which the Capacity Reservation reserves capacity.

  • owner-id - The ID of the AWS account that owns the Capacity Reservation.

  • availability-zone-id - The Availability Zone ID of the Capacity Reservation.

  • instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

  • availability-zone - The Availability Zone ID of the Capacity Reservation.

  • tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

    • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

    • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

  • state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active- The Capacity Reservation is active and the capacity is available for your use.

    • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

    • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

    • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

  • end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

  • end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

    • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

    • limited - The Capacity Reservation expires automatically at a specified date and time.

  • instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

    • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

    • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Definition at line 420 of file DescribeCapacityReservationsRequest.h.

◆ WithFilters() [2/2]

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

One or more filters.

  • instance-type - The type of instance for which the Capacity Reservation reserves capacity.

  • owner-id - The ID of the AWS account that owns the Capacity Reservation.

  • availability-zone-id - The Availability Zone ID of the Capacity Reservation.

  • instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

  • availability-zone - The Availability Zone ID of the Capacity Reservation.

  • tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

    • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

    • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

  • state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active- The Capacity Reservation is active and the capacity is available for your use.

    • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

    • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

    • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

  • end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

  • end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

    • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

    • limited - The Capacity Reservation expires automatically at a specified date and time.

  • instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

    • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

    • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Definition at line 471 of file DescribeCapacityReservationsRequest.h.

◆ WithMaxResults()

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

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.

Definition at line 164 of file DescribeCapacityReservationsRequest.h.

◆ WithNextToken() [1/3]

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

The token to retrieve the next page of results.

Definition at line 125 of file DescribeCapacityReservationsRequest.h.

◆ WithNextToken() [2/3]

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

The token to retrieve the next page of results.

Definition at line 130 of file DescribeCapacityReservationsRequest.h.

◆ WithNextToken() [3/3]

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

The token to retrieve the next page of results.

Definition at line 135 of file DescribeCapacityReservationsRequest.h.


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