| 1 | |||
| 2 | package Paws::CloudWatch::SetAlarmState; | ||
| 3 | use Moose; | ||
| 4 | has AlarmName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has StateReason => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has StateReasonData => (is => 'ro', isa => 'Str'); | ||
| 7 | has StateValue => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetAlarmState'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudWatch::SetAlarmState - Arguments for method SetAlarmState on L<Paws::CloudWatch> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method SetAlarmState on the | ||
| 25 | L<Amazon CloudWatch|Paws::CloudWatch> service. Use the attributes of this class | ||
| 26 | as arguments to method SetAlarmState. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetAlarmState. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $monitoring = Paws->service('CloudWatch'); | ||
| 33 | $monitoring->SetAlarmState( | ||
| 34 | AlarmName => 'MyAlarmName', | ||
| 35 | StateReason => 'MyStateReason', | ||
| 36 | StateValue => 'OK', | ||
| 37 | StateReasonData => 'MyStateReasonData', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/monitoring/SetAlarmState> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> AlarmName => Str | ||
| 47 | |||
| 48 | The name of the alarm. | ||
| 49 | |||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> StateReason => Str | ||
| 53 | |||
| 54 | The reason that this alarm is set to this specific state, in text | ||
| 55 | format. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 StateReasonData => Str | ||
| 60 | |||
| 61 | The reason that this alarm is set to this specific state, in JSON | ||
| 62 | format. | ||
| 63 | |||
| 64 | For SNS or EC2 alarm actions, this is just informational. But for EC2 | ||
| 65 | Auto Scaling or application Auto Scaling alarm actions, the Auto | ||
| 66 | Scaling policy uses the information in this field to take the correct | ||
| 67 | action. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> StateValue => Str | ||
| 72 | |||
| 73 | The value of the state. | ||
| 74 | |||
| 75 | Valid values are: C<"OK">, C<"ALARM">, C<"INSUFFICIENT_DATA"> | ||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, documenting arguments for method SetAlarmState in L<Paws::CloudWatch> | ||
| 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 |