« blib/lib/Paws/LocationService/GetDevicePosition.pm
↑ Summary
blib/lib/Paws/LocationService/GetDevicePositionHistoryResponse.pm »
| 1 | |||
| 2 | package Paws::LocationService::GetDevicePositionHistory; | ||
| 3 | use Moose; | ||
| 4 | has DeviceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DeviceId', required => 1); | ||
| 5 | has EndTimeExclusive => (is => 'ro', isa => 'Str'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has StartTimeInclusive => (is => 'ro', isa => 'Str'); | ||
| 8 | has TrackerName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'TrackerName', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDevicePositionHistory'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/tracking/v0/trackers/{TrackerName}/devices/{DeviceId}/list-positions'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LocationService::GetDevicePositionHistoryResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::LocationService::GetDevicePositionHistory - Arguments for method GetDevicePositionHistory on L<Paws::LocationService> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetDevicePositionHistory on the | ||
| 27 | L<Amazon Location Service|Paws::LocationService> service. Use the attributes of this class | ||
| 28 | as arguments to method GetDevicePositionHistory. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDevicePositionHistory. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $geo = Paws->service('LocationService'); | ||
| 35 | my $GetDevicePositionHistoryResponse = $geo->GetDevicePositionHistory( | ||
| 36 | DeviceId => 'MyId', | ||
| 37 | TrackerName => 'MyResourceName', | ||
| 38 | EndTimeExclusive => '1970-01-01T01:00:00', # OPTIONAL | ||
| 39 | NextToken => 'MyToken', # OPTIONAL | ||
| 40 | StartTimeInclusive => '1970-01-01T01:00:00', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $DevicePositions = $GetDevicePositionHistoryResponse->DevicePositions; | ||
| 45 | my $NextToken = $GetDevicePositionHistoryResponse->NextToken; | ||
| 46 | |||
| 47 | # Returns a L<Paws::LocationService::GetDevicePositionHistoryResponse> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/geo/GetDevicePositionHistory> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> DeviceId => Str | ||
| 56 | |||
| 57 | The device whose position history you want to retrieve. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 EndTimeExclusive => Str | ||
| 62 | |||
| 63 | Specify the end time for the position history in ISO 8601 | ||
| 64 | (https://www.iso.org/iso-8601-date-and-time-format.html) format: | ||
| 65 | C<YYYY-MM-DDThh:mm:ss.sssZ>. By default, the value will be the time | ||
| 66 | that the request is made. | ||
| 67 | |||
| 68 | Requirement: | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | The time specified for C<EndTimeExclusive> must be after the time for | ||
| 75 | C<StartTimeInclusive>. | ||
| 76 | |||
| 77 | =back | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 NextToken => Str | ||
| 83 | |||
| 84 | The pagination token specifying which page of results to return in the | ||
| 85 | response. If no token is provided, the default page is the first page. | ||
| 86 | |||
| 87 | Default value: C<null> | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 StartTimeInclusive => Str | ||
| 92 | |||
| 93 | Specify the start time for the position history in ISO 8601 | ||
| 94 | (https://www.iso.org/iso-8601-date-and-time-format.html) format: | ||
| 95 | C<YYYY-MM-DDThh:mm:ss.sssZ>. By default, the value will be 24 hours | ||
| 96 | prior to the time that the request is made. | ||
| 97 | |||
| 98 | Requirement: | ||
| 99 | |||
| 100 | =over | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | The time specified for C<StartTimeInclusive> must be before | ||
| 105 | C<EndTimeExclusive>. | ||
| 106 | |||
| 107 | =back | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> TrackerName => Str | ||
| 113 | |||
| 114 | The tracker resource receiving the request for the device position | ||
| 115 | history. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, documenting arguments for method GetDevicePositionHistory in L<Paws::LocationService> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |