DescribeVolumesRequest (AWS SDK for Android

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

All Implemented Interfaces:

DryRunSupportedRequest<DescribeVolumesRequest>, java.io.Serializable, java.lang.Cloneable
```
public class DescribeVolumesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeVolumesRequest>
```
Container for the parameters to the DescribeVolumes operation.
Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.describeVolumes(DescribeVolumesRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description
`DescribeVolumesRequest()` Default constructor for a new DescribeVolumesRequest object.
`DescribeVolumesRequest(java.util.List<java.lang.String> volumeIds)` Constructs a new DescribeVolumesRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`Request<DescribeVolumesRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`java.util.List<Filter>`	`getFilters()` One or more filters.
`java.lang.Integer`	`getMaxResults()` The maximum number of volume results returned by `DescribeVolumes` in paginated output.
`java.lang.String`	`getNextToken()` The `NextToken` value returned from a previous paginated `DescribeVolumes` request where `MaxResults` was used and the results exceeded the value of that parameter.
`java.util.List<java.lang.String>`	`getVolumeIds()` One or more volume IDs.
`int`	`hashCode()`
`void`	`setFilters(java.util.Collection<Filter> filters)` One or more filters.
`void`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of volume results returned by `DescribeVolumes` in paginated output.
`void`	`setNextToken(java.lang.String nextToken)` The `NextToken` value returned from a previous paginated `DescribeVolumes` request where `MaxResults` was used and the results exceeded the value of that parameter.
`void`	`setVolumeIds(java.util.Collection<java.lang.String> volumeIds)` One or more volume IDs.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeVolumesRequest`	`withFilters(java.util.Collection<Filter> filters)` One or more filters.
`DescribeVolumesRequest`	`withFilters(Filter... filters)` One or more filters.
`DescribeVolumesRequest`	`withMaxResults(java.lang.Integer maxResults)` The maximum number of volume results returned by `DescribeVolumes` in paginated output.
`DescribeVolumesRequest`	`withNextToken(java.lang.String nextToken)` The `NextToken` value returned from a previous paginated `DescribeVolumes` request where `MaxResults` was used and the results exceeded the value of that parameter.
`DescribeVolumesRequest`	`withVolumeIds(java.util.Collection<java.lang.String> volumeIds)` One or more volume IDs.
`DescribeVolumesRequest`	`withVolumeIds(java.lang.String... volumeIds)` One or more volume IDs.

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
  - DescribeVolumesRequest
```
public DescribeVolumesRequest()
```
    Default constructor for a new DescribeVolumesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
  - DescribeVolumesRequest
```
public DescribeVolumesRequest(java.util.List<java.lang.String> volumeIds)
```
    Constructs a new DescribeVolumesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    
    volumeIds - One or more volume IDs.
- Method Detail
  - getVolumeIds
```
public java.util.List<java.lang.String> getVolumeIds()
```
    One or more volume IDs.
    
    Returns:
    
    One or more volume IDs.
  - setVolumeIds
```
public void setVolumeIds(java.util.Collection<java.lang.String> volumeIds)
```
    One or more volume IDs.
    
    Parameters:
    
    volumeIds - One or more volume IDs.
  - withVolumeIds
```
public DescribeVolumesRequest withVolumeIds(java.lang.String... volumeIds)
```
    One or more volume IDs.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    volumeIds - One or more volume IDs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withVolumeIds
```
public DescribeVolumesRequest withVolumeIds(java.util.Collection<java.lang.String> volumeIds)
```
    One or more volume IDs.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    volumeIds - One or more volume 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.
    - attachment.attach-time - The time stamp when the attachment initiated.
    - attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    - attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
    - attachment.instance-id - The ID of the instance the volume is attached to.
    - attachment.status - The attachment state (attaching | attached | detaching | detached).
    - availability-zone - The Availability Zone in which the volume was created.
    - create-time - The time stamp when the volume was created.
    - encrypted - The encryption status of the volume.
    - size - The size of the volume, in GiB.
    - snapshot-id - The snapshot from which the volume was created.
    - status - The status of the volume (creating | available | in-use | deleting | deleted | error).
    - tag:key=value - The key/value combination of a tag assigned to the resource.
    - tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
    - tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
    - volume-id - The volume ID.
    - volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    Returns:
    One or more filters.
    
    attachment.attach-time - The time stamp when the attachment initiated.
    
    attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    
    attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
    
    attachment.instance-id - The ID of the instance the volume is attached to.
    
    attachment.status - The attachment state (attaching | attached | detaching | detached).
    
    availability-zone - The Availability Zone in which the volume was created.
    
    create-time - The time stamp when the volume was created.
    
    encrypted - The encryption status of the volume.
    
    size - The size of the volume, in GiB.
    
    snapshot-id - The snapshot from which the volume was created.
    
    status - The status of the volume (creating | available | in-use | deleting | deleted | error).
    
    tag:key=value - The key/value combination of a tag assigned to the resource.
    
    tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
    
    tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
    
    volume-id - The volume ID.
    
    volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
  - setFilters
```
public void setFilters(java.util.Collection<Filter> filters)
```
    One or more filters.
    - attachment.attach-time - The time stamp when the attachment initiated.
    - attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    - attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
    - attachment.instance-id - The ID of the instance the volume is attached to.
    - attachment.status - The attachment state (attaching | attached | detaching | detached).
    - availability-zone - The Availability Zone in which the volume was created.
    - create-time - The time stamp when the volume was created.
    - encrypted - The encryption status of the volume.
    - size - The size of the volume, in GiB.
    - snapshot-id - The snapshot from which the volume was created.
    - status - The status of the volume (creating | available | in-use | deleting | deleted | error).
    - tag:key=value - The key/value combination of a tag assigned to the resource.
    - tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
    - tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
    - volume-id - The volume ID.
    - volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    Parameters:
    filters - One or more filters.
    
    attachment.attach-time - The time stamp when the attachment initiated.
    
    attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    
    attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
    
    attachment.instance-id - The ID of the instance the volume is attached to.
    
    attachment.status - The attachment state (attaching | attached | detaching | detached).
    
    availability-zone - The Availability Zone in which the volume was created.
    
    create-time - The time stamp when the volume was created.
    
    encrypted - The encryption status of the volume.
    
    size - The size of the volume, in GiB.
    
    snapshot-id - The snapshot from which the volume was created.
    
    status - The status of the volume (creating | available | in-use | deleting | deleted | error).
    
    tag:key=value - The key/value combination of a tag assigned to the resource.
    
    tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
    
    tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
    
    volume-id - The volume ID.
    
    volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
  - withFilters
```
public DescribeVolumesRequest withFilters(Filter... filters)
```
    One or more filters.
    - attachment.attach-time - The time stamp when the attachment initiated.
    - attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    - attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
    - attachment.instance-id - The ID of the instance the volume is attached to.
    - attachment.status - The attachment state (attaching | attached | detaching | detached).
    - availability-zone - The Availability Zone in which the volume was created.
    - create-time - The time stamp when the volume was created.
    - encrypted - The encryption status of the volume.
    - size - The size of the volume, in GiB.
    - snapshot-id - The snapshot from which the volume was created.
    - status - The status of the volume (creating | available | in-use | deleting | deleted | error).
    - tag:key=value - The key/value combination of a tag assigned to the resource.
    - tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
    - tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
    - volume-id - The volume ID.
    - volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    filters - One or more filters.
    
    attachment.attach-time - The time stamp when the attachment initiated.
    
    attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    
    attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
    
    attachment.instance-id - The ID of the instance the volume is attached to.
    
    attachment.status - The attachment state (attaching | attached | detaching | detached).
    
    availability-zone - The Availability Zone in which the volume was created.
    
    create-time - The time stamp when the volume was created.
    
    encrypted - The encryption status of the volume.
    
    size - The size of the volume, in GiB.
    
    snapshot-id - The snapshot from which the volume was created.
    
    status - The status of the volume (creating | available | in-use | deleting | deleted | error).
    
    tag:key=value - The key/value combination of a tag assigned to the resource.
    
    tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
    
    tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
    
    volume-id - The volume ID.
    
    volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withFilters
```
public DescribeVolumesRequest withFilters(java.util.Collection<Filter> filters)
```
    One or more filters.
    - attachment.attach-time - The time stamp when the attachment initiated.
    - attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    - attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
    - attachment.instance-id - The ID of the instance the volume is attached to.
    - attachment.status - The attachment state (attaching | attached | detaching | detached).
    - availability-zone - The Availability Zone in which the volume was created.
    - create-time - The time stamp when the volume was created.
    - encrypted - The encryption status of the volume.
    - size - The size of the volume, in GiB.
    - snapshot-id - The snapshot from which the volume was created.
    - status - The status of the volume (creating | available | in-use | deleting | deleted | error).
    - tag:key=value - The key/value combination of a tag assigned to the resource.
    - tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
    - tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
    - volume-id - The volume ID.
    - volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    filters - One or more filters.
    
    attachment.attach-time - The time stamp when the attachment initiated.
    
    attachment.delete-on-termination - Whether the volume is deleted on instance termination.
    
    attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
    
    attachment.instance-id - The ID of the instance the volume is attached to.
    
    attachment.status - The attachment state (attaching | attached | detaching | detached).
    
    availability-zone - The Availability Zone in which the volume was created.
    
    create-time - The time stamp when the volume was created.
    
    encrypted - The encryption status of the volume.
    
    size - The size of the volume, in GiB.
    
    snapshot-id - The snapshot from which the volume was created.
    
    status - The status of the volume (creating | available | in-use | deleting | deleted | error).
    
    tag:key=value - The key/value combination of a tag assigned to the resource.
    
    tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
    
    tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
    
    volume-id - The volume ID.
    
    volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public java.lang.String getNextToken()
```
    The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
    
    Returns:
    
    The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
  - setNextToken
```
public void setNextToken(java.lang.String nextToken)
```
    The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
    
    Parameters:
    
    nextToken - The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
  - withNextToken
```
public DescribeVolumesRequest withNextToken(java.lang.String nextToken)
```
    The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    nextToken - The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
    
    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 volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes 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. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
    
    Returns:
    
    The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes 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. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
  - setMaxResults
```
public void setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes 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. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
    
    Parameters:
    
    maxResults - The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes 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. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
  - withMaxResults
```
public DescribeVolumesRequest withMaxResults(java.lang.Integer maxResults)
```
    The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes 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. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume 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 volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes 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. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDryRunRequest
```
public Request<DescribeVolumesRequest> 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<DescribeVolumesRequest>
  - 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 DescribeVolumesRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeVolumesRequest

DescribeVolumesRequest

Method Detail

getVolumeIds

setVolumeIds

withVolumeIds

withVolumeIds

getFilters

setFilters

withFilters

withFilters

getNextToken

setNextToken

withNextToken

getMaxResults

setMaxResults

withMaxResults

getDryRunRequest

toString

hashCode

equals