/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Budgets::CreateBudget

NAME

Paws::Budgets::CreateBudget - Arguments for method CreateBudget on Paws::Budgets

DESCRIPTION

This class represents the parameters used for calling the method CreateBudget on the AWS Budgets service. Use the attributes of this class as arguments to method CreateBudget.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBudget.

SYNOPSIS

my $budgets = Paws->service('Budgets');
my $CreateBudgetResponse = $budgets->CreateBudget(
  AccountId => 'MyAccountId',
  Budget    => {
    BudgetName => 'MyBudgetName',    # min: 1, max: 100
    BudgetType => 'USAGE'
    , # values: USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE
    TimeUnit    => 'DAILY',    # values: DAILY, MONTHLY, QUARTERLY, ANNUALLY
    BudgetLimit => {
      Amount => 'MyNumericValue',    # min: 1, max: 2147483647
      Unit   => 'MyUnitValue',       # min: 1, max: 2147483647

    },    # OPTIONAL
    CalculatedSpend => {
      ActualSpend => {
        Amount => 'MyNumericValue',    # min: 1, max: 2147483647
        Unit   => 'MyUnitValue',       # min: 1, max: 2147483647

      },    # OPTIONAL
      ForecastedSpend => {
        Amount => 'MyNumericValue',    # min: 1, max: 2147483647
        Unit   => 'MyUnitValue',       # min: 1, max: 2147483647

      },    # OPTIONAL
    },    # OPTIONAL
    CostFilters => {
      'MyGenericString' => [
        'MyGenericString', ...    # max: 2147483647
      ],    # key: max: 2147483647
    },    # OPTIONAL
    CostTypes => {
      IncludeCredit            => 1,    # OPTIONAL
      IncludeDiscount          => 1,    # OPTIONAL
      IncludeOtherSubscription => 1,    # OPTIONAL
      IncludeRecurring         => 1,    # OPTIONAL
      IncludeRefund            => 1,    # OPTIONAL
      IncludeSubscription      => 1,    # OPTIONAL
      IncludeSupport           => 1,    # OPTIONAL
      IncludeTax               => 1,    # OPTIONAL
      IncludeUpfront           => 1,    # OPTIONAL
      UseAmortized             => 1,    # OPTIONAL
      UseBlended               => 1,    # OPTIONAL
    },    # OPTIONAL
    LastUpdatedTime     => '1970-01-01T01:00:00',    # OPTIONAL
    PlannedBudgetLimits => {
      'MyGenericString' => {
        Amount => 'MyNumericValue',    # min: 1, max: 2147483647
        Unit   => 'MyUnitValue',       # min: 1, max: 2147483647

      },    # key: max: 2147483647, value: OPTIONAL
    },    # OPTIONAL
    TimePeriod => {
      End   => '1970-01-01T01:00:00',    # OPTIONAL
      Start => '1970-01-01T01:00:00',    # OPTIONAL
    },    # OPTIONAL
  },
  NotificationsWithSubscribers => [
    {
      Notification => {
        ComparisonOperator =>
          'GREATER_THAN',    # values: GREATER_THAN, LESS_THAN, EQUAL_TO
        NotificationType  => 'ACTUAL',    # values: ACTUAL, FORECASTED
        Threshold         => 1,           # max: 40000000000
        NotificationState => 'OK',        # values: OK, ALARM; OPTIONAL
        ThresholdType     =>
          'PERCENTAGE',    # values: PERCENTAGE, ABSOLUTE_VALUE; OPTIONAL
      },
      Subscribers => [
        {
          Address => 'MySubscriberAddress',    # min: 1, max: 2147483647
          SubscriptionType => 'SNS',           # values: SNS, EMAIL

        },
        ...
      ],    # min: 1, max: 11

    },
    ...
  ],    # OPTIONAL
);

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/budgets/CreateBudget

ATTRIBUTES

REQUIRED AccountId => Str

The accountId that is associated with the budget.

REQUIRED Budget => Paws::Budgets::Budget

The budget object that you want to create.

NotificationsWithSubscribers => ArrayRef[Paws::Budgets::NotificationWithSubscribers]

A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateBudget in Paws::Budgets

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues