Class DescribeVolumesRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.ec2.model.DescribeVolumesRequest
All Implemented Interfaces:
ReadLimitInfo, DryRunSupportedRequest<DescribeVolumesRequest>, Serializable, Cloneable

public class DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeVolumesRequest>

Contains the parameters for DescribeVolumes.

See Also:
  • Constructor Details

    • DescribeVolumesRequest

      public DescribeVolumesRequest()
      Default constructor for DescribeVolumesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
    • DescribeVolumesRequest

      public DescribeVolumesRequest(List<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 Details

    • getVolumeIds

      public List<String> getVolumeIds()

      One or more volume IDs.

      Returns:
      One or more volume IDs.
    • setVolumeIds

      public void setVolumeIds(Collection<String> volumeIds)

      One or more volume IDs.

      Parameters:
      volumeIds - One or more volume IDs.
    • withVolumeIds

      public DescribeVolumesRequest withVolumeIds(String... volumeIds)

      One or more volume IDs.

      NOTE: This method appends the values to the existing list (if any). Use setVolumeIds(java.util.Collection) or withVolumeIds(java.util.Collection) if you want to override the existing values.

      Parameters:
      volumeIds - One or more volume IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withVolumeIds

      public DescribeVolumesRequest withVolumeIds(Collection<String> volumeIds)

      One or more volume IDs.

      Parameters:
      volumeIds - One or more volume IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getFilters

      public 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(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.

      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.

      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:
      Returns a reference to this object so that method calls can be chained together.
    • withFilters

      public DescribeVolumesRequest withFilters(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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setNextToken

      public void setNextToken(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.
    • getNextToken

      public 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.
    • withNextToken

      public DescribeVolumesRequest withNextToken(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMaxResults

      public void setMaxResults(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.
    • getMaxResults

      public 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.
    • withMaxResults

      public DescribeVolumesRequest withMaxResults(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.
      Returns:
      Returns a reference to this 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 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DescribeVolumesRequest 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: