com.amazonaws.services.ec2.model

Class DescribeVolumesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeVolumesRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeVolumesRequest>, Serializable

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

Container for the parameters to the DescribeVolumes operation.

Describes the specified Amazon EBS volumes.

For more information about Amazon 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(List<String> volumeIds) Constructs a new DescribeVolumesRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Request<DescribeVolumesRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
List<String>	getVolumeIds() One or more volume IDs.
int	hashCode()
void	setFilters(Collection<Filter> filters) One or more filters.
void	setVolumeIds(Collection<String> volumeIds) One or more volume IDs.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeVolumesRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeVolumesRequest	withFilters(Filter... filters) One or more filters.
DescribeVolumesRequest	withVolumeIds(Collection<String> volumeIds) One or more volume IDs.
DescribeVolumesRequest	withVolumeIds(String... volumeIds) One or more volume IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, 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(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 Detail

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.

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(Collection<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 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) volumes, io1 for Provisioned IOPS (SSD) volumes, 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) volumes, io1 for Provisioned IOPS (SSD) volumes, 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) volumes, io1 for Provisioned IOPS (SSD) volumes, 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) volumes, io1 for Provisioned IOPS (SSD) volumes, 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) volumes, io1 for Provisioned IOPS (SSD) volumes, 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) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Returns:

A reference to this updated 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) volumes, io1 for Provisioned IOPS (SSD) volumes, 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) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

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 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