« blib/lib/Paws/AlexaForBusiness/ListConferenceProvidersResponse.pm
↑ Summary
blib/lib/Paws/AlexaForBusiness/ListDeviceEventsResponse.pm »
| 1 | |||
| 2 | package Paws::AlexaForBusiness::ListDeviceEvents; | ||
| 3 | use Moose; | ||
| 4 | has DeviceArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has EventType => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListDeviceEvents'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AlexaForBusiness::ListDeviceEventsResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::AlexaForBusiness::ListDeviceEvents - Arguments for method ListDeviceEvents on L<Paws::AlexaForBusiness> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListDeviceEvents on the | ||
| 25 | L<Alexa For Business|Paws::AlexaForBusiness> service. Use the attributes of this class | ||
| 26 | as arguments to method ListDeviceEvents. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListDeviceEvents. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $a4b = Paws->service('AlexaForBusiness'); | ||
| 33 | my $ListDeviceEventsResponse = $a4b->ListDeviceEvents( | ||
| 34 | DeviceArn => 'MyArn', | ||
| 35 | EventType => 'CONNECTION_STATUS', # OPTIONAL | ||
| 36 | MaxResults => 1, # OPTIONAL | ||
| 37 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $DeviceEvents = $ListDeviceEventsResponse->DeviceEvents; | ||
| 42 | my $NextToken = $ListDeviceEventsResponse->NextToken; | ||
| 43 | |||
| 44 | # Returns a L<Paws::AlexaForBusiness::ListDeviceEventsResponse> 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/a4b/ListDeviceEvents> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> DeviceArn => Str | ||
| 53 | |||
| 54 | The ARN of a device. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 EventType => Str | ||
| 59 | |||
| 60 | The event type to filter device events. If EventType isn't specified, | ||
| 61 | this returns a list of all device events in reverse chronological | ||
| 62 | order. If EventType is specified, this returns a list of device events | ||
| 63 | for that EventType in reverse chronological order. | ||
| 64 | |||
| 65 | Valid values are: C<"CONNECTION_STATUS">, C<"DEVICE_STATUS"> | ||
| 66 | |||
| 67 | =head2 MaxResults => Int | ||
| 68 | |||
| 69 | The maximum number of results to include in the response. The default | ||
| 70 | value is 50. If more results exist than the specified MaxResults value, | ||
| 71 | a token is included in the response so that the remaining results can | ||
| 72 | be retrieved. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 NextToken => Str | ||
| 77 | |||
| 78 | An optional token returned from a prior request. Use this token for | ||
| 79 | pagination of results from this action. If this parameter is specified, | ||
| 80 | the response only includes results beyond the token, up to the value | ||
| 81 | specified by MaxResults. When the end of results is reached, the | ||
| 82 | response has a value of null. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head1 SEE ALSO | ||
| 88 | |||
| 89 | This class forms part of L<Paws>, documenting arguments for method ListDeviceEvents in L<Paws::AlexaForBusiness> | ||
| 90 | |||
| 91 | =head1 BUGS and CONTRIBUTIONS | ||
| 92 | |||
| 93 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 94 | |||
| 95 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 96 | |||
| 97 | =cut | ||
| 98 |