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

#include <DescribeScheduledInstancesRequest.h>

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

Public Member Functions

 DescribeScheduledInstancesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeScheduledInstancesRequestWithDryRun (bool value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeScheduledInstancesRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeScheduledInstancesRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeScheduledInstancesRequestAddFilters (const Filter &value)
 
DescribeScheduledInstancesRequestAddFilters (Filter &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeScheduledInstancesRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeScheduledInstancesRequestWithNextToken (const Aws::String &value)
 
DescribeScheduledInstancesRequestWithNextToken (Aws::String &&value)
 
DescribeScheduledInstancesRequestWithNextToken (const char *value)
 
const Aws::Vector< Aws::String > & GetScheduledInstanceIds () const
 
bool ScheduledInstanceIdsHasBeenSet () const
 
void SetScheduledInstanceIds (const Aws::Vector< Aws::String > &value)
 
void SetScheduledInstanceIds (Aws::Vector< Aws::String > &&value)
 
DescribeScheduledInstancesRequestWithScheduledInstanceIds (const Aws::Vector< Aws::String > &value)
 
DescribeScheduledInstancesRequestWithScheduledInstanceIds (Aws::Vector< Aws::String > &&value)
 
DescribeScheduledInstancesRequestAddScheduledInstanceIds (const Aws::String &value)
 
DescribeScheduledInstancesRequestAddScheduledInstanceIds (Aws::String &&value)
 
DescribeScheduledInstancesRequestAddScheduledInstanceIds (const char *value)
 
const SlotStartTimeRangeRequestGetSlotStartTimeRange () const
 
bool SlotStartTimeRangeHasBeenSet () const
 
void SetSlotStartTimeRange (const SlotStartTimeRangeRequest &value)
 
void SetSlotStartTimeRange (SlotStartTimeRangeRequest &&value)
 
DescribeScheduledInstancesRequestWithSlotStartTimeRange (const SlotStartTimeRangeRequest &value)
 
DescribeScheduledInstancesRequestWithSlotStartTimeRange (SlotStartTimeRangeRequest &&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 DescribeScheduledInstances.

See Also:

AWS API Reference

Definition at line 38 of file DescribeScheduledInstancesRequest.h.

Constructor & Destructor Documentation

◆ DescribeScheduledInstancesRequest()

Aws::EC2::Model::DescribeScheduledInstancesRequest::DescribeScheduledInstancesRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

Definition at line 164 of file DescribeScheduledInstancesRequest.h.

◆ AddFilters() [2/2]

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

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

Definition at line 175 of file DescribeScheduledInstancesRequest.h.

◆ AddScheduledInstanceIds() [1/3]

DescribeScheduledInstancesRequest& Aws::EC2::Model::DescribeScheduledInstancesRequest::AddScheduledInstanceIds ( const Aws::String value)
inline

The Scheduled Instance IDs.

Definition at line 281 of file DescribeScheduledInstancesRequest.h.

◆ AddScheduledInstanceIds() [2/3]

DescribeScheduledInstancesRequest& Aws::EC2::Model::DescribeScheduledInstancesRequest::AddScheduledInstanceIds ( Aws::String &&  value)
inline

The Scheduled Instance IDs.

Definition at line 286 of file DescribeScheduledInstancesRequest.h.

◆ AddScheduledInstanceIds() [3/3]

DescribeScheduledInstancesRequest& Aws::EC2::Model::DescribeScheduledInstancesRequest::AddScheduledInstanceIds ( const char *  value)
inline

The Scheduled Instance IDs.

Definition at line 291 of file DescribeScheduledInstancesRequest.h.

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

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

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

Definition at line 109 of file DescribeScheduledInstancesRequest.h.

◆ GetDryRun()

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

◆ GetFilters()

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

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

Definition at line 98 of file DescribeScheduledInstancesRequest.h.

◆ GetMaxResults()

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

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

Definition at line 183 of file DescribeScheduledInstancesRequest.h.

◆ GetNextToken()

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

The token for the next set of results.

Definition at line 210 of file DescribeScheduledInstancesRequest.h.

◆ GetScheduledInstanceIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeScheduledInstancesRequest::GetScheduledInstanceIds ( ) const
inline

The Scheduled Instance IDs.

Definition at line 251 of file DescribeScheduledInstancesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 47 of file DescribeScheduledInstancesRequest.h.

◆ GetSlotStartTimeRange()

const SlotStartTimeRangeRequest& Aws::EC2::Model::DescribeScheduledInstancesRequest::GetSlotStartTimeRange ( ) const
inline

The time period for the first schedule to start.

Definition at line 297 of file DescribeScheduledInstancesRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

Definition at line 190 of file DescribeScheduledInstancesRequest.h.

◆ NextTokenHasBeenSet()

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

The token for the next set of results.

Definition at line 215 of file DescribeScheduledInstancesRequest.h.

◆ ScheduledInstanceIdsHasBeenSet()

bool Aws::EC2::Model::DescribeScheduledInstancesRequest::ScheduledInstanceIdsHasBeenSet ( ) const
inline

The Scheduled Instance IDs.

Definition at line 256 of file DescribeScheduledInstancesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

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

◆ SetFilters() [1/2]

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

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

Definition at line 120 of file DescribeScheduledInstancesRequest.h.

◆ SetFilters() [2/2]

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

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

Definition at line 131 of file DescribeScheduledInstancesRequest.h.

◆ SetMaxResults()

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

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

Definition at line 197 of file DescribeScheduledInstancesRequest.h.

◆ SetNextToken() [1/3]

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

The token for the next set of results.

Definition at line 220 of file DescribeScheduledInstancesRequest.h.

◆ SetNextToken() [2/3]

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

The token for the next set of results.

Definition at line 225 of file DescribeScheduledInstancesRequest.h.

◆ SetNextToken() [3/3]

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

The token for the next set of results.

Definition at line 230 of file DescribeScheduledInstancesRequest.h.

◆ SetScheduledInstanceIds() [1/2]

void Aws::EC2::Model::DescribeScheduledInstancesRequest::SetScheduledInstanceIds ( const Aws::Vector< Aws::String > &  value)
inline

The Scheduled Instance IDs.

Definition at line 261 of file DescribeScheduledInstancesRequest.h.

◆ SetScheduledInstanceIds() [2/2]

void Aws::EC2::Model::DescribeScheduledInstancesRequest::SetScheduledInstanceIds ( Aws::Vector< Aws::String > &&  value)
inline

The Scheduled Instance IDs.

Definition at line 266 of file DescribeScheduledInstancesRequest.h.

◆ SetSlotStartTimeRange() [1/2]

void Aws::EC2::Model::DescribeScheduledInstancesRequest::SetSlotStartTimeRange ( const SlotStartTimeRangeRequest value)
inline

The time period for the first schedule to start.

Definition at line 307 of file DescribeScheduledInstancesRequest.h.

◆ SetSlotStartTimeRange() [2/2]

void Aws::EC2::Model::DescribeScheduledInstancesRequest::SetSlotStartTimeRange ( SlotStartTimeRangeRequest &&  value)
inline

The time period for the first schedule to start.

Definition at line 312 of file DescribeScheduledInstancesRequest.h.

◆ SlotStartTimeRangeHasBeenSet()

bool Aws::EC2::Model::DescribeScheduledInstancesRequest::SlotStartTimeRangeHasBeenSet ( ) const
inline

The time period for the first schedule to start.

Definition at line 302 of file DescribeScheduledInstancesRequest.h.

◆ WithDryRun()

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

◆ WithFilters() [1/2]

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

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

Definition at line 142 of file DescribeScheduledInstancesRequest.h.

◆ WithFilters() [2/2]

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

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

Definition at line 153 of file DescribeScheduledInstancesRequest.h.

◆ WithMaxResults()

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

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

Definition at line 204 of file DescribeScheduledInstancesRequest.h.

◆ WithNextToken() [1/3]

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

The token for the next set of results.

Definition at line 235 of file DescribeScheduledInstancesRequest.h.

◆ WithNextToken() [2/3]

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

The token for the next set of results.

Definition at line 240 of file DescribeScheduledInstancesRequest.h.

◆ WithNextToken() [3/3]

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

The token for the next set of results.

Definition at line 245 of file DescribeScheduledInstancesRequest.h.

◆ WithScheduledInstanceIds() [1/2]

DescribeScheduledInstancesRequest& Aws::EC2::Model::DescribeScheduledInstancesRequest::WithScheduledInstanceIds ( const Aws::Vector< Aws::String > &  value)
inline

The Scheduled Instance IDs.

Definition at line 271 of file DescribeScheduledInstancesRequest.h.

◆ WithScheduledInstanceIds() [2/2]

DescribeScheduledInstancesRequest& Aws::EC2::Model::DescribeScheduledInstancesRequest::WithScheduledInstanceIds ( Aws::Vector< Aws::String > &&  value)
inline

The Scheduled Instance IDs.

Definition at line 276 of file DescribeScheduledInstancesRequest.h.

◆ WithSlotStartTimeRange() [1/2]

DescribeScheduledInstancesRequest& Aws::EC2::Model::DescribeScheduledInstancesRequest::WithSlotStartTimeRange ( const SlotStartTimeRangeRequest value)
inline

The time period for the first schedule to start.

Definition at line 317 of file DescribeScheduledInstancesRequest.h.

◆ WithSlotStartTimeRange() [2/2]

DescribeScheduledInstancesRequest& Aws::EC2::Model::DescribeScheduledInstancesRequest::WithSlotStartTimeRange ( SlotStartTimeRangeRequest &&  value)
inline

The time period for the first schedule to start.

Definition at line 322 of file DescribeScheduledInstancesRequest.h.


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