Class: AWS.Budgets

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ActionThreshold: { /* required */
    ActionThresholdType: PERCENTAGE | ABSOLUTE_VALUE, /* required */
    ActionThresholdValue: 'NUMBER_VALUE' /* required */
  },
  ActionType: APPLY_IAM_POLICY | APPLY_SCP_POLICY | RUN_SSM_DOCUMENTS, /* required */
  ApprovalModel: AUTOMATIC | MANUAL, /* required */
  BudgetName: 'STRING_VALUE', /* required */
  Definition: { /* required */
    IamActionDefinition: {
      PolicyArn: 'STRING_VALUE', /* required */
      Groups: [
        'STRING_VALUE',
        /* more items */
      ],
      Roles: [
        'STRING_VALUE',
        /* more items */
      ],
      Users: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    ScpActionDefinition: {
      PolicyId: 'STRING_VALUE', /* required */
      TargetIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    SsmActionDefinition: {
      ActionSubType: STOP_EC2_INSTANCES | STOP_RDS_INSTANCES, /* required */
      InstanceIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Region: 'STRING_VALUE' /* required */
    }
  },
  ExecutionRoleArn: 'STRING_VALUE', /* required */
  NotificationType: ACTUAL | FORECASTED, /* required */
  Subscribers: [ /* required */
    {
      Address: 'STRING_VALUE', /* required */
      SubscriptionType: SNS | EMAIL /* required */
    },
    /* more items */
  ],
  ResourceTags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
budgets.createBudgetAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the user. It's a 12-digit number.

  • BudgetName — (String)

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • NotificationType — (String)

    The type of a notification. It must be ACTUAL or FORECASTED.

    Possible values include:
    • "ACTUAL"
    • "FORECASTED"
  • ActionType — (String)

    The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

    Possible values include:
    • "APPLY_IAM_POLICY"
    • "APPLY_SCP_POLICY"
    • "RUN_SSM_DOCUMENTS"
  • ActionThreshold — (map)

    The trigger threshold of the action.

    • ActionThresholdValue — required — (Float)

      The threshold of a notification.

    • ActionThresholdType — required — (String)

      The type of threshold for a notification.

      Possible values include:
      • "PERCENTAGE"
      • "ABSOLUTE_VALUE"
  • Definition — (map)

    Specifies all of the type-specific parameters.

    • IamActionDefinition — (map)

      The Identity and Access Management (IAM) action definition details.

      • PolicyArn — required — (String)

        The Amazon Resource Name (ARN) of the policy to be attached.

      • Roles — (Array<String>)

        A list of roles to be attached. There must be at least one role.

      • Groups — (Array<String>)

        A list of groups to be attached. There must be at least one group.

      • Users — (Array<String>)

        A list of users to be attached. There must be at least one user.

    • ScpActionDefinition — (map)

      The service control policies (SCPs) action definition details.

      • PolicyId — required — (String)

        The policy ID attached.

      • TargetIds — required — (Array<String>)

        A list of target IDs.

    • SsmActionDefinition — (map)

      The Amazon Web Services Systems Manager (SSM) action definition details.

      • ActionSubType — required — (String)

        The action subType.

        Possible values include:
        • "STOP_EC2_INSTANCES"
        • "STOP_RDS_INSTANCES"
      • Region — required — (String)

        The Region to run the SSM document.

      • InstanceIds — required — (Array<String>)

        The EC2 and RDS instance IDs.

  • ExecutionRoleArn — (String)

    The role passed for action execution and reversion. Roles and actions must be in the same account.

  • ApprovalModel — (String)

    This specifies if the action needs manual or automatic approval.

    Possible values include:
    • "AUTOMATIC"
    • "MANUAL"
  • Subscribers — (Array<map>)

    A list of subscribers.

    • SubscriptionType — required — (String)

      The type of notification that Amazon Web Services sends to a subscriber.

      Possible values include:
      • "SNS"
      • "EMAIL"
    • Address — required — (String)

      The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

      When you create a subscriber, the value of Address can't contain line breaks.

  • ResourceTags — (Array<map>)

    An optional list of tags to associate with the specified budget action. Each tag consists of a key and a value, and each key must be unique for the resource.

    • Key — required — (String)

      The key that's associated with the tag.

    • Value — required — (String)

      The value that's associated with the tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountId — (String)

      The account ID of the user. It's a 12-digit number.

    • BudgetName — (String)

      A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

    • ActionId — (String)

      A system-generated universally unique identifier (UUID) for the action.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  Notification: { /* required */
    ComparisonOperator: GREATER_THAN | LESS_THAN | EQUAL_TO, /* required */
    NotificationType: ACTUAL | FORECASTED, /* required */
    Threshold: 'NUMBER_VALUE', /* required */
    NotificationState: OK | ALARM,
    ThresholdType: PERCENTAGE | ABSOLUTE_VALUE
  },
  Subscribers: [ /* required */
    {
      Address: 'STRING_VALUE', /* required */
      SubscriptionType: SNS | EMAIL /* required */
    },
    /* more items */
  ]
};
budgets.createNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget that you want to create a notification for.

  • BudgetName — (String)

    The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.

  • Notification — (map)

    The notification that you want to create.

    • NotificationType — required — (String)

      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

      Possible values include:
      • "ACTUAL"
      • "FORECASTED"
    • ComparisonOperator — required — (String)

      The comparison that's used for this notification.

      Possible values include:
      • "GREATER_THAN"
      • "LESS_THAN"
      • "EQUAL_TO"
    • Threshold — required — (Float)

      The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

    • ThresholdType — (String)

      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

      Possible values include:
      • "PERCENTAGE"
      • "ABSOLUTE_VALUE"
    • NotificationState — (String)

      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

      Possible values include:
      • "OK"
      • "ALARM"
  • Subscribers — (Array<map>)

    A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.

    • SubscriptionType — required — (String)

      The type of notification that Amazon Web Services sends to a subscriber.

      Possible values include:
      • "SNS"
      • "EMAIL"
    • Address — required — (String)

      The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

      When you create a subscriber, the value of Address can't contain line breaks.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  Notification: { /* required */
    ComparisonOperator: GREATER_THAN | LESS_THAN | EQUAL_TO, /* required */
    NotificationType: ACTUAL | FORECASTED, /* required */
    Threshold: 'NUMBER_VALUE', /* required */
    NotificationState: OK | ALARM,
    ThresholdType: PERCENTAGE | ABSOLUTE_VALUE
  },
  Subscriber: { /* required */
    Address: 'STRING_VALUE', /* required */
    SubscriptionType: SNS | EMAIL /* required */
  }
};
budgets.createSubscriber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget that you want to create a subscriber for.

  • BudgetName — (String)

    The name of the budget that you want to subscribe to. Budget names must be unique within an account.

  • Notification — (map)

    The notification that you want to create a subscriber for.

    • NotificationType — required — (String)

      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

      Possible values include:
      • "ACTUAL"
      • "FORECASTED"
    • ComparisonOperator — required — (String)

      The comparison that's used for this notification.

      Possible values include:
      • "GREATER_THAN"
      • "LESS_THAN"
      • "EQUAL_TO"
    • Threshold — required — (Float)

      The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

    • ThresholdType — (String)

      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

      Possible values include:
      • "PERCENTAGE"
      • "ABSOLUTE_VALUE"
    • NotificationState — (String)

      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

      Possible values include:
      • "OK"
      • "ALARM"
  • Subscriber — (map)

    The subscriber that you want to associate with a budget notification.

    • SubscriptionType — required — (String)

      The type of notification that Amazon Web Services sends to a subscriber.

      Possible values include:
      • "SNS"
      • "EMAIL"
    • Address — required — (String)

      The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

      When you create a subscriber, the value of Address can't contain line breaks.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE' /* required */
};
budgets.deleteBudget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget that you want to delete.

  • BudgetName — (String)

    The name of the budget that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ActionId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE' /* required */
};
budgets.deleteBudgetAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the user. It's a 12-digit number.

  • BudgetName — (String)

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • ActionId — (String)

    A system-generated universally unique identifier (UUID) for the action.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountId — (String)

      The account ID of the user. It's a 12-digit number.

    • BudgetName — (String)

      A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

    • Action — (map)

      A budget action resource.

      • ActionId — required — (String)

        A system-generated universally unique identifier (UUID) for the action.

      • BudgetName — required — (String)

        A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

      • NotificationType — required — (String)

        The type of a notification. It must be ACTUAL or FORECASTED.

        Possible values include:
        • "ACTUAL"
        • "FORECASTED"
      • ActionType — required — (String)

        The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

        Possible values include:
        • "APPLY_IAM_POLICY"
        • "APPLY_SCP_POLICY"
        • "RUN_SSM_DOCUMENTS"
      • ActionThreshold — required — (map)

        The trigger threshold of the action.

        • ActionThresholdValue — required — (Float)

          The threshold of a notification.

        • ActionThresholdType — required — (String)

          The type of threshold for a notification.

          Possible values include:
          • "PERCENTAGE"
          • "ABSOLUTE_VALUE"
      • Definition — required — (map)

        Where you specify all of the type-specific parameters.

        • IamActionDefinition — (map)

          The Identity and Access Management (IAM) action definition details.

          • PolicyArn — required — (String)

            The Amazon Resource Name (ARN) of the policy to be attached.

          • Roles — (Array<String>)

            A list of roles to be attached. There must be at least one role.

          • Groups — (Array<String>)

            A list of groups to be attached. There must be at least one group.

          • Users — (Array<String>)

            A list of users to be attached. There must be at least one user.

        • ScpActionDefinition — (map)

          The service control policies (SCPs) action definition details.

          • PolicyId — required — (String)

            The policy ID attached.

          • TargetIds — required — (Array<String>)

            A list of target IDs.

        • SsmActionDefinition — (map)

          The Amazon Web Services Systems Manager (SSM) action definition details.

          • ActionSubType — required — (String)

            The action subType.

            Possible values include:
            • "STOP_EC2_INSTANCES"
            • "STOP_RDS_INSTANCES"
          • Region — required — (String)

            The Region to run the SSM document.

          • InstanceIds — required — (Array<String>)

            The EC2 and RDS instance IDs.

      • ExecutionRoleArn — required — (String)

        The role passed for action execution and reversion. Roles and actions must be in the same account.

      • ApprovalModel — required — (String)

        This specifies if the action needs manual or automatic approval.

        Possible values include:
        • "AUTOMATIC"
        • "MANUAL"
      • Status — required — (String)

        The status of the action.

        Possible values include:
        • "STANDBY"
        • "PENDING"
        • "EXECUTION_IN_PROGRESS"
        • "EXECUTION_SUCCESS"
        • "EXECUTION_FAILURE"
        • "REVERSE_IN_PROGRESS"
        • "REVERSE_SUCCESS"
        • "REVERSE_FAILURE"
        • "RESET_IN_PROGRESS"
        • "RESET_FAILURE"
      • Subscribers — required — (Array<map>)

        A list of subscribers.

        • SubscriptionType — required — (String)

          The type of notification that Amazon Web Services sends to a subscriber.

          Possible values include:
          • "SNS"
          • "EMAIL"
        • Address — required — (String)

          The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

          When you create a subscriber, the value of Address can't contain line breaks.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  Notification: { /* required */
    ComparisonOperator: GREATER_THAN | LESS_THAN | EQUAL_TO, /* required */
    NotificationType: ACTUAL | FORECASTED, /* required */
    Threshold: 'NUMBER_VALUE', /* required */
    NotificationState: OK | ALARM,
    ThresholdType: PERCENTAGE | ABSOLUTE_VALUE
  }
};
budgets.deleteNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget whose notification you want to delete.

  • BudgetName — (String)

    The name of the budget whose notification you want to delete.

  • Notification — (map)

    The notification that you want to delete.

    • NotificationType — required — (String)

      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

      Possible values include:
      • "ACTUAL"
      • "FORECASTED"
    • ComparisonOperator — required — (String)

      The comparison that's used for this notification.

      Possible values include:
      • "GREATER_THAN"
      • "LESS_THAN"
      • "EQUAL_TO"
    • Threshold — required — (Float)

      The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

    • ThresholdType — (String)

      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

      Possible values include:
      • "PERCENTAGE"
      • "ABSOLUTE_VALUE"
    • NotificationState — (String)

      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

      Possible values include:
      • "OK"
      • "ALARM"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  Notification: { /* required */
    ComparisonOperator: GREATER_THAN | LESS_THAN | EQUAL_TO, /* required */
    NotificationType: ACTUAL | FORECASTED, /* required */
    Threshold: 'NUMBER_VALUE', /* required */
    NotificationState: OK | ALARM,
    ThresholdType: PERCENTAGE | ABSOLUTE_VALUE
  },
  Subscriber: { /* required */
    Address: 'STRING_VALUE', /* required */
    SubscriptionType: SNS | EMAIL /* required */
  }
};
budgets.deleteSubscriber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget whose subscriber you want to delete.

  • BudgetName — (String)

    The name of the budget whose subscriber you want to delete.

  • Notification — (map)

    The notification whose subscriber you want to delete.

    • NotificationType — required — (String)

      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

      Possible values include:
      • "ACTUAL"
      • "FORECASTED"
    • ComparisonOperator — required — (String)

      The comparison that's used for this notification.

      Possible values include:
      • "GREATER_THAN"
      • "LESS_THAN"
      • "EQUAL_TO"
    • Threshold — required — (Float)

      The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

    • ThresholdType — (String)

      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

      Possible values include:
      • "PERCENTAGE"
      • "ABSOLUTE_VALUE"
    • NotificationState — (String)

      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

      Possible values include:
      • "OK"
      • "ALARM"
  • Subscriber — (map)

    The subscriber that you want to delete.

    • SubscriptionType — required — (String)

      The type of notification that Amazon Web Services sends to a subscriber.

      Possible values include:
      • "SNS"
      • "EMAIL"
    • Address — required — (String)

      The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

      When you create a subscriber, the value of Address can't contain line breaks.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE' /* required */
};
budgets.describeBudget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget that you want a description of.

  • BudgetName — (String)

    The name of the budget that you want a description of.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Budget — (map)

      The description of the budget.

      • BudgetName — required — (String)

        The name of a budget. The name must be unique within an account. The : and \ characters, and the "/action/" substring, aren't allowed in BudgetName.

      • BudgetLimit — (map)

        The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.

        BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.

        • Amount — required — (String)

          The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

        • Unit — required — (String)

          The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

      • PlannedBudgetLimits — (map<map>)

        A map containing multiple BudgetLimit, including current or future limits.

        PlannedBudgetLimits is available for cost or usage budget and supports both monthly and quarterly TimeUnit.

        For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

        For quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The key is the start of the quarter, UTC in epoch seconds.

        If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.

        If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

        After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.

        DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets that are created with PlannedBudgetLimits. Budgets that are created without PlannedBudgetLimits only contain BudgetLimit. They don't contain PlannedBudgetLimits.

        • Amount — required — (String)

          The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

        • Unit — required — (String)

          The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

      • CostFilters — (map<Array<String>>)

        The cost filters, such as Region, Service, LinkedAccount, Tag, or CostCategory, that are applied to a budget.

        Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:

        • Amazon EC2

        • Amazon Redshift

        • Amazon Relational Database Service

        • Amazon ElastiCache

        • Amazon OpenSearch Service

      • CostTypes — (map)

        The types of costs that are included in this COST budget.

        USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.

        • IncludeTax — (Boolean)

          Specifies whether a budget includes taxes.

          The default value is true.

        • IncludeSubscription — (Boolean)

          Specifies whether a budget includes subscriptions.

          The default value is true.

        • UseBlended — (Boolean)

          Specifies whether a budget uses a blended rate.

          The default value is false.

        • IncludeRefund — (Boolean)

          Specifies whether a budget includes refunds.

          The default value is true.

        • IncludeCredit — (Boolean)

          Specifies whether a budget includes credits.

          The default value is true.

        • IncludeUpfront — (Boolean)

          Specifies whether a budget includes upfront RI costs.

          The default value is true.

        • IncludeRecurring — (Boolean)

          Specifies whether a budget includes recurring fees such as monthly RI fees.

          The default value is true.

        • IncludeOtherSubscription — (Boolean)

          Specifies whether a budget includes non-RI subscription costs.

          The default value is true.

        • IncludeSupport — (Boolean)

          Specifies whether a budget includes support subscription fees.

          The default value is true.

        • IncludeDiscount — (Boolean)

          Specifies whether a budget includes discounts.

          The default value is true.

        • UseAmortized — (Boolean)

          Specifies whether a budget uses the amortized rate.

          The default value is false.

      • TimeUnit — required — (String)

        The length of time until a budget resets the actual and forecasted spend.

        Possible values include:
        • "DAILY"
        • "MONTHLY"
        • "QUARTERLY"
        • "ANNUALLY"
      • TimePeriod — (map)

        The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.

        If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

        You can change either date with the UpdateBudget operation.

        After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.

        • Start — (Date)

          The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

          You can change your start date with the UpdateBudget operation.

        • End — (Date)

          The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

          After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

      • CalculatedSpend — (map)

        The actual and forecasted cost or usage that the budget tracks.

        • ActualSpend — required — (map)

          The amount of cost, usage, RI units, or Savings Plans units that you used.

          • Amount — required — (String)

            The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

          • Unit — required — (String)

            The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

        • ForecastedSpend — (map)

          The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.

          • Amount — required — (String)

            The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

          • Unit — required — (String)

            The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

      • BudgetType — required — (String)

        Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

        Possible values include:
        • "USAGE"
        • "COST"
        • "RI_UTILIZATION"
        • "RI_COVERAGE"
        • "SAVINGS_PLANS_UTILIZATION"
        • "SAVINGS_PLANS_COVERAGE"
      • LastUpdatedTime — (Date)

        The last time that you updated this budget.

      • AutoAdjustData — (map)

        The parameters that determine the budget amount for an auto-adjusting budget.

        • AutoAdjustType — required — (String)

          The string that defines whether your budget auto-adjusts based on historical or forecasted data.

          Possible values include:
          • "HISTORICAL"
          • "FORECAST"
        • HistoricalOptions — (map)

          The parameters that define or describe the historical data that your auto-adjusting budget is based on.

          • BudgetAdjustmentPeriod — required — (Integer)

            The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:

            • For the DAILY granularity, the maximum value is 60.

            • For the MONTHLY granularity, the maximum value is 12.

            • For the QUARTERLY granularity, the maximum value is 4.

            • For the ANNUALLY granularity, the maximum value is 1.

          • LookBackAvailablePeriods — (Integer)

            The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.

            For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3.

            You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.

        • LastAutoAdjustTime — (Date)

          The last time that your budget was auto-adjusted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ActionId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE' /* required */
};
budgets.describeBudgetAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the user. It's a 12-digit number.

  • BudgetName — (String)

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • ActionId — (String)

    A system-generated universally unique identifier (UUID) for the action.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountId — (String)

      The account ID of the user. It's a 12-digit number.

    • BudgetName — (String)

      A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

    • Action — (map)

      A budget action resource.

      • ActionId — required — (String)

        A system-generated universally unique identifier (UUID) for the action.

      • BudgetName — required — (String)

        A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

      • NotificationType — required — (String)

        The type of a notification. It must be ACTUAL or FORECASTED.

        Possible values include:
        • "ACTUAL"
        • "FORECASTED"
      • ActionType — required — (String)

        The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

        Possible values include:
        • "APPLY_IAM_POLICY"
        • "APPLY_SCP_POLICY"
        • "RUN_SSM_DOCUMENTS"
      • ActionThreshold — required — (map)

        The trigger threshold of the action.

        • ActionThresholdValue — required — (Float)

          The threshold of a notification.

        • ActionThresholdType — required — (String)

          The type of threshold for a notification.

          Possible values include:
          • "PERCENTAGE"
          • "ABSOLUTE_VALUE"
      • Definition — required — (map)

        Where you specify all of the type-specific parameters.

        • IamActionDefinition — (map)

          The Identity and Access Management (IAM) action definition details.

          • PolicyArn — required — (String)

            The Amazon Resource Name (ARN) of the policy to be attached.

          • Roles — (Array<String>)

            A list of roles to be attached. There must be at least one role.

          • Groups — (Array<String>)

            A list of groups to be attached. There must be at least one group.

          • Users — (Array<String>)

            A list of users to be attached. There must be at least one user.

        • ScpActionDefinition — (map)

          The service control policies (SCPs) action definition details.

          • PolicyId — required — (String)

            The policy ID attached.

          • TargetIds — required — (Array<String>)

            A list of target IDs.

        • SsmActionDefinition — (map)

          The Amazon Web Services Systems Manager (SSM) action definition details.

          • ActionSubType — required — (String)

            The action subType.

            Possible values include:
            • "STOP_EC2_INSTANCES"
            • "STOP_RDS_INSTANCES"
          • Region — required — (String)

            The Region to run the SSM document.

          • InstanceIds — required — (Array<String>)

            The EC2 and RDS instance IDs.

      • ExecutionRoleArn — required — (String)

        The role passed for action execution and reversion. Roles and actions must be in the same account.

      • ApprovalModel — required — (String)

        This specifies if the action needs manual or automatic approval.

        Possible values include:
        • "AUTOMATIC"
        • "MANUAL"
      • Status — required — (String)

        The status of the action.

        Possible values include:
        • "STANDBY"
        • "PENDING"
        • "EXECUTION_IN_PROGRESS"
        • "EXECUTION_SUCCESS"
        • "EXECUTION_FAILURE"
        • "REVERSE_IN_PROGRESS"
        • "REVERSE_SUCCESS"
        • "REVERSE_FAILURE"
        • "RESET_IN_PROGRESS"
        • "RESET_FAILURE"
      • Subscribers — required — (Array<map>)

        A list of subscribers.

        • SubscriptionType — required — (String)

          The type of notification that Amazon Web Services sends to a subscriber.

          Possible values include:
          • "SNS"
          • "EMAIL"
        • Address — required — (String)

          The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

          When you create a subscriber, the value of Address can't contain line breaks.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ActionId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  TimePeriod: {
    End: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    Start: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  }
};
budgets.describeBudgetActionHistories(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the user. It's a 12-digit number.

  • BudgetName — (String)

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • ActionId — (String)

    A system-generated universally unique identifier (UUID) for the action.

  • TimePeriod — (map)

    The period of time that's covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

    • Start — (Date)

      The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

      You can change your start date with the UpdateBudget operation.

    • End — (Date)

      The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

      After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

  • MaxResults — (Integer)

    An integer that represents how many entries a paginated response contains. The maximum is 100.

  • NextToken — (String)

    A generic string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ActionHistories — (Array<map>)

      The historical record of the budget action resource.

      • Timestamp — required — (Date)

        A generic time stamp. In Java, it's transformed to a Date object.

      • Status — required — (String)

        The status of action at the time of the event.

        Possible values include:
        • "STANDBY"
        • "PENDING"
        • "EXECUTION_IN_PROGRESS"
        • "EXECUTION_SUCCESS"
        • "EXECUTION_FAILURE"
        • "REVERSE_IN_PROGRESS"
        • "REVERSE_SUCCESS"
        • "REVERSE_FAILURE"
        • "RESET_IN_PROGRESS"
        • "RESET_FAILURE"
      • EventType — required — (String)

        This distinguishes between whether the events are triggered by the user or are generated by the system.

        Possible values include:
        • "SYSTEM"
        • "CREATE_ACTION"
        • "DELETE_ACTION"
        • "UPDATE_ACTION"
        • "EXECUTE_ACTION"
      • ActionHistoryDetails — required — (map)

        The description of the details for the event.

        • Message — required — (String)

          A generic string.

        • Action — required — (map)

          The budget action resource.

          • ActionId — required — (String)

            A system-generated universally unique identifier (UUID) for the action.

          • BudgetName — required — (String)

            A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

          • NotificationType — required — (String)

            The type of a notification. It must be ACTUAL or FORECASTED.

            Possible values include:
            • "ACTUAL"
            • "FORECASTED"
          • ActionType — required — (String)

            The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

            Possible values include:
            • "APPLY_IAM_POLICY"
            • "APPLY_SCP_POLICY"
            • "RUN_SSM_DOCUMENTS"
          • ActionThreshold — required — (map)

            The trigger threshold of the action.

            • ActionThresholdValue — required — (Float)

              The threshold of a notification.

            • ActionThresholdType — required — (String)

              The type of threshold for a notification.

              Possible values include:
              • "PERCENTAGE"
              • "ABSOLUTE_VALUE"
          • Definition — required — (map)

            Where you specify all of the type-specific parameters.

            • IamActionDefinition — (map)

              The Identity and Access Management (IAM) action definition details.

              • PolicyArn — required — (String)

                The Amazon Resource Name (ARN) of the policy to be attached.

              • Roles — (Array<String>)

                A list of roles to be attached. There must be at least one role.

              • Groups — (Array<String>)

                A list of groups to be attached. There must be at least one group.

              • Users — (Array<String>)

                A list of users to be attached. There must be at least one user.

            • ScpActionDefinition — (map)

              The service control policies (SCPs) action definition details.

              • PolicyId — required — (String)

                The policy ID attached.

              • TargetIds — required — (Array<String>)

                A list of target IDs.

            • SsmActionDefinition — (map)

              The Amazon Web Services Systems Manager (SSM) action definition details.

              • ActionSubType — required — (String)

                The action subType.

                Possible values include:
                • "STOP_EC2_INSTANCES"
                • "STOP_RDS_INSTANCES"
              • Region — required — (String)

                The Region to run the SSM document.

              • InstanceIds — required — (Array<String>)

                The EC2 and RDS instance IDs.

          • ExecutionRoleArn — required — (String)

            The role passed for action execution and reversion. Roles and actions must be in the same account.

          • ApprovalModel — required — (String)

            This specifies if the action needs manual or automatic approval.

            Possible values include:
            • "AUTOMATIC"
            • "MANUAL"
          • Status — required — (String)

            The status of the action.

            Possible values include:
            • "STANDBY"
            • "PENDING"
            • "EXECUTION_IN_PROGRESS"
            • "EXECUTION_SUCCESS"
            • "EXECUTION_FAILURE"
            • "REVERSE_IN_PROGRESS"
            • "REVERSE_SUCCESS"
            • "REVERSE_FAILURE"
            • "RESET_IN_PROGRESS"
            • "RESET_FAILURE"
          • Subscribers — required — (Array<map>)

            A list of subscribers.

            • SubscriptionType — required — (String)

              The type of notification that Amazon Web Services sends to a subscriber.

              Possible values include:
              • "SNS"
              • "EMAIL"
            • Address — required — (String)

              The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

              When you create a subscriber, the value of Address can't contain line breaks.

    • NextToken — (String)

      A generic string.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
budgets.describeBudgetActionsForAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the user. It's a 12-digit number.

  • MaxResults — (Integer)

    An integer that represents how many entries a paginated response contains. The maximum is 100.

  • NextToken — (String)

    A generic string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Actions — (Array<map>)

      A list of the budget action resources information.

      • ActionId — required — (String)

        A system-generated universally unique identifier (UUID) for the action.

      • BudgetName — required — (String)

        A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

      • NotificationType — required — (String)

        The type of a notification. It must be ACTUAL or FORECASTED.

        Possible values include:
        • "ACTUAL"
        • "FORECASTED"
      • ActionType — required — (String)

        The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

        Possible values include:
        • "APPLY_IAM_POLICY"
        • "APPLY_SCP_POLICY"
        • "RUN_SSM_DOCUMENTS"
      • ActionThreshold — required — (map)

        The trigger threshold of the action.

        • ActionThresholdValue — required — (Float)

          The threshold of a notification.

        • ActionThresholdType — required — (String)

          The type of threshold for a notification.

          Possible values include:
          • "PERCENTAGE"
          • "ABSOLUTE_VALUE"
      • Definition — required — (map)

        Where you specify all of the type-specific parameters.

        • IamActionDefinition — (map)

          The Identity and Access Management (IAM) action definition details.

          • PolicyArn — required — (String)

            The Amazon Resource Name (ARN) of the policy to be attached.

          • Roles — (Array<String>)

            A list of roles to be attached. There must be at least one role.

          • Groups — (Array<String>)

            A list of groups to be attached. There must be at least one group.

          • Users — (Array<String>)

            A list of users to be attached. There must be at least one user.

        • ScpActionDefinition — (map)

          The service control policies (SCPs) action definition details.

          • PolicyId — required — (String)

            The policy ID attached.

          • TargetIds — required — (Array<String>)

            A list of target IDs.

        • SsmActionDefinition — (map)

          The Amazon Web Services Systems Manager (SSM) action definition details.

          • ActionSubType — required — (String)

            The action subType.

            Possible values include:
            • "STOP_EC2_INSTANCES"
            • "STOP_RDS_INSTANCES"
          • Region — required — (String)

            The Region to run the SSM document.

          • InstanceIds — required — (Array<String>)

            The EC2 and RDS instance IDs.

      • ExecutionRoleArn — required — (String)

        The role passed for action execution and reversion. Roles and actions must be in the same account.

      • ApprovalModel — required — (String)

        This specifies if the action needs manual or automatic approval.

        Possible values include:
        • "AUTOMATIC"
        • "MANUAL"
      • Status — required — (String)

        The status of the action.

        Possible values include:
        • "STANDBY"
        • "PENDING"
        • "EXECUTION_IN_PROGRESS"
        • "EXECUTION_SUCCESS"
        • "EXECUTION_FAILURE"
        • "REVERSE_IN_PROGRESS"
        • "REVERSE_SUCCESS"
        • "REVERSE_FAILURE"
        • "RESET_IN_PROGRESS"
        • "RESET_FAILURE"
      • Subscribers — required — (Array<map>)

        A list of subscribers.

        • SubscriptionType — required — (String)

          The type of notification that Amazon Web Services sends to a subscriber.

          Possible values include:
          • "SNS"
          • "EMAIL"
        • Address — required — (String)

          The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

          When you create a subscriber, the value of Address can't contain line breaks.

    • NextToken — (String)

      A generic string.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
budgets.describeBudgetActionsForBudget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the user. It's a 12-digit number.

  • BudgetName — (String)

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • MaxResults — (Integer)

    An integer that represents how many entries a paginated response contains. The maximum is 100.

  • NextToken — (String)

    A generic string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Actions — (Array<map>)

      A list of the budget action resources information.

      • ActionId — required — (String)

        A system-generated universally unique identifier (UUID) for the action.

      • BudgetName — required — (String)

        A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

      • NotificationType — required — (String)

        The type of a notification. It must be ACTUAL or FORECASTED.

        Possible values include:
        • "ACTUAL"
        • "FORECASTED"
      • ActionType — required — (String)

        The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

        Possible values include:
        • "APPLY_IAM_POLICY"
        • "APPLY_SCP_POLICY"
        • "RUN_SSM_DOCUMENTS"
      • ActionThreshold — required — (map)

        The trigger threshold of the action.

        • ActionThresholdValue — required — (Float)

          The threshold of a notification.

        • ActionThresholdType — required — (String)

          The type of threshold for a notification.

          Possible values include:
          • "PERCENTAGE"
          • "ABSOLUTE_VALUE"
      • Definition — required — (map)

        Where you specify all of the type-specific parameters.

        • IamActionDefinition — (map)

          The Identity and Access Management (IAM) action definition details.

          • PolicyArn — required — (String)

            The Amazon Resource Name (ARN) of the policy to be attached.

          • Roles — (Array<String>)

            A list of roles to be attached. There must be at least one role.

          • Groups — (Array<String>)

            A list of groups to be attached. There must be at least one group.

          • Users — (Array<String>)

            A list of users to be attached. There must be at least one user.

        • ScpActionDefinition — (map)

          The service control policies (SCPs) action definition details.

          • PolicyId — required — (String)

            The policy ID attached.

          • TargetIds — required — (Array<String>)

            A list of target IDs.

        • SsmActionDefinition — (map)

          The Amazon Web Services Systems Manager (SSM) action definition details.

          • ActionSubType — required — (String)

            The action subType.

            Possible values include:
            • "STOP_EC2_INSTANCES"
            • "STOP_RDS_INSTANCES"
          • Region — required — (String)

            The Region to run the SSM document.

          • InstanceIds — required — (Array<String>)

            The EC2 and RDS instance IDs.

      • ExecutionRoleArn — required — (String)

        The role passed for action execution and reversion. Roles and actions must be in the same account.

      • ApprovalModel — required — (String)

        This specifies if the action needs manual or automatic approval.

        Possible values include:
        • "AUTOMATIC"
        • "MANUAL"
      • Status — required — (String)

        The status of the action.

        Possible values include:
        • "STANDBY"
        • "PENDING"
        • "EXECUTION_IN_PROGRESS"
        • "EXECUTION_SUCCESS"
        • "EXECUTION_FAILURE"
        • "REVERSE_IN_PROGRESS"
        • "REVERSE_SUCCESS"
        • "REVERSE_FAILURE"
        • "RESET_IN_PROGRESS"
        • "RESET_FAILURE"
      • Subscribers — required — (Array<map>)

        A list of subscribers.

        • SubscriptionType — required — (String)

          The type of notification that Amazon Web Services sends to a subscriber.

          Possible values include:
          • "SNS"
          • "EMAIL"
        • Address — required — (String)

          The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

          When you create a subscriber, the value of Address can't contain line breaks.

    • NextToken — (String)

      A generic string.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
budgets.describeBudgetNotificationsForAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the user. It's a 12-digit number.

  • MaxResults — (Integer)

    An integer that represents how many budgets a paginated response contains. The default is 50.

  • NextToken — (String)

    A generic string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • BudgetNotificationsForAccount — (Array<map>)

      A list of budget names and associated notifications for an account.

      • Notifications — (Array<map>)

        A list of notifications.

        • NotificationType — required — (String)

          Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

          Possible values include:
          • "ACTUAL"
          • "FORECASTED"
        • ComparisonOperator — required — (String)

          The comparison that's used for this notification.

          Possible values include:
          • "GREATER_THAN"
          • "LESS_THAN"
          • "EQUAL_TO"
        • Threshold — required — (Float)

          The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

        • ThresholdType — (String)

          The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

          Possible values include:
          • "PERCENTAGE"
          • "ABSOLUTE_VALUE"
        • NotificationState — (String)

          Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

          Possible values include:
          • "OK"
          • "ALARM"
      • BudgetName — (String)

        A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

    • NextToken — (String)

      A generic string.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  TimePeriod: {
    End: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    Start: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  }
};
budgets.describeBudgetPerformanceHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the user. It's a 12-digit number.

  • BudgetName — (String)

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • TimePeriod — (map)

    Retrieves how often the budget went into an ALARM state for the specified time period.

    • Start — (Date)

      The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

      You can change your start date with the UpdateBudget operation.

    • End — (Date)

      The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

      After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

  • MaxResults — (Integer)

    An integer that represents how many entries a paginated response contains. The maximum is 100.

  • NextToken — (String)

    A generic string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • BudgetPerformanceHistory — (map)

      The history of how often the budget has gone into an ALARM state.

      For DAILY budgets, the history saves the state of the budget for the last 60 days. For MONTHLY budgets, the history saves the state of the budget for the current month plus the last 12 months. For QUARTERLY budgets, the history saves the state of the budget for the last four quarters.

      • BudgetName — (String)

        A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

      • BudgetType — (String)

        The type of a budget. It must be one of the following types:

        COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE.

        Possible values include:
        • "USAGE"
        • "COST"
        • "RI_UTILIZATION"
        • "RI_COVERAGE"
        • "SAVINGS_PLANS_UTILIZATION"
        • "SAVINGS_PLANS_COVERAGE"
      • CostFilters — (map<Array<String>>)

        The history of the cost filters for a budget during the specified time period.

      • CostTypes — (map)

        The history of the cost types for a budget during the specified time period.

        • IncludeTax — (Boolean)

          Specifies whether a budget includes taxes.

          The default value is true.

        • IncludeSubscription — (Boolean)

          Specifies whether a budget includes subscriptions.

          The default value is true.

        • UseBlended — (Boolean)

          Specifies whether a budget uses a blended rate.

          The default value is false.

        • IncludeRefund — (Boolean)

          Specifies whether a budget includes refunds.

          The default value is true.

        • IncludeCredit — (Boolean)

          Specifies whether a budget includes credits.

          The default value is true.

        • IncludeUpfront — (Boolean)

          Specifies whether a budget includes upfront RI costs.

          The default value is true.

        • IncludeRecurring — (Boolean)

          Specifies whether a budget includes recurring fees such as monthly RI fees.

          The default value is true.

        • IncludeOtherSubscription — (Boolean)

          Specifies whether a budget includes non-RI subscription costs.

          The default value is true.

        • IncludeSupport — (Boolean)

          Specifies whether a budget includes support subscription fees.

          The default value is true.

        • IncludeDiscount — (Boolean)

          Specifies whether a budget includes discounts.

          The default value is true.

        • UseAmortized — (Boolean)

          Specifies whether a budget uses the amortized rate.

          The default value is false.

      • TimeUnit — (String)

        The time unit of the budget, such as MONTHLY or QUARTERLY.

        Possible values include:
        • "DAILY"
        • "MONTHLY"
        • "QUARTERLY"
        • "ANNUALLY"
      • BudgetedAndActualAmountsList — (Array<map>)

        A list of amounts of cost or usage that you created budgets for, which are compared to your actual costs or usage.

        • BudgetedAmount — (map)

          The amount of cost or usage that you created the budget for.

          • Amount — required — (String)

            The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

          • Unit — required — (String)

            The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

        • ActualAmount — (map)

          Your actual costs or usage for a budget period.

          • Amount — required — (String)

            The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

          • Unit — required — (String)

            The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

        • TimePeriod — (map)

          The time period that's covered by this budget comparison.

          • Start — (Date)

            The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

            You can change your start date with the UpdateBudget operation.

          • End — (Date)

            The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

            After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

    • NextToken — (String)

      A generic string.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
budgets.describeBudgets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budgets that you want to describe.

  • MaxResults — (Integer)

    An integer that represents how many budgets a paginated response contains. The default is 100.

  • NextToken — (String)

    The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Budgets — (Array<map>)

      A list of budgets.

      • BudgetName — required — (String)

        The name of a budget. The name must be unique within an account. The : and \ characters, and the "/action/" substring, aren't allowed in BudgetName.

      • BudgetLimit — (map)

        The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.

        BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.

        • Amount — required — (String)

          The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

        • Unit — required — (String)

          The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

      • PlannedBudgetLimits — (map<map>)

        A map containing multiple BudgetLimit, including current or future limits.

        PlannedBudgetLimits is available for cost or usage budget and supports both monthly and quarterly TimeUnit.

        For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

        For quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The key is the start of the quarter, UTC in epoch seconds.

        If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.

        If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

        After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.

        DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets that are created with PlannedBudgetLimits. Budgets that are created without PlannedBudgetLimits only contain BudgetLimit. They don't contain PlannedBudgetLimits.

        • Amount — required — (String)

          The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

        • Unit — required — (String)

          The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

      • CostFilters — (map<Array<String>>)

        The cost filters, such as Region, Service, LinkedAccount, Tag, or CostCategory, that are applied to a budget.

        Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:

        • Amazon EC2

        • Amazon Redshift

        • Amazon Relational Database Service

        • Amazon ElastiCache

        • Amazon OpenSearch Service

      • CostTypes — (map)

        The types of costs that are included in this COST budget.

        USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.

        • IncludeTax — (Boolean)

          Specifies whether a budget includes taxes.

          The default value is true.

        • IncludeSubscription — (Boolean)

          Specifies whether a budget includes subscriptions.

          The default value is true.

        • UseBlended — (Boolean)

          Specifies whether a budget uses a blended rate.

          The default value is false.

        • IncludeRefund — (Boolean)

          Specifies whether a budget includes refunds.

          The default value is true.

        • IncludeCredit — (Boolean)

          Specifies whether a budget includes credits.

          The default value is true.

        • IncludeUpfront — (Boolean)

          Specifies whether a budget includes upfront RI costs.

          The default value is true.

        • IncludeRecurring — (Boolean)

          Specifies whether a budget includes recurring fees such as monthly RI fees.

          The default value is true.

        • IncludeOtherSubscription — (Boolean)

          Specifies whether a budget includes non-RI subscription costs.

          The default value is true.

        • IncludeSupport — (Boolean)

          Specifies whether a budget includes support subscription fees.

          The default value is true.

        • IncludeDiscount — (Boolean)

          Specifies whether a budget includes discounts.

          The default value is true.

        • UseAmortized — (Boolean)

          Specifies whether a budget uses the amortized rate.

          The default value is false.

      • TimeUnit — required — (String)

        The length of time until a budget resets the actual and forecasted spend.

        Possible values include:
        • "DAILY"
        • "MONTHLY"
        • "QUARTERLY"
        • "ANNUALLY"
      • TimePeriod — (map)

        The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.

        If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

        You can change either date with the UpdateBudget operation.

        After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.

        • Start — (Date)

          The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

          You can change your start date with the UpdateBudget operation.

        • End — (Date)

          The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

          After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

      • CalculatedSpend — (map)

        The actual and forecasted cost or usage that the budget tracks.

        • ActualSpend — required — (map)

          The amount of cost, usage, RI units, or Savings Plans units that you used.

          • Amount — required — (String)

            The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

          • Unit — required — (String)

            The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

        • ForecastedSpend — (map)

          The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.

          • Amount — required — (String)

            The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

          • Unit — required — (String)

            The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

      • BudgetType — required — (String)

        Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

        Possible values include:
        • "USAGE"
        • "COST"
        • "RI_UTILIZATION"
        • "RI_COVERAGE"
        • "SAVINGS_PLANS_UTILIZATION"
        • "SAVINGS_PLANS_COVERAGE"
      • LastUpdatedTime — (Date)

        The last time that you updated this budget.

      • AutoAdjustData — (map)

        The parameters that determine the budget amount for an auto-adjusting budget.

        • AutoAdjustType — required — (String)

          The string that defines whether your budget auto-adjusts based on historical or forecasted data.

          Possible values include:
          • "HISTORICAL"
          • "FORECAST"
        • HistoricalOptions — (map)

          The parameters that define or describe the historical data that your auto-adjusting budget is based on.

          • BudgetAdjustmentPeriod — required — (Integer)

            The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:

            • For the DAILY granularity, the maximum value is 60.

            • For the MONTHLY granularity, the maximum value is 12.

            • For the QUARTERLY granularity, the maximum value is 4.

            • For the ANNUALLY granularity, the maximum value is 1.

          • LookBackAvailablePeriods — (Integer)

            The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.

            For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3.

            You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.

        • LastAutoAdjustTime — (Date)

          The last time that your budget was auto-adjusted.

    • NextToken — (String)

      The pagination token in the service response that indicates the next set of results that you can retrieve.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
budgets.describeNotificationsForBudget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget whose notifications you want descriptions of.

  • BudgetName — (String)

    The name of the budget whose notifications you want descriptions of.

  • MaxResults — (Integer)

    An optional integer that represents how many entries a paginated response contains.

  • NextToken — (String)

    The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Notifications — (Array<map>)

      A list of notifications that are associated with a budget.

      • NotificationType — required — (String)

        Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

        Possible values include:
        • "ACTUAL"
        • "FORECASTED"
      • ComparisonOperator — required — (String)

        The comparison that's used for this notification.

        Possible values include:
        • "GREATER_THAN"
        • "LESS_THAN"
        • "EQUAL_TO"
      • Threshold — required — (Float)

        The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

      • ThresholdType — (String)

        The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

        Possible values include:
        • "PERCENTAGE"
        • "ABSOLUTE_VALUE"
      • NotificationState — (String)

        Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

        Possible values include:
        • "OK"
        • "ALARM"
    • NextToken — (String)

      The pagination token in the service response that indicates the next set of results that you can retrieve.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  Notification: { /* required */
    ComparisonOperator: GREATER_THAN | LESS_THAN | EQUAL_TO, /* required */
    NotificationType: ACTUAL | FORECASTED, /* required */
    Threshold: 'NUMBER_VALUE', /* required */
    NotificationState: OK | ALARM,
    ThresholdType: PERCENTAGE | ABSOLUTE_VALUE
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
budgets.describeSubscribersForNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget whose subscribers you want descriptions of.

  • BudgetName — (String)

    The name of the budget whose subscribers you want descriptions of.

  • Notification — (map)

    The notification whose subscribers you want to list.

    • NotificationType — required — (String)

      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

      Possible values include:
      • "ACTUAL"
      • "FORECASTED"
    • ComparisonOperator — required — (String)

      The comparison that's used for this notification.

      Possible values include:
      • "GREATER_THAN"
      • "LESS_THAN"
      • "EQUAL_TO"
    • Threshold — required — (Float)

      The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

    • ThresholdType — (String)

      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

      Possible values include:
      • "PERCENTAGE"
      • "ABSOLUTE_VALUE"
    • NotificationState — (String)

      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

      Possible values include:
      • "OK"
      • "ALARM"
  • MaxResults — (Integer)

    An optional integer that represents how many entries a paginated response contains.

  • NextToken — (String)

    The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Subscribers — (Array<map>)

      A list of subscribers that are associated with a notification.

      • SubscriptionType — required — (String)

        The type of notification that Amazon Web Services sends to a subscriber.

        Possible values include:
        • "SNS"
        • "EMAIL"
      • Address — required — (String)

        The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

        When you create a subscriber, the value of Address can't contain line breaks.

    • NextToken — (String)

      The pagination token in the service response that indicates the next set of results that you can retrieve.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ActionId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  ExecutionType: APPROVE_BUDGET_ACTION | RETRY_BUDGET_ACTION | REVERSE_BUDGET_ACTION | RESET_BUDGET_ACTION /* required */
};
budgets.executeBudgetAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the user. It's a 12-digit number.

  • BudgetName — (String)

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • ActionId — (String)

    A system-generated universally unique identifier (UUID) for the action.

  • ExecutionType — (String)

    The type of execution.

    Possible values include:
    • "APPROVE_BUDGET_ACTION"
    • "RETRY_BUDGET_ACTION"
    • "REVERSE_BUDGET_ACTION"
    • "RESET_BUDGET_ACTION"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountId — (String)

      The account ID of the user. It's a 12-digit number.

    • BudgetName — (String)

      A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

    • ActionId — (String)

      A system-generated universally unique identifier (UUID) for the action.

    • ExecutionType — (String)

      The type of execution.

      Possible values include:
      • "APPROVE_BUDGET_ACTION"
      • "RETRY_BUDGET_ACTION"
      • "REVERSE_BUDGET_ACTION"
      • "RESET_BUDGET_ACTION"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
budgets.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

    The unique identifier for the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ResourceTags — (Array<map>)

      The tags associated with the resource.

      • Key — required — (String)

        The key that's associated with the tag.

      • Value — required — (String)

        The value that's associated with the tag.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  ResourceTags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
budgets.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

    The unique identifier for the resource.

  • ResourceTags — (Array<map>)

    The tags associated with the resource.

    • Key — required — (String)

      The key that's associated with the tag.

    • Value — required — (String)

      The value that's associated with the tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  ResourceTagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
budgets.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

    The unique identifier for the resource.

  • ResourceTagKeys — (Array<String>)

    The key that's associated with the tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  NewBudget: { /* required */
    BudgetName: 'STRING_VALUE', /* required */
    BudgetType: USAGE | COST | RI_UTILIZATION | RI_COVERAGE | SAVINGS_PLANS_UTILIZATION | SAVINGS_PLANS_COVERAGE, /* required */
    TimeUnit: DAILY | MONTHLY | QUARTERLY | ANNUALLY, /* required */
    AutoAdjustData: {
      AutoAdjustType: HISTORICAL | FORECAST, /* required */
      HistoricalOptions: {
        BudgetAdjustmentPeriod: 'NUMBER_VALUE', /* required */
        LookBackAvailablePeriods: 'NUMBER_VALUE'
      },
      LastAutoAdjustTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
    },
    BudgetLimit: {
      Amount: 'STRING_VALUE', /* required */
      Unit: 'STRING_VALUE' /* required */
    },
    CalculatedSpend: {
      ActualSpend: { /* required */
        Amount: 'STRING_VALUE', /* required */
        Unit: 'STRING_VALUE' /* required */
      },
      ForecastedSpend: {
        Amount: 'STRING_VALUE', /* required */
        Unit: 'STRING_VALUE' /* required */
      }
    },
    CostFilters: {
      '<GenericString>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<GenericString>': ... */
    },
    CostTypes: {
      IncludeCredit: true || false,
      IncludeDiscount: true || false,
      IncludeOtherSubscription: true || false,
      IncludeRecurring: true || false,
      IncludeRefund: true || false,
      IncludeSubscription: true || false,
      IncludeSupport: true || false,
      IncludeTax: true || false,
      IncludeUpfront: true || false,
      UseAmortized: true || false,
      UseBlended: true || false
    },
    LastUpdatedTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    PlannedBudgetLimits: {
      '<GenericString>': {
        Amount: 'STRING_VALUE', /* required */
        Unit: 'STRING_VALUE' /* required */
      },
      /* '<GenericString>': ... */
    },
    TimePeriod: {
      End: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      Start: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
    }
  }
};
budgets.updateBudget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget that you want to update.

  • NewBudget — (map)

    The budget that you want to update your budget to.

    • BudgetName — required — (String)

      The name of a budget. The name must be unique within an account. The : and \ characters, and the "/action/" substring, aren't allowed in BudgetName.

    • BudgetLimit — (map)

      The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.

      BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.

      • Amount — required — (String)

        The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

      • Unit — required — (String)

        The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

    • PlannedBudgetLimits — (map<map>)

      A map containing multiple BudgetLimit, including current or future limits.

      PlannedBudgetLimits is available for cost or usage budget and supports both monthly and quarterly TimeUnit.

      For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

      For quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The key is the start of the quarter, UTC in epoch seconds.

      If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.

      If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

      After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.

      DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets that are created with PlannedBudgetLimits. Budgets that are created without PlannedBudgetLimits only contain BudgetLimit. They don't contain PlannedBudgetLimits.

      • Amount — required — (String)

        The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

      • Unit — required — (String)

        The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

    • CostFilters — (map<Array<String>>)

      The cost filters, such as Region, Service, LinkedAccount, Tag, or CostCategory, that are applied to a budget.

      Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:

      • Amazon EC2

      • Amazon Redshift

      • Amazon Relational Database Service

      • Amazon ElastiCache

      • Amazon OpenSearch Service

    • CostTypes — (map)

      The types of costs that are included in this COST budget.

      USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.

      • IncludeTax — (Boolean)

        Specifies whether a budget includes taxes.

        The default value is true.

      • IncludeSubscription — (Boolean)

        Specifies whether a budget includes subscriptions.

        The default value is true.

      • UseBlended — (Boolean)

        Specifies whether a budget uses a blended rate.

        The default value is false.

      • IncludeRefund — (Boolean)

        Specifies whether a budget includes refunds.

        The default value is true.

      • IncludeCredit — (Boolean)

        Specifies whether a budget includes credits.

        The default value is true.

      • IncludeUpfront — (Boolean)

        Specifies whether a budget includes upfront RI costs.

        The default value is true.

      • IncludeRecurring — (Boolean)

        Specifies whether a budget includes recurring fees such as monthly RI fees.

        The default value is true.

      • IncludeOtherSubscription — (Boolean)

        Specifies whether a budget includes non-RI subscription costs.

        The default value is true.

      • IncludeSupport — (Boolean)

        Specifies whether a budget includes support subscription fees.

        The default value is true.

      • IncludeDiscount — (Boolean)

        Specifies whether a budget includes discounts.

        The default value is true.

      • UseAmortized — (Boolean)

        Specifies whether a budget uses the amortized rate.

        The default value is false.

    • TimeUnit — required — (String)

      The length of time until a budget resets the actual and forecasted spend.

      Possible values include:
      • "DAILY"
      • "MONTHLY"
      • "QUARTERLY"
      • "ANNUALLY"
    • TimePeriod — (map)

      The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.

      If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

      You can change either date with the UpdateBudget operation.

      After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.

      • Start — (Date)

        The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

        You can change your start date with the UpdateBudget operation.

      • End — (Date)

        The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

        After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

    • CalculatedSpend — (map)

      The actual and forecasted cost or usage that the budget tracks.

      • ActualSpend — required — (map)

        The amount of cost, usage, RI units, or Savings Plans units that you used.

        • Amount — required — (String)

          The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

        • Unit — required — (String)

          The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

      • ForecastedSpend — (map)

        The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.

        • Amount — required — (String)

          The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

        • Unit — required — (String)

          The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

    • BudgetType — required — (String)

      Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

      Possible values include:
      • "USAGE"
      • "COST"
      • "RI_UTILIZATION"
      • "RI_COVERAGE"
      • "SAVINGS_PLANS_UTILIZATION"
      • "SAVINGS_PLANS_COVERAGE"
    • LastUpdatedTime — (Date)

      The last time that you updated this budget.

    • AutoAdjustData — (map)

      The parameters that determine the budget amount for an auto-adjusting budget.

      • AutoAdjustType — required — (String)

        The string that defines whether your budget auto-adjusts based on historical or forecasted data.

        Possible values include:
        • "HISTORICAL"
        • "FORECAST"
      • HistoricalOptions — (map)

        The parameters that define or describe the historical data that your auto-adjusting budget is based on.

        • BudgetAdjustmentPeriod — required — (Integer)

          The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:

          • For the DAILY granularity, the maximum value is 60.

          • For the MONTHLY granularity, the maximum value is 12.

          • For the QUARTERLY granularity, the maximum value is 4.

          • For the ANNUALLY granularity, the maximum value is 1.

        • LookBackAvailablePeriods — (Integer)

          The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.

          For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3.

          You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.

      • LastAutoAdjustTime — (Date)

        The last time that your budget was auto-adjusted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ActionId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  ActionThreshold: {
    ActionThresholdType: PERCENTAGE | ABSOLUTE_VALUE, /* required */
    ActionThresholdValue: 'NUMBER_VALUE' /* required */
  },
  ApprovalModel: AUTOMATIC | MANUAL,
  Definition: {
    IamActionDefinition: {
      PolicyArn: 'STRING_VALUE', /* required */
      Groups: [
        'STRING_VALUE',
        /* more items */
      ],
      Roles: [
        'STRING_VALUE',
        /* more items */
      ],
      Users: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    ScpActionDefinition: {
      PolicyId: 'STRING_VALUE', /* required */
      TargetIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    SsmActionDefinition: {
      ActionSubType: STOP_EC2_INSTANCES | STOP_RDS_INSTANCES, /* required */
      InstanceIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Region: 'STRING_VALUE' /* required */
    }
  },
  ExecutionRoleArn: 'STRING_VALUE',
  NotificationType: ACTUAL | FORECASTED,
  Subscribers: [
    {
      Address: 'STRING_VALUE', /* required */
      SubscriptionType: SNS | EMAIL /* required */
    },
    /* more items */
  ]
};
budgets.updateBudgetAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The account ID of the user. It's a 12-digit number.

  • BudgetName — (String)

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • ActionId — (String)

    A system-generated universally unique identifier (UUID) for the action.

  • NotificationType — (String)

    The type of a notification. It must be ACTUAL or FORECASTED.

    Possible values include:
    • "ACTUAL"
    • "FORECASTED"
  • ActionThreshold — (map)

    The trigger threshold of the action.

    • ActionThresholdValue — required — (Float)

      The threshold of a notification.

    • ActionThresholdType — required — (String)

      The type of threshold for a notification.

      Possible values include:
      • "PERCENTAGE"
      • "ABSOLUTE_VALUE"
  • Definition — (map)

    Specifies all of the type-specific parameters.

    • IamActionDefinition — (map)

      The Identity and Access Management (IAM) action definition details.

      • PolicyArn — required — (String)

        The Amazon Resource Name (ARN) of the policy to be attached.

      • Roles — (Array<String>)

        A list of roles to be attached. There must be at least one role.

      • Groups — (Array<String>)

        A list of groups to be attached. There must be at least one group.

      • Users — (Array<String>)

        A list of users to be attached. There must be at least one user.

    • ScpActionDefinition — (map)

      The service control policies (SCPs) action definition details.

      • PolicyId — required — (String)

        The policy ID attached.

      • TargetIds — required — (Array<String>)

        A list of target IDs.

    • SsmActionDefinition — (map)

      The Amazon Web Services Systems Manager (SSM) action definition details.

      • ActionSubType — required — (String)

        The action subType.

        Possible values include:
        • "STOP_EC2_INSTANCES"
        • "STOP_RDS_INSTANCES"
      • Region — required — (String)

        The Region to run the SSM document.

      • InstanceIds — required — (Array<String>)

        The EC2 and RDS instance IDs.

  • ExecutionRoleArn — (String)

    The role passed for action execution and reversion. Roles and actions must be in the same account.

  • ApprovalModel — (String)

    This specifies if the action needs manual or automatic approval.

    Possible values include:
    • "AUTOMATIC"
    • "MANUAL"
  • Subscribers — (Array<map>)

    A list of subscribers.

    • SubscriptionType — required — (String)

      The type of notification that Amazon Web Services sends to a subscriber.

      Possible values include:
      • "SNS"
      • "EMAIL"
    • Address — required — (String)

      The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

      When you create a subscriber, the value of Address can't contain line breaks.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountId — (String)

      The account ID of the user. It's a 12-digit number.

    • BudgetName — (String)

      A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

    • OldAction — (map)

      The previous action resource information.

      • ActionId — required — (String)

        A system-generated universally unique identifier (UUID) for the action.

      • BudgetName — required — (String)

        A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

      • NotificationType — required — (String)

        The type of a notification. It must be ACTUAL or FORECASTED.

        Possible values include:
        • "ACTUAL"
        • "FORECASTED"
      • ActionType — required — (String)

        The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

        Possible values include:
        • "APPLY_IAM_POLICY"
        • "APPLY_SCP_POLICY"
        • "RUN_SSM_DOCUMENTS"
      • ActionThreshold — required — (map)

        The trigger threshold of the action.

        • ActionThresholdValue — required — (Float)

          The threshold of a notification.

        • ActionThresholdType — required — (String)

          The type of threshold for a notification.

          Possible values include:
          • "PERCENTAGE"
          • "ABSOLUTE_VALUE"
      • Definition — required — (map)

        Where you specify all of the type-specific parameters.

        • IamActionDefinition — (map)

          The Identity and Access Management (IAM) action definition details.

          • PolicyArn — required — (String)

            The Amazon Resource Name (ARN) of the policy to be attached.

          • Roles — (Array<String>)

            A list of roles to be attached. There must be at least one role.

          • Groups — (Array<String>)

            A list of groups to be attached. There must be at least one group.

          • Users — (Array<String>)

            A list of users to be attached. There must be at least one user.

        • ScpActionDefinition — (map)

          The service control policies (SCPs) action definition details.

          • PolicyId — required — (String)

            The policy ID attached.

          • TargetIds — required — (Array<String>)

            A list of target IDs.

        • SsmActionDefinition — (map)

          The Amazon Web Services Systems Manager (SSM) action definition details.

          • ActionSubType — required — (String)

            The action subType.

            Possible values include:
            • "STOP_EC2_INSTANCES"
            • "STOP_RDS_INSTANCES"
          • Region — required — (String)

            The Region to run the SSM document.

          • InstanceIds — required — (Array<String>)

            The EC2 and RDS instance IDs.

      • ExecutionRoleArn — required — (String)

        The role passed for action execution and reversion. Roles and actions must be in the same account.

      • ApprovalModel — required — (String)

        This specifies if the action needs manual or automatic approval.

        Possible values include:
        • "AUTOMATIC"
        • "MANUAL"
      • Status — required — (String)

        The status of the action.

        Possible values include:
        • "STANDBY"
        • "PENDING"
        • "EXECUTION_IN_PROGRESS"
        • "EXECUTION_SUCCESS"
        • "EXECUTION_FAILURE"
        • "REVERSE_IN_PROGRESS"
        • "REVERSE_SUCCESS"
        • "REVERSE_FAILURE"
        • "RESET_IN_PROGRESS"
        • "RESET_FAILURE"
      • Subscribers — required — (Array<map>)

        A list of subscribers.

        • SubscriptionType — required — (String)

          The type of notification that Amazon Web Services sends to a subscriber.

          Possible values include:
          • "SNS"
          • "EMAIL"
        • Address — required — (String)

          The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

          When you create a subscriber, the value of Address can't contain line breaks.

    • NewAction — (map)

      The updated action resource information.

      • ActionId — required — (String)

        A system-generated universally unique identifier (UUID) for the action.

      • BudgetName — required — (String)

        A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

      • NotificationType — required — (String)

        The type of a notification. It must be ACTUAL or FORECASTED.

        Possible values include:
        • "ACTUAL"
        • "FORECASTED"
      • ActionType — required — (String)

        The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

        Possible values include:
        • "APPLY_IAM_POLICY"
        • "APPLY_SCP_POLICY"
        • "RUN_SSM_DOCUMENTS"
      • ActionThreshold — required — (map)

        The trigger threshold of the action.

        • ActionThresholdValue — required — (Float)

          The threshold of a notification.

        • ActionThresholdType — required — (String)

          The type of threshold for a notification.

          Possible values include:
          • "PERCENTAGE"
          • "ABSOLUTE_VALUE"
      • Definition — required — (map)

        Where you specify all of the type-specific parameters.

        • IamActionDefinition — (map)

          The Identity and Access Management (IAM) action definition details.

          • PolicyArn — required — (String)

            The Amazon Resource Name (ARN) of the policy to be attached.

          • Roles — (Array<String>)

            A list of roles to be attached. There must be at least one role.

          • Groups — (Array<String>)

            A list of groups to be attached. There must be at least one group.

          • Users — (Array<String>)

            A list of users to be attached. There must be at least one user.

        • ScpActionDefinition — (map)

          The service control policies (SCPs) action definition details.

          • PolicyId — required — (String)

            The policy ID attached.

          • TargetIds — required — (Array<String>)

            A list of target IDs.

        • SsmActionDefinition — (map)

          The Amazon Web Services Systems Manager (SSM) action definition details.

          • ActionSubType — required — (String)

            The action subType.

            Possible values include:
            • "STOP_EC2_INSTANCES"
            • "STOP_RDS_INSTANCES"
          • Region — required — (String)

            The Region to run the SSM document.

          • InstanceIds — required — (Array<String>)

            The EC2 and RDS instance IDs.

      • ExecutionRoleArn — required — (String)

        The role passed for action execution and reversion. Roles and actions must be in the same account.

      • ApprovalModel — required — (String)

        This specifies if the action needs manual or automatic approval.

        Possible values include:
        • "AUTOMATIC"
        • "MANUAL"
      • Status — required — (String)

        The status of the action.

        Possible values include:
        • "STANDBY"
        • "PENDING"
        • "EXECUTION_IN_PROGRESS"
        • "EXECUTION_SUCCESS"
        • "EXECUTION_FAILURE"
        • "REVERSE_IN_PROGRESS"
        • "REVERSE_SUCCESS"
        • "REVERSE_FAILURE"
        • "RESET_IN_PROGRESS"
        • "RESET_FAILURE"
      • Subscribers — required — (Array<map>)

        A list of subscribers.

        • SubscriptionType — required — (String)

          The type of notification that Amazon Web Services sends to a subscriber.

          Possible values include:
          • "SNS"
          • "EMAIL"
        • Address — required — (String)

          The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

          When you create a subscriber, the value of Address can't contain line breaks.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  NewNotification: { /* required */
    ComparisonOperator: GREATER_THAN | LESS_THAN | EQUAL_TO, /* required */
    NotificationType: ACTUAL | FORECASTED, /* required */
    Threshold: 'NUMBER_VALUE', /* required */
    NotificationState: OK | ALARM,
    ThresholdType: PERCENTAGE | ABSOLUTE_VALUE
  },
  OldNotification: { /* required */
    ComparisonOperator: GREATER_THAN | LESS_THAN | EQUAL_TO, /* required */
    NotificationType: ACTUAL | FORECASTED, /* required */
    Threshold: 'NUMBER_VALUE', /* required */
    NotificationState: OK | ALARM,
    ThresholdType: PERCENTAGE | ABSOLUTE_VALUE
  }
};
budgets.updateNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget whose notification you want to update.

  • BudgetName — (String)

    The name of the budget whose notification you want to update.

  • OldNotification — (map)

    The previous notification that is associated with a budget.

    • NotificationType — required — (String)

      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

      Possible values include:
      • "ACTUAL"
      • "FORECASTED"
    • ComparisonOperator — required — (String)

      The comparison that's used for this notification.

      Possible values include:
      • "GREATER_THAN"
      • "LESS_THAN"
      • "EQUAL_TO"
    • Threshold — required — (Float)

      The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

    • ThresholdType — (String)

      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

      Possible values include:
      • "PERCENTAGE"
      • "ABSOLUTE_VALUE"
    • NotificationState — (String)

      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

      Possible values include:
      • "OK"
      • "ALARM"
  • NewNotification — (map)

    The updated notification to be associated with a budget.

    • NotificationType — required — (String)

      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

      Possible values include:
      • "ACTUAL"
      • "FORECASTED"
    • ComparisonOperator — required — (String)

      The comparison that's used for this notification.

      Possible values include:
      • "GREATER_THAN"
      • "LESS_THAN"
      • "EQUAL_TO"
    • Threshold — required — (Float)

      The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

    • ThresholdType — (String)

      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

      Possible values include:
      • "PERCENTAGE"
      • "ABSOLUTE_VALUE"
    • NotificationState — (String)

      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

      Possible values include:
      • "OK"
      • "ALARM"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BudgetName: 'STRING_VALUE', /* required */
  NewSubscriber: { /* required */
    Address: 'STRING_VALUE', /* required */
    SubscriptionType: SNS | EMAIL /* required */
  },
  Notification: { /* required */
    ComparisonOperator: GREATER_THAN | LESS_THAN | EQUAL_TO, /* required */
    NotificationType: ACTUAL | FORECASTED, /* required */
    Threshold: 'NUMBER_VALUE', /* required */
    NotificationState: OK | ALARM,
    ThresholdType: PERCENTAGE | ABSOLUTE_VALUE
  },
  OldSubscriber: { /* required */
    Address: 'STRING_VALUE', /* required */
    SubscriptionType: SNS | EMAIL /* required */
  }
};
budgets.updateSubscriber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The accountId that is associated with the budget whose subscriber you want to update.

  • BudgetName — (String)

    The name of the budget whose subscriber you want to update.

  • Notification — (map)

    The notification whose subscriber you want to update.

    • NotificationType — required — (String)

      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

      Possible values include:
      • "ACTUAL"
      • "FORECASTED"
    • ComparisonOperator — required — (String)

      The comparison that's used for this notification.

      Possible values include:
      • "GREATER_THAN"
      • "LESS_THAN"
      • "EQUAL_TO"
    • Threshold — required — (Float)

      The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

    • ThresholdType — (String)

      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

      Possible values include:
      • "PERCENTAGE"
      • "ABSOLUTE_VALUE"
    • NotificationState — (String)

      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

      Possible values include:
      • "OK"
      • "ALARM"
  • OldSubscriber — (map)

    The previous subscriber that is associated with a budget notification.

    • SubscriptionType — required — (String)

      The type of notification that Amazon Web Services sends to a subscriber.

      Possible values include:
      • "SNS"
      • "EMAIL"
    • Address — required — (String)

      The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

      When you create a subscriber, the value of Address can't contain line breaks.

  • NewSubscriber — (map)

    The updated subscriber that is associated with a budget notification.

    • SubscriptionType — required — (String)

      The type of notification that Amazon Web Services sends to a subscriber.

      Possible values include:
      • "SNS"
      • "EMAIL"
    • Address — required — (String)

      The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

      When you create a subscriber, the value of Address can't contain line breaks.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.