Lincoln D. Stein > VM-EC2-1.23 > VM::EC2::Volume::Status::Event

Download:
VM-EC2-1.23.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Source   Latest Release: VM-EC2-1.25

NAME ^

VM::EC2::Volume::Status::Event - Object describing a scheduled volume maintenance event

SYNOPSIS ^

 @status_items = $ec2->describe_volume_status();
 for my $i (@status_items) {
    for my $event ($i->events) {
       print $i->volume_id,': ',
             $event->type,' ',
             $event->description, ' ',
             $event->notBefore, ' ',
             $event->notAfter,"\n";
    }
 }

DESCRIPTION ^

This objects describes a scheduled maintenance event on an volume, and is returned by calling the events() method of one of the status item objects returned by $ec2->describe_volume_status().

NOTE: There is an inconsistency in the AWS documentation for this data type. The events field is documented as being a list, but the examples shown show a single object. At release time, I was unable to verify which is correct and have written the code such that it will detect a single value in the response object and return this as a single-element list.

METHODS ^

 eventType     -- The type of event

 eventId       -- The ID of the event

 description   -- A description of the event.

 notBefore     -- The earliest scheduled start time for the event.

 notAfter      -- The latest scheduled end time for the event.

 type          -- Alias for eventType
 
 id            -- Alias for eventId

When used in a string context, this object interpolates as a string using the eventType.

SEE ALSO ^

VM::EC2 VM::EC2::Generic VM::EC2::Volume VM::EC2::Volume::Status VM::EC2::Volume::StatusItem VM::EC2::Volume::Status::Details VM::EC2::Tag

AUTHOR ^

Lincoln Stein <lincoln.stein@gmail.com>.

Copyright (c) 2012 Ontario Institute for Cancer Research

This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the GPL (either version 1, or at your option, any later version) or the Artistic License 2.0. Refer to LICENSE for the full license text. In addition, please see DISCLAIMER.txt for disclaimers of warranty.

syntax highlighting: