Package software.amazon.awssdk.services.ec2.model

Class DescribeInstanceStatusRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ec2.model.DescribeInstanceStatusRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeInstanceStatusRequest.Builder,DescribeInstanceStatusRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeInstanceStatusRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeInstanceStatusRequest.Builder,DescribeInstanceStatusRequest>

Contains the parameters for DescribeInstanceStatus.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeInstanceStatusRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeInstanceStatusRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters()	One or more filters.
int	hashCode()
Boolean	includeAllInstances()	When true, includes the health status for all instances.
List<String>	instanceIds()	One or more instance IDs.
Integer	maxResults()	The maximum number of results to return in a single call.
String	nextToken()	The token to retrieve the next page of results.
static Class<? extends DescribeInstanceStatusRequest.Builder>	serializableBuilderClass()
DescribeInstanceStatusRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

filters

public List<Filter> filters()

One or more 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.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).

• instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value 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).

Returns:

One or more 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.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).

• instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value 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).

instanceIds

public List<String> instanceIds()

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Returns:

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

maxResults

public Integer maxResults()

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.

Returns:

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.

nextToken

public String nextToken()

The token to retrieve the next page of results.

Returns:

The token to retrieve the next page of results.

includeAllInstances

public Boolean includeAllInstances()

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

Default: false

Returns:

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

Default: false

toBuilder

public DescribeInstanceStatusRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeInstanceStatusRequest.Builder,DescribeInstanceStatusRequest>

Returns:

a builder for type T

builder

public static DescribeInstanceStatusRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeInstanceStatusRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object