AWSEC2DescribeVolumesRequest Class Reference
|Inherits from||AWSRequest : AWSModel : AWSMTLModel|
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is
@property (nonatomic, strong) NSNumber *dryRun
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,
attachment.instance-id- The ID of the instance the volume is attached to.
attachment.status- The attachment state (
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 (
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-valuefilter. 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-value- The value of a tag assigned to the resource. This filter is independent of the
volume-id- The volume ID.
volume-type- The Amazon EBS volume type. This can be
gp2for General Purpose SSD,
io1for Provisioned IOPS SSD,
st1for Throughput Optimized HDD,
sc1for Cold HDD, or
standardfor Magnetic volumes.
@property (nonatomic, strong) NSArray<AWSEC2Filter*> *filters
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.
@property (nonatomic, strong) NSNumber *maxResults
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.
@property (nonatomic, strong) NSString *nextToken
One or more volume IDs.
@property (nonatomic, strong) NSArray<NSString*> *volumeIds