AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
ByFilter (Default)
Get-EC2Volume-Filter <Filter[]>-MaxResult <Int32>-NextToken <String>ByID
Get-EC2Volume-VolumeId <String[]>
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. 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 specified in the block device mapping (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. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose
for the filter name and X
for the filter value.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.Required? | False |
Position? | 2 |
Accept pipeline input? | False |
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 500; if MaxResults
is given a value larger than 500, only 500 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.Required? | False |
Position? | Named |
Accept pipeline input? | False |
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.Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required? | False |
Position? | Named |
Accept pipeline input? | False |
PS C:\> Get-EC2Volume -VolumeId vol-12345678
Attachments : {}
AvailabilityZone : us-west-2c
CreateTime : 7/17/2015 4:35:19 PM
Encrypted : False
Iops : 90
KmsKeyId :
Size : 30
SnapshotId : snap-12345678
State : in-use
Tags : {}
VolumeId : vol-12345678
VolumeType : standardThis example describes the specified EBS volume.
PS C:\> Get-EC2Volume -Filter @{ Name="status"; Values="available" }
Attachments : {}
AvailabilityZone : us-west-2c
CreateTime : 12/21/2015 2:31:29 PM
Encrypted : False
Iops : 60
KmsKeyId :
Size : 20
SnapshotId : snap-12345678
State : available
Tags : {}
VolumeId : vol-12345678
VolumeType : gp2
...
This example describes your EBS volumes that have the status 'available'.
PS C:\> Get-EC2VolumeThis example describes all your EBS volumes.
AWS Tools for PowerShell: 2.x.y.z