com.amazonaws.services.ec2.model
Class DescribeVolumeStatusRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.ec2.model.DescribeVolumeStatusRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeVolumeStatusRequest>, java.io.Serializable

public class DescribeVolumeStatusRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeVolumeStatusRequest>

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 may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes .

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.

NOTE: 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.)

See Also:

AmazonEC2.describeVolumeStatus(DescribeVolumeStatusRequest), Serialized Form

Constructor Summary

DescribeVolumeStatusRequest()

Method Summary

boolean	equals(java.lang.Object obj)
Request<DescribeVolumeStatusRequest>	getDryRunRequest() This method is intended for internal use only.
java.util.List<Filter>	getFilters() One or more filters.
java.lang.Integer	getMaxResults() The maximum number of paginated volume items per response.
java.lang.String	getNextToken() The next paginated set of results to return using the pagination token returned by a previous call.
java.util.List<java.lang.String>	getVolumeIds() One or more volume IDs.
int	hashCode()
void	setFilters(java.util.Collection<Filter> filters) One or more filters.
void	setMaxResults(java.lang.Integer maxResults) The maximum number of paginated volume items per response.
void	setNextToken(java.lang.String nextToken) The next paginated set of results to return using the pagination token returned by a previous call.
void	setVolumeIds(java.util.Collection<java.lang.String> volumeIds) One or more volume IDs.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeVolumeStatusRequest	withFilters(java.util.Collection<Filter> filters) One or more filters.
DescribeVolumeStatusRequest	withFilters(Filter... filters) One or more filters.
DescribeVolumeStatusRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of paginated volume items per response.
DescribeVolumeStatusRequest	withNextToken(java.lang.String nextToken) The next paginated set of results to return using the pagination token returned by a previous call.
DescribeVolumeStatusRequest	withVolumeIds(java.util.Collection<java.lang.String> volumeIds) One or more volume IDs.
DescribeVolumeStatusRequest	withVolumeIds(java.lang.String... volumeIds) One or more volume IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeVolumeStatusRequest

public DescribeVolumeStatusRequest()

Method Detail

getVolumeIds

public java.util.List<java.lang.String> getVolumeIds()

One or more volume IDs.

Default: Describes all your volumes.

Returns:

One or more volume IDs.

Default: Describes all your volumes.

setVolumeIds

public void setVolumeIds(java.util.Collection<java.lang.String> volumeIds)

One or more volume IDs.

Default: Describes all your volumes.

Parameters:

volumeIds - One or more volume IDs.

Default: Describes all your volumes.

withVolumeIds

public DescribeVolumeStatusRequest withVolumeIds(java.lang.String... volumeIds)

One or more volume IDs.

Default: Describes all your volumes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

volumeIds - One or more volume IDs.

Default: Describes all your volumes.

Returns:

A reference to this updated object so that method calls can be chained together.

withVolumeIds

public DescribeVolumeStatusRequest withVolumeIds(java.util.Collection<java.lang.String> volumeIds)

One or more volume IDs.

Default: Describes all your volumes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

volumeIds - One or more volume IDs.

Default: Describes all your volumes.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public java.util.List<Filter> getFilters()

One or more 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).

Returns:

One or more 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).

setFilters

public void setFilters(java.util.Collection<Filter> filters)

One or more 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).

Parameters:

filters - One or more 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).

withFilters

public DescribeVolumeStatusRequest withFilters(Filter... filters)

One or more 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).

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - One or more 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).

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeVolumeStatusRequest withFilters(java.util.Collection<Filter> filters)

One or more 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).

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - One or more 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).

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

The next paginated set of results to return using the pagination token returned by a previous call.

Returns:

The next paginated set of results to return using the pagination token returned by a previous call.

setNextToken

public void setNextToken(java.lang.String nextToken)

The next paginated set of results to return using the pagination token returned by a previous call.

Parameters:

nextToken - The next paginated set of results to return using the pagination token returned by a previous call.

withNextToken

public DescribeVolumeStatusRequest withNextToken(java.lang.String nextToken)

The next paginated set of results to return using the pagination token returned by a previous call.

Returns a reference to this object so that method calls can be chained together.

Parameters:

nextToken - The next paginated set of results to return using the pagination token returned by a previous call.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

The maximum number of paginated volume items per response.

Returns:

The maximum number of paginated volume items per response.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of paginated volume items per response.

Parameters:

maxResults - The maximum number of paginated volume items per response.

withMaxResults

public DescribeVolumeStatusRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of paginated volume items per response.

Returns a reference to this object so that method calls can be chained together.

Parameters:

maxResults - The maximum number of paginated volume items per response.

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeVolumeStatusRequest> 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 interface DryRunSupportedRequest<DescribeVolumeStatusRequest>

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object