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

#include <DescribeInstanceStatusRequest.h>

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

Public Member Functions

 DescribeInstanceStatusRequest ()
 
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)
 
DescribeInstanceStatusRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeInstanceStatusRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeInstanceStatusRequestAddFilters (const Filter &value)
 
DescribeInstanceStatusRequestAddFilters (Filter &&value)
 
const Aws::Vector< Aws::String > & GetInstanceIds () const
 
bool InstanceIdsHasBeenSet () const
 
void SetInstanceIds (const Aws::Vector< Aws::String > &value)
 
void SetInstanceIds (Aws::Vector< Aws::String > &&value)
 
DescribeInstanceStatusRequestWithInstanceIds (const Aws::Vector< Aws::String > &value)
 
DescribeInstanceStatusRequestWithInstanceIds (Aws::Vector< Aws::String > &&value)
 
DescribeInstanceStatusRequestAddInstanceIds (const Aws::String &value)
 
DescribeInstanceStatusRequestAddInstanceIds (Aws::String &&value)
 
DescribeInstanceStatusRequestAddInstanceIds (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeInstanceStatusRequestWithMaxResults (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)
 
DescribeInstanceStatusRequestWithNextToken (const Aws::String &value)
 
DescribeInstanceStatusRequestWithNextToken (Aws::String &&value)
 
DescribeInstanceStatusRequestWithNextToken (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeInstanceStatusRequestWithDryRun (bool value)
 
bool GetIncludeAllInstances () const
 
bool IncludeAllInstancesHasBeenSet () const
 
void SetIncludeAllInstances (bool value)
 
DescribeInstanceStatusRequestWithIncludeAllInstances (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 23 of file DescribeInstanceStatusRequest.h.

Constructor & Destructor Documentation

◆ DescribeInstanceStatusRequest()

Aws::EC2::Model::DescribeInstanceStatusRequest::DescribeInstanceStatusRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Definition at line 312 of file DescribeInstanceStatusRequest.h.

◆ AddFilters() [2/2]

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

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Definition at line 351 of file DescribeInstanceStatusRequest.h.

◆ AddInstanceIds() [1/3]

DescribeInstanceStatusRequest& Aws::EC2::Model::DescribeInstanceStatusRequest::AddInstanceIds ( const Aws::String value)
inline

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Definition at line 394 of file DescribeInstanceStatusRequest.h.

◆ AddInstanceIds() [2/3]

DescribeInstanceStatusRequest& Aws::EC2::Model::DescribeInstanceStatusRequest::AddInstanceIds ( Aws::String &&  value)
inline

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Definition at line 400 of file DescribeInstanceStatusRequest.h.

◆ AddInstanceIds() [3/3]

DescribeInstanceStatusRequest& Aws::EC2::Model::DescribeInstanceStatusRequest::AddInstanceIds ( const char *  value)
inline

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Definition at line 406 of file DescribeInstanceStatusRequest.h.

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

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

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Definition at line 117 of file DescribeInstanceStatusRequest.h.

◆ GetDryRun()

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

◆ GetFilters()

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

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Definition at line 78 of file DescribeInstanceStatusRequest.h.

◆ GetIncludeAllInstances()

bool Aws::EC2::Model::DescribeInstanceStatusRequest::GetIncludeAllInstances ( ) const
inline

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

Definition at line 521 of file DescribeInstanceStatusRequest.h.

◆ GetInstanceIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeInstanceStatusRequest::GetInstanceIds ( ) const
inline

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Definition at line 358 of file DescribeInstanceStatusRequest.h.

◆ GetMaxResults()

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

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

Definition at line 415 of file DescribeInstanceStatusRequest.h.

◆ GetNextToken()

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

The token to retrieve the next page of results.

Definition at line 445 of file DescribeInstanceStatusRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeInstanceStatusRequest.h.

◆ IncludeAllInstancesHasBeenSet()

bool Aws::EC2::Model::DescribeInstanceStatusRequest::IncludeAllInstancesHasBeenSet ( ) const
inline

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

Definition at line 528 of file DescribeInstanceStatusRequest.h.

◆ InstanceIdsHasBeenSet()

bool Aws::EC2::Model::DescribeInstanceStatusRequest::InstanceIdsHasBeenSet ( ) const
inline

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Definition at line 364 of file DescribeInstanceStatusRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

Definition at line 423 of file DescribeInstanceStatusRequest.h.

◆ NextTokenHasBeenSet()

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

The token to retrieve the next page of results.

Definition at line 450 of file DescribeInstanceStatusRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

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

◆ SetFilters() [1/2]

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

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Definition at line 156 of file DescribeInstanceStatusRequest.h.

◆ SetFilters() [2/2]

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

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Definition at line 195 of file DescribeInstanceStatusRequest.h.

◆ SetIncludeAllInstances()

void Aws::EC2::Model::DescribeInstanceStatusRequest::SetIncludeAllInstances ( bool  value)
inline

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

Definition at line 535 of file DescribeInstanceStatusRequest.h.

◆ SetInstanceIds() [1/2]

void Aws::EC2::Model::DescribeInstanceStatusRequest::SetInstanceIds ( const Aws::Vector< Aws::String > &  value)
inline

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Definition at line 370 of file DescribeInstanceStatusRequest.h.

◆ SetInstanceIds() [2/2]

void Aws::EC2::Model::DescribeInstanceStatusRequest::SetInstanceIds ( Aws::Vector< Aws::String > &&  value)
inline

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Definition at line 376 of file DescribeInstanceStatusRequest.h.

◆ SetMaxResults()

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

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

Definition at line 431 of file DescribeInstanceStatusRequest.h.

◆ SetNextToken() [1/3]

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

The token to retrieve the next page of results.

Definition at line 455 of file DescribeInstanceStatusRequest.h.

◆ SetNextToken() [2/3]

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

The token to retrieve the next page of results.

Definition at line 460 of file DescribeInstanceStatusRequest.h.

◆ SetNextToken() [3/3]

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

The token to retrieve the next page of results.

Definition at line 465 of file DescribeInstanceStatusRequest.h.

◆ WithDryRun()

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

◆ WithFilters() [1/2]

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

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Definition at line 234 of file DescribeInstanceStatusRequest.h.

◆ WithFilters() [2/2]

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

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Definition at line 273 of file DescribeInstanceStatusRequest.h.

◆ WithIncludeAllInstances()

DescribeInstanceStatusRequest& Aws::EC2::Model::DescribeInstanceStatusRequest::WithIncludeAllInstances ( bool  value)
inline

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

Definition at line 542 of file DescribeInstanceStatusRequest.h.

◆ WithInstanceIds() [1/2]

DescribeInstanceStatusRequest& Aws::EC2::Model::DescribeInstanceStatusRequest::WithInstanceIds ( const Aws::Vector< Aws::String > &  value)
inline

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Definition at line 382 of file DescribeInstanceStatusRequest.h.

◆ WithInstanceIds() [2/2]

DescribeInstanceStatusRequest& Aws::EC2::Model::DescribeInstanceStatusRequest::WithInstanceIds ( Aws::Vector< Aws::String > &&  value)
inline

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Definition at line 388 of file DescribeInstanceStatusRequest.h.

◆ WithMaxResults()

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

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

Definition at line 439 of file DescribeInstanceStatusRequest.h.

◆ WithNextToken() [1/3]

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

The token to retrieve the next page of results.

Definition at line 470 of file DescribeInstanceStatusRequest.h.

◆ WithNextToken() [2/3]

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

The token to retrieve the next page of results.

Definition at line 475 of file DescribeInstanceStatusRequest.h.

◆ WithNextToken() [3/3]

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

The token to retrieve the next page of results.

Definition at line 480 of file DescribeInstanceStatusRequest.h.


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