DescribeInstanceStatusRequest (AWS SDK for Java 1.8.9 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.DescribeInstanceStatusRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeInstanceStatusRequest>, Serializable
```
public class DescribeInstanceStatusRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeInstanceStatusRequest>
```
Container for the parameters to the DescribeInstanceStatus operation.
Describes the status of one or more instances, including any scheduled events.

Instance status has two main components:
- System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.
- Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.
Instance status provides information about four types of scheduled events for an instance that may require your attention:
- Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: system-reboot or instance-reboot . System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.
- System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code system-maintenance . System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.
- Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code instance-retirement . Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.
- Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called instance-stop . Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.
When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is instance-retirement . This ensures that your instance is started on a different underlying host.

For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide . For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide .
See Also:
AmazonEC2.describeInstanceStatus(DescribeInstanceStatusRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

DescribeInstanceStatusRequest()

Constructors
Constructor and Description
`DescribeInstanceStatusRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Request<DescribeInstanceStatusRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`List<Filter>`	`getFilters()` One or more filters.
`Boolean`	`getIncludeAllInstances()` When `true`, includes the health status for all instances.
`List<String>`	`getInstanceIds()` One or more instance IDs.
`Integer`	`getMaxResults()` The maximum number of paginated instance items per response.
`String`	`getNextToken()` The next paginated set of results to return.
`int`	`hashCode()`
`Boolean`	`isIncludeAllInstances()` When `true`, includes the health status for all instances.
`void`	`setFilters(Collection<Filter> filters)` One or more filters.
`void`	`setIncludeAllInstances(Boolean includeAllInstances)` When `true`, includes the health status for all instances.
`void`	`setInstanceIds(Collection<String> instanceIds)` One or more instance IDs.
`void`	`setMaxResults(Integer maxResults)` The maximum number of paginated instance items per response.
`void`	`setNextToken(String nextToken)` The next paginated set of results to return.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeInstanceStatusRequest`	`withFilters(Collection<Filter> filters)` One or more filters.
`DescribeInstanceStatusRequest`	`withFilters(Filter... filters)` One or more filters.
`DescribeInstanceStatusRequest`	`withIncludeAllInstances(Boolean includeAllInstances)` When `true`, includes the health status for all instances.
`DescribeInstanceStatusRequest`	`withInstanceIds(Collection<String> instanceIds)` One or more instance IDs.
`DescribeInstanceStatusRequest`	`withInstanceIds(String... instanceIds)` One or more instance IDs.
`DescribeInstanceStatusRequest`	`withMaxResults(Integer maxResults)` The maximum number of paginated instance items per response.
`DescribeInstanceStatusRequest`	`withNextToken(String nextToken)` The next paginated set of results to return.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeInstanceStatusRequest
```
public DescribeInstanceStatusRequest()
```
- Method Detail
  - getInstanceIds
```
public List<String> getInstanceIds()
```
    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.
  - setInstanceIds
```
public void setInstanceIds(Collection<String> instanceIds)
```
    One or more instance IDs.
    Default: Describes all your instances.
    Constraints: Maximum 100 explicitly specified instance IDs.
    
    Parameters:
    instanceIds - One or more instance IDs.
    Default: Describes all your instances.
    Constraints: Maximum 100 explicitly specified instance IDs.
  - withInstanceIds
```
public DescribeInstanceStatusRequest withInstanceIds(String... instanceIds)
```
    One or more instance IDs.
    Default: Describes all your instances.
    Constraints: Maximum 100 explicitly specified instance IDs.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    instanceIds - One or more instance IDs.
    Default: Describes all your instances.
    Constraints: Maximum 100 explicitly specified instance IDs.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withInstanceIds
```
public DescribeInstanceStatusRequest withInstanceIds(Collection<String> instanceIds)
```
    One or more instance IDs.
    Default: Describes all your instances.
    Constraints: Maximum 100 explicitly specified instance IDs.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    instanceIds - One or more instance IDs.
    Default: Describes all your instances.
    Constraints: Maximum 100 explicitly specified instance IDs.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getFilters
```
public List<Filter> getFilters()
```
    One or more filters.
    - availability-zone - The Availability Zone of the instance.
    - event.code - The code identifying the type of 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.
    - event.not-before - The earliest start time for the scheduled event.
    - instance-state-code - A code representing the state of the instance, 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 identifying the type of 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.
    
    event.not-before - The earliest start time for the scheduled event.
    
    instance-state-code - A code representing the state of the instance, 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).
  - setFilters
```
public void setFilters(Collection<Filter> filters)
```
    One or more filters.
    - availability-zone - The Availability Zone of the instance.
    - event.code - The code identifying the type of 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.
    - event.not-before - The earliest start time for the scheduled event.
    - instance-state-code - A code representing the state of the instance, 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).
    Parameters:
    filters - One or more filters.
    
    availability-zone - The Availability Zone of the instance.
    
    event.code - The code identifying the type of 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.
    
    event.not-before - The earliest start time for the scheduled event.
    
    instance-state-code - A code representing the state of the instance, 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).
  - withFilters
```
public DescribeInstanceStatusRequest withFilters(Filter... filters)
```
    One or more filters.
    - availability-zone - The Availability Zone of the instance.
    - event.code - The code identifying the type of 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.
    - event.not-before - The earliest start time for the scheduled event.
    - instance-state-code - A code representing the state of the instance, 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 a reference to this object so that method calls can be chained together.
    Parameters:
    filters - One or more filters.
    
    availability-zone - The Availability Zone of the instance.
    
    event.code - The code identifying the type of 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.
    
    event.not-before - The earliest start time for the scheduled event.
    
    instance-state-code - A code representing the state of the instance, 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:
    A reference to this updated object so that method calls can be chained together.
  - withFilters
```
public DescribeInstanceStatusRequest withFilters(Collection<Filter> filters)
```
    One or more filters.
    - availability-zone - The Availability Zone of the instance.
    - event.code - The code identifying the type of 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.
    - event.not-before - The earliest start time for the scheduled event.
    - instance-state-code - A code representing the state of the instance, 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 a reference to this object so that method calls can be chained together.
    Parameters:
    filters - One or more filters.
    
    availability-zone - The Availability Zone of the instance.
    
    event.code - The code identifying the type of 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.
    
    event.not-before - The earliest start time for the scheduled event.
    
    instance-state-code - A code representing the state of the instance, 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:
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public String getNextToken()
```
    The next paginated set of results to return.
    
    Returns:
    The next paginated set of results to return.
  - setNextToken
```
public void setNextToken(String nextToken)
```
    The next paginated set of results to return.
    
    Parameters:
    nextToken - The next paginated set of results to return.
  - withNextToken
```
public DescribeInstanceStatusRequest withNextToken(String nextToken)
```
    The next paginated set of results to return.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    nextToken - The next paginated set of results to return.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of paginated instance items per response.
    Default: 1000
    
    Returns:
    The maximum number of paginated instance items per response.
    Default: 1000
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    The maximum number of paginated instance items per response.
    Default: 1000
    
    Parameters:
    maxResults - The maximum number of paginated instance items per response.
    Default: 1000
  - withMaxResults
```
public DescribeInstanceStatusRequest withMaxResults(Integer maxResults)
```
    The maximum number of paginated instance items per response.
    Default: 1000
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    maxResults - The maximum number of paginated instance items per response.
    Default: 1000
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isIncludeAllInstances
```
public Boolean isIncludeAllInstances()
```
    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
  - setIncludeAllInstances
```
public void setIncludeAllInstances(Boolean includeAllInstances)
```
    When true, includes the health status for all instances. When false, includes the health status for running instances only.
    Default: false
    
    Parameters:
    includeAllInstances - When true, includes the health status for all instances. When false, includes the health status for running instances only.
    Default: false
  - withIncludeAllInstances
```
public DescribeInstanceStatusRequest withIncludeAllInstances(Boolean includeAllInstances)
```
    When true, includes the health status for all instances. When false, includes the health status for running instances only.
    Default: false
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    includeAllInstances - When true, includes the health status for all instances. When false, includes the health status for running instances only.
    Default: false
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getIncludeAllInstances
```
public Boolean getIncludeAllInstances()
```
    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
  - getDryRunRequest
```
public Request<DescribeInstanceStatusRequest> getDryRunRequest()
```
    This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.
    
    Specified by:
    
    getDryRunRequest in interface DryRunSupportedRequest<DescribeInstanceStatusRequest>
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class DescribeInstanceStatusRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeInstanceStatusRequest

Method Detail

getInstanceIds

setInstanceIds

withInstanceIds

withInstanceIds

getFilters

setFilters

withFilters

withFilters

getNextToken

setNextToken

withNextToken

getMaxResults

setMaxResults

withMaxResults

isIncludeAllInstances

setIncludeAllInstances

withIncludeAllInstances

getIncludeAllInstances

getDryRunRequest

toString

hashCode

equals