DescribeInstanceStatusRequest (AWS SDK For Java for OSGi 1.10.21 API)

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

All Implemented Interfaces:

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

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

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
`DescribeInstanceStatusRequest`	`clone()` Creates a shallow clone of this request.
`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 results to return for the request in a single page.
`String`	`getNextToken()` The token to retrieve the next page of results.
`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 results to return for the request in a single page.
`void`	`setNextToken(String nextToken)` The token to retrieve the next page of results.
`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 results to return for the request in a single page.
`DescribeInstanceStatusRequest`	`withNextToken(String nextToken)` The token to retrieve the next page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
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.
    NOTE: This method appends the values to the existing list (if any). Use setInstanceIds(java.util.Collection) or withInstanceIds(java.util.Collection) if you want to override the existing values.
    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 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(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).
    NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.
    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(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 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(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(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 Integer getMaxResults()
```
    The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.
    
    Returns:
    The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.
    
    Parameters:
    maxResults - The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.
  - withMaxResults
```
public DescribeInstanceStatusRequest withMaxResults(Integer maxResults)
```
    The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    maxResults - The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.
    
    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
  - clone
```
public DescribeInstanceStatusRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    Object.clone()

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

clone