« blib/lib/Paws/IoTAnalytics/S3DestinationConfiguration.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/SampleChannelDataResponse.pm »
| 1 | |||
| 2 | package Paws::IoTAnalytics::SampleChannelData; | ||
| 3 | use Moose; | ||
| 4 | has ChannelName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'channelName', required => 1); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'endTime'); | ||
| 6 | has MaxMessages => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxMessages'); | ||
| 7 | has StartTime => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'startTime'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SampleChannelData'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/channels/{channelName}/sample'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTAnalytics::SampleChannelDataResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::IoTAnalytics::SampleChannelData - Arguments for method SampleChannelData on L<Paws::IoTAnalytics> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method SampleChannelData on the | ||
| 26 | L<AWS IoT Analytics|Paws::IoTAnalytics> service. Use the attributes of this class | ||
| 27 | as arguments to method SampleChannelData. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SampleChannelData. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $iotanalytics = Paws->service('IoTAnalytics'); | ||
| 34 | my $SampleChannelDataResponse = $iotanalytics->SampleChannelData( | ||
| 35 | ChannelName => 'MyChannelName', | ||
| 36 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 37 | MaxMessages => 1, # OPTIONAL | ||
| 38 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $Payloads = $SampleChannelDataResponse->Payloads; | ||
| 43 | |||
| 44 | # Returns a L<Paws::IoTAnalytics::SampleChannelDataResponse> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotanalytics/SampleChannelData> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> ChannelName => Str | ||
| 53 | |||
| 54 | The name of the channel whose message samples are retrieved. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 EndTime => Str | ||
| 59 | |||
| 60 | The end of the time window from which sample messages are retrieved. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 MaxMessages => Int | ||
| 65 | |||
| 66 | The number of sample messages to be retrieved. The limit is 10. The | ||
| 67 | default is also 10. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 StartTime => Str | ||
| 72 | |||
| 73 | The start of the time window from which sample messages are retrieved. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, documenting arguments for method SampleChannelData in L<Paws::IoTAnalytics> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |