« blib/lib/Paws/LocationService/BatchDeleteGeofenceResponse.pm
↑ Summary
blib/lib/Paws/LocationService/BatchEvaluateGeofencesError.pm »
| 1 | |||
| 2 | package Paws::LocationService::BatchEvaluateGeofences; | ||
| 3 | use Moose; | ||
| 4 | has CollectionName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'CollectionName', required => 1); | ||
| 5 | has DevicePositionUpdates => (is => 'ro', isa => 'ArrayRef[Paws::LocationService::DevicePositionUpdate]', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'BatchEvaluateGeofences'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/geofencing/v0/collections/{CollectionName}/positions'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LocationService::BatchEvaluateGeofencesResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::LocationService::BatchEvaluateGeofences - Arguments for method BatchEvaluateGeofences on L<Paws::LocationService> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method BatchEvaluateGeofences on the | ||
| 24 | L<Amazon Location Service|Paws::LocationService> service. Use the attributes of this class | ||
| 25 | as arguments to method BatchEvaluateGeofences. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchEvaluateGeofences. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $geo = Paws->service('LocationService'); | ||
| 32 | my $BatchEvaluateGeofencesResponse = $geo->BatchEvaluateGeofences( | ||
| 33 | CollectionName => 'MyResourceName', | ||
| 34 | DevicePositionUpdates => [ | ||
| 35 | { | ||
| 36 | DeviceId => 'MyId', # min: 1, max: 100 | ||
| 37 | Position => [ 1, ... ], # min: 2, max: 2 | ||
| 38 | SampleTime => '1970-01-01T01:00:00', | ||
| 39 | |||
| 40 | }, | ||
| 41 | ... | ||
| 42 | ], | ||
| 43 | |||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $Errors = $BatchEvaluateGeofencesResponse->Errors; | ||
| 48 | |||
| 49 | # Returns a L<Paws::LocationService::BatchEvaluateGeofencesResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/geo/BatchEvaluateGeofences> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> CollectionName => Str | ||
| 58 | |||
| 59 | The geofence collection used in evaluating the position of devices | ||
| 60 | against its geofences. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> DevicePositionUpdates => ArrayRef[L<Paws::LocationService::DevicePositionUpdate>] | ||
| 65 | |||
| 66 | Contains device details for each device to be evaluated against the | ||
| 67 | given geofence collection. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head1 SEE ALSO | ||
| 73 | |||
| 74 | This class forms part of L<Paws>, documenting arguments for method BatchEvaluateGeofences in L<Paws::LocationService> | ||
| 75 | |||
| 76 | =head1 BUGS and CONTRIBUTIONS | ||
| 77 | |||
| 78 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 79 | |||
| 80 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 81 | |||
| 82 | =cut | ||
| 83 |