DescribeInstanceStatusRequest (AWS SDK for Android

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

All Implemented Interfaces:

DryRunSupportedRequest<DescribeInstanceStatusRequest>, java.io.Serializable, java.lang.Cloneable
```
public class DescribeInstanceStatusRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeInstanceStatusRequest>
```
Container for the parameters to the DescribeInstanceStatus operation.
Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.

Instance status includes the following components:
- Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide .
- Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide .
- Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide .
See Also:

AmazonEC2.describeInstanceStatus(DescribeInstanceStatusRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeInstanceStatusRequest()

Constructors
Constructor and Description
`DescribeInstanceStatusRequest()`

Method Summary

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

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

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

- Constructor Detail
  - DescribeInstanceStatusRequest
```
public DescribeInstanceStatusRequest()
```
- Method Detail
  - getInstanceIds
```
public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.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(java.util.Collection<java.lang.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 java.util.List<Filter> getFilters()
```
    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).
  - setFilters
```
public void setFilters(java.util.Collection<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).
    Parameters:
    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).
  - withFilters
```
public DescribeInstanceStatusRequest withFilters(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 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 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:
    
    A reference to this updated object so that method calls can be chained together.
  - withFilters
```
public DescribeInstanceStatusRequest withFilters(java.util.Collection<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 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 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:
    
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public java.lang.String getNextToken()
```
    The token to retrieve the next page of results.
    
    Returns:
    
    The token to retrieve the next page of results.
  - setNextToken
```
public void setNextToken(java.lang.String nextToken)
```
    The token to retrieve the next page of results.
    
    Parameters:
    
    nextToken - The token to retrieve the next page of results.
  - withNextToken
```
public DescribeInstanceStatusRequest withNextToken(java.lang.String nextToken)
```
    The token to retrieve the next page of results.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    nextToken - The token to retrieve the next page of results.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    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.
  - setMaxResults
```
public void setMaxResults(java.lang.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.
    
    Parameters:
    
    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.
  - withMaxResults
```
public DescribeInstanceStatusRequest withMaxResults(java.lang.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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - isIncludeAllInstances
```
public java.lang.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(java.lang.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(java.lang.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 java.lang.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 java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class DescribeInstanceStatusRequest

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