« blib/lib/Paws/Budgets/CreateBudgetResponse.pm
↑ Summary
blib/lib/Paws/Budgets/CreateNotificationResponse.pm »
| 1 | |||
| 2 | package Paws::Budgets::CreateNotification; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has BudgetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Notification => (is => 'ro', isa => 'Paws::Budgets::Notification', required => 1); | ||
| 7 | has Subscribers => (is => 'ro', isa => 'ArrayRef[Paws::Budgets::Subscriber]', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateNotification'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Budgets::CreateNotificationResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Budgets::CreateNotification - Arguments for method CreateNotification on L<Paws::Budgets> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateNotification on the | ||
| 25 | L<AWS Budgets|Paws::Budgets> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateNotification. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateNotification. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $budgets = Paws->service('Budgets'); | ||
| 33 | my $CreateNotificationResponse = $budgets->CreateNotification( | ||
| 34 | AccountId => 'MyAccountId', | ||
| 35 | BudgetName => 'MyBudgetName', | ||
| 36 | Notification => { | ||
| 37 | ComparisonOperator => | ||
| 38 | 'GREATER_THAN', # values: GREATER_THAN, LESS_THAN, EQUAL_TO | ||
| 39 | NotificationType => 'ACTUAL', # values: ACTUAL, FORECASTED | ||
| 40 | Threshold => 1, # max: 40000000000 | ||
| 41 | NotificationState => 'OK', # values: OK, ALARM; OPTIONAL | ||
| 42 | ThresholdType => | ||
| 43 | 'PERCENTAGE', # values: PERCENTAGE, ABSOLUTE_VALUE; OPTIONAL | ||
| 44 | }, | ||
| 45 | Subscribers => [ | ||
| 46 | { | ||
| 47 | Address => 'MySubscriberAddress', # min: 1, max: 2147483647 | ||
| 48 | SubscriptionType => 'SNS', # values: SNS, EMAIL | ||
| 49 | |||
| 50 | }, | ||
| 51 | ... | ||
| 52 | ], | ||
| 53 | |||
| 54 | ); | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/budgets/CreateNotification> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> AccountId => Str | ||
| 63 | |||
| 64 | The C<accountId> that is associated with the budget that you want to | ||
| 65 | create a notification for. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> BudgetName => Str | ||
| 70 | |||
| 71 | The name of the budget that you want AWS to notify you about. Budget | ||
| 72 | names must be unique within an account. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> Notification => L<Paws::Budgets::Notification> | ||
| 77 | |||
| 78 | The notification that you want to create. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> Subscribers => ArrayRef[L<Paws::Budgets::Subscriber>] | ||
| 83 | |||
| 84 | A list of subscribers that you want to associate with the notification. | ||
| 85 | Each notification can have one SNS subscriber and up to 10 email | ||
| 86 | subscribers. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method CreateNotification in L<Paws::Budgets> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |