« blib/lib/Paws/LocationService/ListGeofenceCollectionsResponseEntry.pm
↑ Summary
blib/lib/Paws/LocationService/ListGeofences.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LocationService::ListGeofenceResponseEntry; | ||
| 3 | use Moose; | ||
| 4 | has CreateTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has GeofenceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Geometry => (is => 'ro', isa => 'Paws::LocationService::GeofenceGeometry', required => 1); | ||
| 7 | has Status => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has UpdateTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::LocationService::ListGeofenceResponseEntry | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::LocationService::ListGeofenceResponseEntry object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CreateTime => $value, ..., UpdateTime => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::LocationService::ListGeofenceResponseEntry object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CreateTime | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Contains a list of geofences stored in a given geofence collection. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> CreateTime => Str | ||
| 46 | |||
| 47 | The timestamp for when the geofence was stored in a geofence collection | ||
| 48 | in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) | ||
| 49 | format: C<YYYY-MM-DDThh:mm:ss.sssZ> | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> GeofenceId => Str | ||
| 53 | |||
| 54 | The geofence identifier. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> Geometry => L<Paws::LocationService::GeofenceGeometry> | ||
| 58 | |||
| 59 | Contains the geofence geometry details describing a polygon. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> Status => Str | ||
| 63 | |||
| 64 | Identifies the state of the geofence. A geofence will hold one of the | ||
| 65 | following states: | ||
| 66 | |||
| 67 | =over | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<ACTIVE> E<mdash> The geofence has been indexed by the system. | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | C<PENDING> E<mdash> The geofence is being processed by the system. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<FAILED> E<mdash> The geofence failed to be indexed by the system. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<DELETED> E<mdash> The geofence has been deleted from the system | ||
| 84 | index. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<DELETING> E<mdash> The geofence is being deleted from the system | ||
| 89 | index. | ||
| 90 | |||
| 91 | =back | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> UpdateTime => Str | ||
| 96 | |||
| 97 | The timestamp for when the geofence was last updated in ISO 8601 | ||
| 98 | (https://www.iso.org/iso-8601-date-and-time-format.html) format: | ||
| 99 | C<YYYY-MM-DDThh:mm:ss.sssZ> | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, describing an object used in L<Paws::LocationService> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |