« blib/lib/Paws/IoTEventsData/CustomerAction.pm
↑ Summary
blib/lib/Paws/IoTEventsData/DescribeAlarmResponse.pm »
| 1 | |||
| 2 | package Paws::IoTEventsData::DescribeAlarm; | ||
| 3 | use Moose; | ||
| 4 | has AlarmModelName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'alarmModelName', required => 1); | ||
| 5 | has KeyValue => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'keyValue'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeAlarm'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/alarms/{alarmModelName}/keyValues/'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTEventsData::DescribeAlarmResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IoTEventsData::DescribeAlarm - Arguments for method DescribeAlarm on L<Paws::IoTEventsData> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeAlarm on the | ||
| 24 | L<AWS IoT Events Data|Paws::IoTEventsData> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeAlarm. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeAlarm. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $data.iotevents = Paws->service('IoTEventsData'); | ||
| 32 | my $DescribeAlarmResponse = $data . iotevents->DescribeAlarm( | ||
| 33 | AlarmModelName => 'MyAlarmModelName', | ||
| 34 | KeyValue => 'MyKeyValue', # OPTIONAL | ||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $Alarm = $DescribeAlarmResponse->Alarm; | ||
| 39 | |||
| 40 | # Returns a L<Paws::IoTEventsData::DescribeAlarmResponse> object. | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/data.iotevents/DescribeAlarm> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> AlarmModelName => Str | ||
| 49 | |||
| 50 | The name of the alarm model. | ||
| 51 | |||
| 52 | |||
| 53 | |||
| 54 | =head2 KeyValue => Str | ||
| 55 | |||
| 56 | The value of the key used as a filter to select only the alarms | ||
| 57 | associated with the key | ||
| 58 | (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head1 SEE ALSO | ||
| 64 | |||
| 65 | This class forms part of L<Paws>, documenting arguments for method DescribeAlarm in L<Paws::IoTEventsData> | ||
| 66 | |||
| 67 | =head1 BUGS and CONTRIBUTIONS | ||
| 68 | |||
| 69 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 70 | |||
| 71 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 72 | |||
| 73 | =cut | ||
| 74 |