| 1 | |||
| 2 | package Paws::Budgets::CreateBudget; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Budget => (is => 'ro', isa => 'Paws::Budgets::Budget', required => 1); | ||
| 6 | has NotificationsWithSubscribers => (is => 'ro', isa => 'ArrayRef[Paws::Budgets::NotificationWithSubscribers]'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBudget'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Budgets::CreateBudgetResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Budgets::CreateBudget - Arguments for method CreateBudget on L<Paws::Budgets> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateBudget on the | ||
| 24 | L<AWS Budgets|Paws::Budgets> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateBudget. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBudget. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $budgets = Paws->service('Budgets'); | ||
| 32 | my $CreateBudgetResponse = $budgets->CreateBudget( | ||
| 33 | AccountId => 'MyAccountId', | ||
| 34 | Budget => { | ||
| 35 | BudgetName => 'MyBudgetName', # min: 1, max: 100 | ||
| 36 | BudgetType => 'USAGE' | ||
| 37 | , # values: USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE | ||
| 38 | TimeUnit => 'DAILY', # values: DAILY, MONTHLY, QUARTERLY, ANNUALLY | ||
| 39 | BudgetLimit => { | ||
| 40 | Amount => 'MyNumericValue', # min: 1, max: 2147483647 | ||
| 41 | Unit => 'MyUnitValue', # min: 1, max: 2147483647 | ||
| 42 | |||
| 43 | }, # OPTIONAL | ||
| 44 | CalculatedSpend => { | ||
| 45 | ActualSpend => { | ||
| 46 | Amount => 'MyNumericValue', # min: 1, max: 2147483647 | ||
| 47 | Unit => 'MyUnitValue', # min: 1, max: 2147483647 | ||
| 48 | |||
| 49 | }, # OPTIONAL | ||
| 50 | ForecastedSpend => { | ||
| 51 | Amount => 'MyNumericValue', # min: 1, max: 2147483647 | ||
| 52 | Unit => 'MyUnitValue', # min: 1, max: 2147483647 | ||
| 53 | |||
| 54 | }, # OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | CostFilters => { | ||
| 57 | 'MyGenericString' => [ | ||
| 58 | 'MyGenericString', ... # max: 2147483647 | ||
| 59 | ], # key: max: 2147483647 | ||
| 60 | }, # OPTIONAL | ||
| 61 | CostTypes => { | ||
| 62 | IncludeCredit => 1, # OPTIONAL | ||
| 63 | IncludeDiscount => 1, # OPTIONAL | ||
| 64 | IncludeOtherSubscription => 1, # OPTIONAL | ||
| 65 | IncludeRecurring => 1, # OPTIONAL | ||
| 66 | IncludeRefund => 1, # OPTIONAL | ||
| 67 | IncludeSubscription => 1, # OPTIONAL | ||
| 68 | IncludeSupport => 1, # OPTIONAL | ||
| 69 | IncludeTax => 1, # OPTIONAL | ||
| 70 | IncludeUpfront => 1, # OPTIONAL | ||
| 71 | UseAmortized => 1, # OPTIONAL | ||
| 72 | UseBlended => 1, # OPTIONAL | ||
| 73 | }, # OPTIONAL | ||
| 74 | LastUpdatedTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 75 | PlannedBudgetLimits => { | ||
| 76 | 'MyGenericString' => { | ||
| 77 | Amount => 'MyNumericValue', # min: 1, max: 2147483647 | ||
| 78 | Unit => 'MyUnitValue', # min: 1, max: 2147483647 | ||
| 79 | |||
| 80 | }, # key: max: 2147483647, value: OPTIONAL | ||
| 81 | }, # OPTIONAL | ||
| 82 | TimePeriod => { | ||
| 83 | End => '1970-01-01T01:00:00', # OPTIONAL | ||
| 84 | Start => '1970-01-01T01:00:00', # OPTIONAL | ||
| 85 | }, # OPTIONAL | ||
| 86 | }, | ||
| 87 | NotificationsWithSubscribers => [ | ||
| 88 | { | ||
| 89 | Notification => { | ||
| 90 | ComparisonOperator => | ||
| 91 | 'GREATER_THAN', # values: GREATER_THAN, LESS_THAN, EQUAL_TO | ||
| 92 | NotificationType => 'ACTUAL', # values: ACTUAL, FORECASTED | ||
| 93 | Threshold => 1, # max: 40000000000 | ||
| 94 | NotificationState => 'OK', # values: OK, ALARM; OPTIONAL | ||
| 95 | ThresholdType => | ||
| 96 | 'PERCENTAGE', # values: PERCENTAGE, ABSOLUTE_VALUE; OPTIONAL | ||
| 97 | }, | ||
| 98 | Subscribers => [ | ||
| 99 | { | ||
| 100 | Address => 'MySubscriberAddress', # min: 1, max: 2147483647 | ||
| 101 | SubscriptionType => 'SNS', # values: SNS, EMAIL | ||
| 102 | |||
| 103 | }, | ||
| 104 | ... | ||
| 105 | ], # min: 1, max: 11 | ||
| 106 | |||
| 107 | }, | ||
| 108 | ... | ||
| 109 | ], # OPTIONAL | ||
| 110 | ); | ||
| 111 | |||
| 112 | 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. | ||
| 113 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/budgets/CreateBudget> | ||
| 114 | |||
| 115 | =head1 ATTRIBUTES | ||
| 116 | |||
| 117 | |||
| 118 | =head2 B<REQUIRED> AccountId => Str | ||
| 119 | |||
| 120 | The C<accountId> that is associated with the budget. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> Budget => L<Paws::Budgets::Budget> | ||
| 125 | |||
| 126 | The budget object that you want to create. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 NotificationsWithSubscribers => ArrayRef[L<Paws::Budgets::NotificationWithSubscribers>] | ||
| 131 | |||
| 132 | A notification that you want to associate with a budget. A budget can | ||
| 133 | have up to five notifications, and each notification can have one SNS | ||
| 134 | subscriber and up to 10 email subscribers. If you include notifications | ||
| 135 | and subscribers in your C<CreateBudget> call, AWS creates the | ||
| 136 | notifications and subscribers for you. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head1 SEE ALSO | ||
| 142 | |||
| 143 | This class forms part of L<Paws>, documenting arguments for method CreateBudget in L<Paws::Budgets> | ||
| 144 | |||
| 145 | =head1 BUGS and CONTRIBUTIONS | ||
| 146 | |||
| 147 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 148 | |||
| 149 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 150 | |||
| 151 | =cut | ||
| 152 |