/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the ec2-2016-11-15.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.EC2.Model
{
///
/// Container for the parameters to the DescribeVolumeStatus operation.
/// 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 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 might still be taking place on your volume at the time. We recommend
/// that you retry the request. For more information about volume status, see Monitor
/// the status of your volumes in the Amazon Elastic Compute Cloud User Guide.
///
///
///
/// Events: Reflect the cause of a volume status and might 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 might have inconsistent data.
///
///
///
/// Actions: Reflect the actions you might 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.)
///
///
public partial class DescribeVolumeStatusRequest : AmazonEC2Request
{
private List _filters = new List();
private int? _maxResults;
private string _nextToken;
private List _volumeIds = new List();
///
/// Gets and sets the property Filters.
///
/// 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 (for io-enabled
: passed
/// | failed
; for io-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 for volume-status.status
/// (io-enabled
| io-performance
).
///
/// -
///
///
volume-status.details-status
- The status of volume-status.details-name
/// (for io-enabled
: passed
| failed
; for io-performance
:
/// normal
| degraded
| severely-degraded
| stalled
).
///
/// -
///
///
volume-status.status
- The status of the volume (ok
| impaired
/// | warning
| insufficient-data
).
///
///
///
public List Filters
{
get { return this._filters; }
set { this._filters = value; }
}
// Check to see if Filters property is set
internal bool IsSetFilters()
{
return this._filters != null && this._filters.Count > 0;
}
///
/// Gets and sets the property MaxResults.
///
/// The maximum number of items to return for this request. To get the next page of items,
/// make another request with the token returned in the output. This value can be between
/// 5 and 1,000; if the value is larger than 1,000, only 1,000 results are returned. If
/// this parameter is not used, then all items are returned. You cannot specify this parameter
/// and the volume IDs parameter in the same request. For more information, see Pagination.
///
///
public int MaxResults
{
get { return this._maxResults.GetValueOrDefault(); }
set { this._maxResults = value; }
}
// Check to see if MaxResults property is set
internal bool IsSetMaxResults()
{
return this._maxResults.HasValue;
}
///
/// Gets and sets the property NextToken.
///
/// The token returned from a previous paginated request. Pagination continues from the
/// end of the items returned by the previous request.
///
///
public string NextToken
{
get { return this._nextToken; }
set { this._nextToken = value; }
}
// Check to see if NextToken property is set
internal bool IsSetNextToken()
{
return this._nextToken != null;
}
///
/// Gets and sets the property VolumeIds.
///
/// The IDs of the volumes.
///
///
///
/// Default: Describes all your volumes.
///
///
public List VolumeIds
{
get { return this._volumeIds; }
set { this._volumeIds = value; }
}
// Check to see if VolumeIds property is set
internal bool IsSetVolumeIds()
{
return this._volumeIds != null && this._volumeIds.Count > 0;
}
}
}