« blib/lib/Paws/IoT1ClickDevices/InvokeDeviceMethodResponse.pm
↑ Summary
blib/lib/Paws/IoT1ClickDevices/ListDeviceEventsResponse.pm »
| 1 | |||
| 2 | package Paws::IoT1ClickDevices::ListDeviceEvents; | ||
| 3 | use Moose; | ||
| 4 | has DeviceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'deviceId', required => 1); | ||
| 5 | has FromTimeStamp => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'fromTimeStamp', required => 1); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 8 | has ToTimeStamp => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'toTimeStamp', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListDeviceEvents'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/devices/{deviceId}/events'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT1ClickDevices::ListDeviceEventsResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IoT1ClickDevices::ListDeviceEvents - Arguments for method ListDeviceEvents on L<Paws::IoT1ClickDevices> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListDeviceEvents on the | ||
| 27 | L<AWS IoT 1-Click Devices Service|Paws::IoT1ClickDevices> service. Use the attributes of this class | ||
| 28 | as arguments to method ListDeviceEvents. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListDeviceEvents. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $devices.iot1click = Paws->service('IoT1ClickDevices'); | ||
| 35 | my $ListDeviceEventsResponse = $devices . iot1click->ListDeviceEvents( | ||
| 36 | DeviceId => 'My__string', | ||
| 37 | FromTimeStamp => '1970-01-01T01:00:00', | ||
| 38 | ToTimeStamp => '1970-01-01T01:00:00', | ||
| 39 | MaxResults => 1, # OPTIONAL | ||
| 40 | NextToken => 'My__string', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $Events = $ListDeviceEventsResponse->Events; | ||
| 45 | my $NextToken = $ListDeviceEventsResponse->NextToken; | ||
| 46 | |||
| 47 | # Returns a L<Paws::IoT1ClickDevices::ListDeviceEventsResponse> 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/devices.iot1click/ListDeviceEvents> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> DeviceId => Str | ||
| 56 | |||
| 57 | The unique identifier of the device. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> FromTimeStamp => Str | ||
| 62 | |||
| 63 | The start date for the device event query, in ISO8061 format. For | ||
| 64 | example, 2018-03-28T15:45:12.880Z | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 MaxResults => Int | ||
| 69 | |||
| 70 | The maximum number of results to return per request. If not set, a | ||
| 71 | default value of 100 is used. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 NextToken => Str | ||
| 76 | |||
| 77 | The token to retrieve the next set of results. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> ToTimeStamp => Str | ||
| 82 | |||
| 83 | The end date for the device event query, in ISO8061 format. For | ||
| 84 | example, 2018-03-28T15:45:12.880Z | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, documenting arguments for method ListDeviceEvents in L<Paws::IoT1ClickDevices> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |