Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . budgets ]

create-budget

Description

Creates a budget and, if included, notifications and subscribers.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-budget
--account-id <value>
--budget <value>
[--notifications-with-subscribers <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The accountId that is associated with the budget.

--budget (structure)

The budget object that you want to create.

Shorthand Syntax:

BudgetName=string,BudgetLimit={Amount=string,Unit=string},CostFilters={KeyName1=string,string,KeyName2=string,string},CostTypes={IncludeTax=boolean,IncludeSubscription=boolean,UseBlended=boolean,IncludeRefund=boolean,IncludeCredit=boolean,IncludeUpfront=boolean,IncludeRecurring=boolean,IncludeOtherSubscription=boolean,IncludeSupport=boolean,IncludeDiscount=boolean,UseAmortized=boolean},TimeUnit=string,TimePeriod={Start=timestamp,End=timestamp},CalculatedSpend={ActualSpend={Amount=string,Unit=string},ForecastedSpend={Amount=string,Unit=string}},BudgetType=string

JSON Syntax:

{
  "BudgetName": "string",
  "BudgetLimit": {
    "Amount": "string",
    "Unit": "string"
  },
  "CostFilters": {"string": ["string", ...]
    ...},
  "CostTypes": {
    "IncludeTax": true|false,
    "IncludeSubscription": true|false,
    "UseBlended": true|false,
    "IncludeRefund": true|false,
    "IncludeCredit": true|false,
    "IncludeUpfront": true|false,
    "IncludeRecurring": true|false,
    "IncludeOtherSubscription": true|false,
    "IncludeSupport": true|false,
    "IncludeDiscount": true|false,
    "UseAmortized": true|false
  },
  "TimeUnit": "DAILY"|"MONTHLY"|"QUARTERLY"|"ANNUALLY",
  "TimePeriod": {
    "Start": timestamp,
    "End": timestamp
  },
  "CalculatedSpend": {
    "ActualSpend": {
      "Amount": "string",
      "Unit": "string"
    },
    "ForecastedSpend": {
      "Amount": "string",
      "Unit": "string"
    }
  },
  "BudgetType": "USAGE"|"COST"|"RI_UTILIZATION"|"RI_COVERAGE"
}

--notifications-with-subscribers (list)

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 ten email subscribers. If you include notifications and subscribers in your create-budget call, AWS creates the notifications and subscribers for you.

Shorthand Syntax:

Notification={NotificationType=string,ComparisonOperator=string,Threshold=double,ThresholdType=string},Subscribers=[{SubscriptionType=string,Address=string},{SubscriptionType=string,Address=string}] ...

JSON Syntax:

[
  {
    "Notification": {
      "NotificationType": "ACTUAL"|"FORECASTED",
      "ComparisonOperator": "GREATER_THAN"|"LESS_THAN"|"EQUAL_TO",
      "Threshold": double,
      "ThresholdType": "PERCENTAGE"|"ABSOLUTE_VALUE"
    },
    "Subscribers": [
      {
        "SubscriptionType": "SNS"|"EMAIL",
        "Address": "string"
      }
      ...
    ]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output