DescribeInstancesRequest (AWS SDK for Java

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

All Implemented Interfaces:

DryRunSupportedRequest<DescribeInstancesRequest>, Serializable
```
public class DescribeInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeInstancesRequest>
```
Container for the parameters to the DescribeInstances operation.
The DescribeInstances operation returns information about instances that you own.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

See Also:
AmazonEC2.describeInstances(DescribeInstancesRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeInstancesRequest()

Constructors
Constructor and Description
`DescribeInstancesRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Request<DescribeInstancesRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`List<Filter>`	`getFilters()` A list of filters used to match properties for Instances.
`List<String>`	`getInstanceIds()` An optional list of the instances to describe.
`Integer`	`getMaxResults()` Returns the value of the MaxResults property for this object.
`String`	`getNextToken()` Returns the value of the NextToken property for this object.
`int`	`hashCode()`
`void`	`setFilters(Collection<Filter> filters)` A list of filters used to match properties for Instances.
`void`	`setInstanceIds(Collection<String> instanceIds)` An optional list of the instances to describe.
`void`	`setMaxResults(Integer maxResults)` Sets the value of the MaxResults property for this object.
`void`	`setNextToken(String nextToken)` Sets the value of the NextToken property for this object.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeInstancesRequest`	`withFilters(Collection<Filter> filters)` A list of filters used to match properties for Instances.
`DescribeInstancesRequest`	`withFilters(Filter... filters)` A list of filters used to match properties for Instances.
`DescribeInstancesRequest`	`withInstanceIds(Collection<String> instanceIds)` An optional list of the instances to describe.
`DescribeInstancesRequest`	`withInstanceIds(String... instanceIds)` An optional list of the instances to describe.
`DescribeInstancesRequest`	`withMaxResults(Integer maxResults)` Sets the value of the MaxResults property for this object.
`DescribeInstancesRequest`	`withNextToken(String nextToken)` Sets the value of the NextToken property for this object.

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

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

- Constructor Detail
  - DescribeInstancesRequest
```
public DescribeInstancesRequest()
```
- Method Detail
  - getInstanceIds
```
public List<String> getInstanceIds()
```
    An optional list of the instances to describe.
    
    Returns:
    An optional list of the instances to describe.
  - setInstanceIds
```
public void setInstanceIds(Collection<String> instanceIds)
```
    An optional list of the instances to describe.
    
    Parameters:
    instanceIds - An optional list of the instances to describe.
  - withInstanceIds
```
public DescribeInstancesRequest withInstanceIds(String... instanceIds)
```
    An optional list of the instances to describe.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    instanceIds - An optional list of the instances to describe.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withInstanceIds
```
public DescribeInstancesRequest withInstanceIds(Collection<String> instanceIds)
```
    An optional list of the instances to describe.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    instanceIds - An optional list of the instances to describe.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getFilters
```
public List<Filter> getFilters()
```
    A list of filters used to match properties for Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Returns:
    A list of filters used to match properties for Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
  - setFilters
```
public void setFilters(Collection<Filter> filters)
```
    A list of filters used to match properties for Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Parameters:
    filters - A list of filters used to match properties for Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
  - withFilters
```
public DescribeInstancesRequest withFilters(Filter... filters)
```
    A list of filters used to match properties for Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    filters - A list of filters used to match properties for Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withFilters
```
public DescribeInstancesRequest withFilters(Collection<Filter> filters)
```
    A list of filters used to match properties for Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    filters - A list of filters used to match properties for Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public String getNextToken()
```
    Returns the value of the NextToken property for this object.
    
    Returns:
    The value of the NextToken property for this object.
  - setNextToken
```
public void setNextToken(String nextToken)
```
    Sets the value of the NextToken property for this object.
    
    Parameters:
    nextToken - The new value for the NextToken property for this object.
  - withNextToken
```
public DescribeInstancesRequest withNextToken(String nextToken)
```
    Sets the value of the NextToken property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    nextToken - The new value for the NextToken property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMaxResults
```
public Integer getMaxResults()
```
    Returns the value of the MaxResults property for this object.
    
    Returns:
    The value of the MaxResults property for this object.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    Sets the value of the MaxResults property for this object.
    
    Parameters:
    maxResults - The new value for the MaxResults property for this object.
  - withMaxResults
```
public DescribeInstancesRequest withMaxResults(Integer maxResults)
```
    Sets the value of the MaxResults property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    maxResults - The new value for the MaxResults property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDryRunRequest
```
public Request<DescribeInstancesRequest> 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<DescribeInstancesRequest>
  - 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

Did this page help you?

Class DescribeInstancesRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeInstancesRequest

Method Detail

getInstanceIds

setInstanceIds

withInstanceIds

withInstanceIds

getFilters

setFilters

withFilters

withFilters

getNextToken

setNextToken

withNextToken

getMaxResults

setMaxResults

withMaxResults

getDryRunRequest

toString

hashCode

equals