NAME

Paws::EC2::DescribeVolumeStatus - Arguments for method DescribeVolumeStatus on Paws::EC2

DESCRIPTION

This class represents the parameters used for calling the method DescribeVolumeStatus on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method DescribeVolumeStatus.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeVolumeStatus.

SYNOPSIS

  my $ec2 = Paws->service('EC2');
 # To describe the status of a single volume
 # This example describes the status for the volume ``vol-1234567890abcdef0``.
  my $DescribeVolumeStatusResult =
    $ec2->DescribeVolumeStatus( 'VolumeIds' => ['vol-1234567890abcdef0'] );

  # Results:
  my $VolumeStatuses = $DescribeVolumeStatusResult->VolumeStatuses;

# Returns a L<Paws::EC2::DescribeVolumeStatusResult> object.
# To describe the status of impaired volumes
# This example describes the status for all volumes that are impaired. In this
# example output, there are no impaired volumes.
  my $DescribeVolumeStatusResult = $ec2->DescribeVolumeStatus(
    'Filters' => [

      {
        'Name'   => 'volume-status.status',
        'Values' => ['impaired']
      }
    ]
  );

  # Results:
  my $VolumeStatuses = $DescribeVolumeStatusResult->VolumeStatuses;

  # Returns a L<Paws::EC2::DescribeVolumeStatusResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeVolumeStatus

ATTRIBUTES

DryRun => Bool

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 UnauthorizedOperation.

Filters => ArrayRef[Paws::EC2::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 (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).

MaxResults => Int

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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 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.

NextToken => Str

The 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.

VolumeIds => ArrayRef[Str|Undef]

The IDs of the volumes.

Default: Describes all your volumes.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeVolumeStatus in Paws::EC2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues