Synopsis
Calls the Amazon Elastic Compute Cloud DescribeVolumeStatus API operation.
Syntax
Get-EC2VolumeStatus-VolumeId <String[]>-Filter <Filter[]>-MaxResult <Int32>-NextToken <String>
Description
Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
DescribeVolumeStatus operation provides the following information about the specified volumes: Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitoring the Status of Your Volumes in the Amazon Elastic Compute Cloud User Guide. Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.) This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
Parameters
-Filter <Filter[]>
The filters.
action.code- The action code for the event (for example,enable-volume-io).action.description- A description of the action.action.event-id- The event ID associated with the action.availability-zone- The Availability Zone of the instance.event.description- A description of the event.event.event-id- The event ID.event.event-type- The event type (forio-enabled:passed|failed; forio-performance:io-performance:degraded|io-performance:severely-degraded|io-performance:stalled).event.not-after- The latest end time for the event.event.not-before- The earliest start time for the event.volume-status.details-name- The cause forvolume-status.status(io-enabled|io-performance).volume-status.details-status- The status ofvolume-status.details-name(forio-enabled:passed|failed; forio-performance:normal|degraded|severely-degraded|stalled).volume-status.status- The status of the volume (ok|impaired|warning|insufficient-data).
| Required? | False |
| Position? | 2 |
| Accept pipeline input? | False |
| Aliases | Filters |
-MaxResult <Int32>
The maximum number of volume results returned by
DescribeVolumeStatus in paginated output. When this parameter is used, the request 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 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 DescribeVolumeStatus 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 |
| Aliases | MaxItems, MaxResults |
-NextToken <String>
The
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-VolumeId <String[]>
The IDs of the volumes.Default: Describes all your volumes.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
| Aliases | VolumeIds |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AK |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
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 |
| Aliases | AWSProfilesLocation, ProfilesLocation |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AWSProfileName, StoredCredentials |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | SecretAccessKey, SK |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ST |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | RegionToCall |
-EndpointUrl <String>
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 |
Inputs
You can pipe a String[] object to this cmdlet for the VolumeId parameter.
Outputs
This cmdlet returns a collection of Amazon.EC2.Model.VolumeStatusItem objects.
The service call response (type Amazon.EC2.Model.DescribeVolumeStatusResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)
Examples
Example 1
PS C:\> Get-EC2VolumeStatus -VolumeId vol-12345678
Actions : {}
AvailabilityZone : us-west-2a
Events : {}
VolumeId : vol-12345678
VolumeStatus : Amazon.EC2.Model.VolumeStatusInfo
PS C:\> (Get-EC2VolumeStatus -VolumeId vol-12345678).VolumeStatus
Details Status
------- ------
{io-enabled, io-performance} ok
PS C:\> (Get-EC2VolumeStatus -VolumeId vol-12345678).VolumeStatus.Details
Name Status
---- ------
io-enabled passed
io-performance not-applicableThis example describes the status of the specified volume.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
