Class DescribeVolumesRequest
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeVolumesRequest>
,Serializable
,Cloneable
Contains the parameters for DescribeVolumes.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for DescribeVolumesRequest object.DescribeVolumesRequest
(List<String> volumeIds) Constructs a new DescribeVolumesRequest object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
This method is intended for internal use only.One or more filters.The maximum number of volume results returned byDescribeVolumes
in paginated output.TheNextToken
value returned from a previous paginatedDescribeVolumes
request whereMaxResults
was used and the results exceeded the value of that parameter.One or more volume IDs.int
hashCode()
void
setFilters
(Collection<Filter> filters) One or more filters.void
setMaxResults
(Integer maxResults) The maximum number of volume results returned byDescribeVolumes
in paginated output.void
setNextToken
(String nextToken) TheNextToken
value returned from a previous paginatedDescribeVolumes
request whereMaxResults
was used and the results exceeded the value of that parameter.void
setVolumeIds
(Collection<String> volumeIds) One or more volume IDs.toString()
Returns a string representation of this object; useful for testing and debugging.withFilters
(Filter... filters) One or more filters.withFilters
(Collection<Filter> filters) One or more filters.withMaxResults
(Integer maxResults) The maximum number of volume results returned byDescribeVolumes
in paginated output.withNextToken
(String nextToken) TheNextToken
value returned from a previous paginatedDescribeVolumes
request whereMaxResults
was used and the results exceeded the value of that parameter.withVolumeIds
(String... volumeIds) One or more volume IDs.withVolumeIds
(Collection<String> volumeIds) One or more volume IDs.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
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
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
One or more volume IDs.
- Returns:
- One or more volume IDs.
-
setVolumeIds
One or more volume IDs.
- Parameters:
volumeIds
- One or more volume IDs.
-
withVolumeIds
One or more volume IDs.
NOTE: This method appends the values to the existing list (if any). Use
setVolumeIds(java.util.Collection)
orwithVolumeIds(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
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
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
volume-id
- The volume ID. -
volume-type
- The Amazon EBS volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
volume-id
- The volume ID. -
volume-type
- The Amazon EBS volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.
-
-
-
setFilters
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
volume-id
- The volume ID. -
volume-type
- The Amazon EBS volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
volume-id
- The volume ID. -
volume-type
- The Amazon EBS volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.
-
-
-
withFilters
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
volume-id
- The volume ID. -
volume-type
- The Amazon EBS volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.
NOTE: This method appends the values to the existing list (if any). Use
setFilters(java.util.Collection)
orwithFilters(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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
volume-id
- The volume ID. -
volume-type
- The Amazon EBS volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
withFilters
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
volume-id
- The volume ID. -
volume-type
- The Amazon EBS volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
volume-id
- The volume ID. -
volume-type
- The Amazon EBS volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setNextToken
The
NextToken
value returned from a previous paginatedDescribeVolumes
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- Parameters:
nextToken
- TheNextToken
value returned from a previous paginatedDescribeVolumes
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.
-
getNextToken
The
NextToken
value returned from a previous paginatedDescribeVolumes
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- Returns:
- The
NextToken
value returned from a previous paginatedDescribeVolumes
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.
-
withNextToken
The
NextToken
value returned from a previous paginatedDescribeVolumes
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- Parameters:
nextToken
- TheNextToken
value returned from a previous paginatedDescribeVolumes
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxResults
The maximum number of volume results returned by
DescribeVolumes
in paginated output. When this parameter is used,DescribeVolumes
only returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeVolumes
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeVolumes
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 byDescribeVolumes
in paginated output. When this parameter is used,DescribeVolumes
only returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeVolumes
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeVolumes
returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
-
getMaxResults
The maximum number of volume results returned by
DescribeVolumes
in paginated output. When this parameter is used,DescribeVolumes
only returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeVolumes
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeVolumes
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 returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeVolumes
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeVolumes
returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
-
withMaxResults
The maximum number of volume results returned by
DescribeVolumes
in paginated output. When this parameter is used,DescribeVolumes
only returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeVolumes
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeVolumes
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 byDescribeVolumes
in paginated output. When this parameter is used,DescribeVolumes
only returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeVolumes
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeVolumes
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
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 interfaceDryRunSupportedRequest<DescribeVolumesRequest>
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-