Table Of Contents

Contents

  1. Docs
  2. Available Services
  3. Budgets

Budgets

Table of Contents

Client

class Budgets.Client

A low-level client representing AWS Budgets:

client = session.create_client('budgets')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters:operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you’d normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns:True if the operation can be paginated, False otherwise.
create_budget(**kwargs)

Create a new budget

See also: AWS API Documentation

Request Syntax

response = client.create_budget(
    AccountId='string',
    Budget={
        'BudgetName': 'string',
        'BudgetLimit': {
            'Amount': 'string',
            'Unit': 'string'
        },
        'CostFilters': {
            'string': [
                'string',
            ]
        },
        'CostTypes': {
            'IncludeTax': True|False,
            'IncludeSubscription': True|False,
            'UseBlended': True|False
        },
        'TimeUnit': 'DAILY'|'MONTHLY'|'QUARTERLY'|'ANNUALLY',
        'TimePeriod': {
            'Start': datetime(2015, 1, 1),
            'End': datetime(2015, 1, 1)
        },
        'CalculatedSpend': {
            'ActualSpend': {
                'Amount': 'string',
                'Unit': 'string'
            },
            'ForecastedSpend': {
                'Amount': 'string',
                'Unit': 'string'
            }
        },
        'BudgetType': 'USAGE'|'COST'|'RI_UTILIZATION'
    },
    NotificationsWithSubscribers=[
        {
            'Notification': {
                'NotificationType': 'ACTUAL'|'FORECASTED',
                'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
                'Threshold': 123.0
            },
            'Subscribers': [
                {
                    'SubscriptionType': 'SNS'|'EMAIL',
                    'Address': 'string'
                },
            ]
        },
    ]
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • Budget (dict) –

    [REQUIRED] AWS Budget model

    • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
    • BudgetLimit (dict) – [REQUIRED] A structure represent either a cost spend or usage spend. Contains an amount and a unit.
      • Amount (string) – [REQUIRED] A string to represent NumericValue.
      • Unit (string) – [REQUIRED] A string to represent budget spend unit. It should be not null and not empty.
    • CostFilters (dict) – A map represents the cost filters applied to the budget.
      • (string) – A generic String.
        • (list) –
          • (string) – A generic String.
    • CostTypes (dict) – [REQUIRED] This includes the options for getting the cost of a budget.
      • IncludeTax (boolean) – [REQUIRED] A generic boolean value.
      • IncludeSubscription (boolean) – [REQUIRED] A generic boolean value.
      • UseBlended (boolean) – [REQUIRED] A generic boolean value.
    • TimeUnit (string) – [REQUIRED] The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.
    • TimePeriod (dict) – [REQUIRED] A time period indicated the start date and end date of a budget.
      • Start (datetime) – [REQUIRED] A generic timestamp. In Java it is transformed to a Date object.
      • End (datetime) – [REQUIRED] A generic timestamp. In Java it is transformed to a Date object.
    • CalculatedSpend (dict) – A structure holds the actual and forecasted spend for a budget.
      • ActualSpend (dict) – [REQUIRED] A structure represent either a cost spend or usage spend. Contains an amount and a unit.
        • Amount (string) – [REQUIRED] A string to represent NumericValue.
        • Unit (string) – [REQUIRED] A string to represent budget spend unit. It should be not null and not empty.
      • ForecastedSpend (dict) – A structure represent either a cost spend or usage spend. Contains an amount and a unit.
        • Amount (string) – [REQUIRED] A string to represent NumericValue.
        • Unit (string) – [REQUIRED] A string to represent budget spend unit. It should be not null and not empty.
    • BudgetType (string) – [REQUIRED] The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.
  • NotificationsWithSubscribers (list) –

    A list of Notifications, each with a list of subscribers.

    • (dict) – A structure to relate notification and a list of subscribers who belong to the notification.
      • Notification (dict) – [REQUIRED] Notification model. Each budget may contain multiple notifications with different settings.
        • NotificationType (string) – [REQUIRED] The type of a notification. It should be ACTUAL or FORECASTED.
        • ComparisonOperator (string) – [REQUIRED] The comparison operator of a notification. Currently we support less than, equal to and greater than.
        • Threshold (float) – [REQUIRED] The threshold of the a notification. It should be a number between 0 and 100.
      • Subscribers (list) – [REQUIRED] A list of subscribers.
        • (dict) – Subscriber model. Each notification may contain multiple subscribers with different addresses.
          • SubscriptionType (string) – [REQUIRED] The subscription type of the subscriber. It can be SMS or EMAIL.
          • Address (string) – [REQUIRED] A generic String.
Return type:

dict
Returns:

Response Syntax

{}

Response Structure

  • (dict) – Response of CreateBudget
create_notification(**kwargs)

Create a new Notification with subscribers for a budget

See also: AWS API Documentation

Request Syntax

response = client.create_notification(
    AccountId='string',
    BudgetName='string',
    Notification={
        'NotificationType': 'ACTUAL'|'FORECASTED',
        'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
        'Threshold': 123.0
    },
    Subscribers=[
        {
            'SubscriptionType': 'SNS'|'EMAIL',
            'Address': 'string'
        },
    ]
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
  • Notification (dict) –

    [REQUIRED] Notification model. Each budget may contain multiple notifications with different settings.

    • NotificationType (string) – [REQUIRED] The type of a notification. It should be ACTUAL or FORECASTED.
    • ComparisonOperator (string) – [REQUIRED] The comparison operator of a notification. Currently we support less than, equal to and greater than.
    • Threshold (float) – [REQUIRED] The threshold of the a notification. It should be a number between 0 and 100.
  • Subscribers (list) –

    [REQUIRED] A list of subscribers.

    • (dict) – Subscriber model. Each notification may contain multiple subscribers with different addresses.
      • SubscriptionType (string) – [REQUIRED] The subscription type of the subscriber. It can be SMS or EMAIL.
      • Address (string) – [REQUIRED] A generic String.
Return type:

dict
Returns:

Response Syntax

{}

Response Structure

  • (dict) – Response of CreateNotification
create_subscriber(**kwargs)

Create a new Subscriber for a notification

See also: AWS API Documentation

Request Syntax

response = client.create_subscriber(
    AccountId='string',
    BudgetName='string',
    Notification={
        'NotificationType': 'ACTUAL'|'FORECASTED',
        'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
        'Threshold': 123.0
    },
    Subscriber={
        'SubscriptionType': 'SNS'|'EMAIL',
        'Address': 'string'
    }
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
  • Notification (dict) –

    [REQUIRED] Notification model. Each budget may contain multiple notifications with different settings.

    • NotificationType (string) – [REQUIRED] The type of a notification. It should be ACTUAL or FORECASTED.
    • ComparisonOperator (string) – [REQUIRED] The comparison operator of a notification. Currently we support less than, equal to and greater than.
    • Threshold (float) – [REQUIRED] The threshold of the a notification. It should be a number between 0 and 100.
  • Subscriber (dict) –

    [REQUIRED] Subscriber model. Each notification may contain multiple subscribers with different addresses.

    • SubscriptionType (string) – [REQUIRED] The subscription type of the subscriber. It can be SMS or EMAIL.
    • Address (string) – [REQUIRED] A generic String.
Return type:

dict
Returns:

Response Syntax

{}

Response Structure

  • (dict) – Response of CreateSubscriber
delete_budget(**kwargs)

Delete a budget and related notifications

See also: AWS API Documentation

Request Syntax

response = client.delete_budget(
    AccountId='string',
    BudgetName='string'
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
Return type:

dict
Returns:

Response Syntax

{}

Response Structure

  • (dict) – Response of DeleteBudget
delete_notification(**kwargs)

Delete a notification and related subscribers

See also: AWS API Documentation

Request Syntax

response = client.delete_notification(
    AccountId='string',
    BudgetName='string',
    Notification={
        'NotificationType': 'ACTUAL'|'FORECASTED',
        'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
        'Threshold': 123.0
    }
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
  • Notification (dict) –

    [REQUIRED] Notification model. Each budget may contain multiple notifications with different settings.

    • NotificationType (string) – [REQUIRED] The type of a notification. It should be ACTUAL or FORECASTED.
    • ComparisonOperator (string) – [REQUIRED] The comparison operator of a notification. Currently we support less than, equal to and greater than.
    • Threshold (float) – [REQUIRED] The threshold of the a notification. It should be a number between 0 and 100.
Return type:

dict
Returns:

Response Syntax

{}

Response Structure

  • (dict) – Response of DeleteNotification
delete_subscriber(**kwargs)

Delete a Subscriber for a notification

See also: AWS API Documentation

Request Syntax

response = client.delete_subscriber(
    AccountId='string',
    BudgetName='string',
    Notification={
        'NotificationType': 'ACTUAL'|'FORECASTED',
        'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
        'Threshold': 123.0
    },
    Subscriber={
        'SubscriptionType': 'SNS'|'EMAIL',
        'Address': 'string'
    }
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
  • Notification (dict) –

    [REQUIRED] Notification model. Each budget may contain multiple notifications with different settings.

    • NotificationType (string) – [REQUIRED] The type of a notification. It should be ACTUAL or FORECASTED.
    • ComparisonOperator (string) – [REQUIRED] The comparison operator of a notification. Currently we support less than, equal to and greater than.
    • Threshold (float) – [REQUIRED] The threshold of the a notification. It should be a number between 0 and 100.
  • Subscriber (dict) –

    [REQUIRED] Subscriber model. Each notification may contain multiple subscribers with different addresses.

    • SubscriptionType (string) – [REQUIRED] The subscription type of the subscriber. It can be SMS or EMAIL.
    • Address (string) – [REQUIRED] A generic String.
Return type:

dict
Returns:

Response Syntax

{}

Response Structure

  • (dict) – Response of DeleteSubscriber
describe_budget(**kwargs)

Get a single budget

See also: AWS API Documentation

Request Syntax

response = client.describe_budget(
    AccountId='string',
    BudgetName='string'
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
Return type:

dict
Returns:

Response Syntax

{
    'Budget': {
        'BudgetName': 'string',
        'BudgetLimit': {
            'Amount': 'string',
            'Unit': 'string'
        },
        'CostFilters': {
            'string': [
                'string',
            ]
        },
        'CostTypes': {
            'IncludeTax': True|False,
            'IncludeSubscription': True|False,
            'UseBlended': True|False
        },
        'TimeUnit': 'DAILY'|'MONTHLY'|'QUARTERLY'|'ANNUALLY',
        'TimePeriod': {
            'Start': datetime(2015, 1, 1),
            'End': datetime(2015, 1, 1)
        },
        'CalculatedSpend': {
            'ActualSpend': {
                'Amount': 'string',
                'Unit': 'string'
            },
            'ForecastedSpend': {
                'Amount': 'string',
                'Unit': 'string'
            }
        },
        'BudgetType': 'USAGE'|'COST'|'RI_UTILIZATION'
    }
}

Response Structure

  • (dict) – Response of DescribeBudget
    • Budget (dict) – AWS Budget model
      • BudgetName (string) – A string represents the budget name. No “:” and “” character is allowed.
      • BudgetLimit (dict) – A structure represent either a cost spend or usage spend. Contains an amount and a unit.
        • Amount (string) – A string to represent NumericValue.
        • Unit (string) – A string to represent budget spend unit. It should be not null and not empty.
      • CostFilters (dict) – A map represents the cost filters applied to the budget.
        • (string) – A generic String.
          • (list) –
            • (string) – A generic String.
      • CostTypes (dict) – This includes the options for getting the cost of a budget.
        • IncludeTax (boolean) – A generic boolean value.
        • IncludeSubscription (boolean) – A generic boolean value.
        • UseBlended (boolean) – A generic boolean value.
      • TimeUnit (string) – The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.
      • TimePeriod (dict) – A time period indicated the start date and end date of a budget.
        • Start (datetime) – A generic timestamp. In Java it is transformed to a Date object.
        • End (datetime) – A generic timestamp. In Java it is transformed to a Date object.
      • CalculatedSpend (dict) – A structure holds the actual and forecasted spend for a budget.
        • ActualSpend (dict) – A structure represent either a cost spend or usage spend. Contains an amount and a unit.
          • Amount (string) – A string to represent NumericValue.
          • Unit (string) – A string to represent budget spend unit. It should be not null and not empty.
        • ForecastedSpend (dict) – A structure represent either a cost spend or usage spend. Contains an amount and a unit.
          • Amount (string) – A string to represent NumericValue.
          • Unit (string) – A string to represent budget spend unit. It should be not null and not empty.
      • BudgetType (string) – The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.
describe_budgets(**kwargs)

Get all budgets for an account

See also: AWS API Documentation

Request Syntax

response = client.describe_budgets(
    AccountId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • MaxResults (integer) – An integer to represent how many entries should a pagianted response contains. Maxium is set to 100.
  • NextToken (string) – A generic String.
Return type:

dict
Returns:

Response Syntax

{
    'Budgets': [
        {
            'BudgetName': 'string',
            'BudgetLimit': {
                'Amount': 'string',
                'Unit': 'string'
            },
            'CostFilters': {
                'string': [
                    'string',
                ]
            },
            'CostTypes': {
                'IncludeTax': True|False,
                'IncludeSubscription': True|False,
                'UseBlended': True|False
            },
            'TimeUnit': 'DAILY'|'MONTHLY'|'QUARTERLY'|'ANNUALLY',
            'TimePeriod': {
                'Start': datetime(2015, 1, 1),
                'End': datetime(2015, 1, 1)
            },
            'CalculatedSpend': {
                'ActualSpend': {
                    'Amount': 'string',
                    'Unit': 'string'
                },
                'ForecastedSpend': {
                    'Amount': 'string',
                    'Unit': 'string'
                }
            },
            'BudgetType': 'USAGE'|'COST'|'RI_UTILIZATION'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) – Response of DescribeBudgets
    • Budgets (list) – A list of budgets
      • (dict) – AWS Budget model
        • BudgetName (string) – A string represents the budget name. No “:” and “” character is allowed.
        • BudgetLimit (dict) – A structure represent either a cost spend or usage spend. Contains an amount and a unit.
          • Amount (string) – A string to represent NumericValue.
          • Unit (string) – A string to represent budget spend unit. It should be not null and not empty.
        • CostFilters (dict) – A map represents the cost filters applied to the budget.
          • (string) – A generic String.
            • (list) –
              • (string) – A generic String.
        • CostTypes (dict) – This includes the options for getting the cost of a budget.
          • IncludeTax (boolean) – A generic boolean value.
          • IncludeSubscription (boolean) – A generic boolean value.
          • UseBlended (boolean) – A generic boolean value.
        • TimeUnit (string) – The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.
        • TimePeriod (dict) – A time period indicated the start date and end date of a budget.
          • Start (datetime) – A generic timestamp. In Java it is transformed to a Date object.
          • End (datetime) – A generic timestamp. In Java it is transformed to a Date object.
        • CalculatedSpend (dict) – A structure holds the actual and forecasted spend for a budget.
          • ActualSpend (dict) – A structure represent either a cost spend or usage spend. Contains an amount and a unit.
            • Amount (string) – A string to represent NumericValue.
            • Unit (string) – A string to represent budget spend unit. It should be not null and not empty.
          • ForecastedSpend (dict) – A structure represent either a cost spend or usage spend. Contains an amount and a unit.
            • Amount (string) – A string to represent NumericValue.
            • Unit (string) – A string to represent budget spend unit. It should be not null and not empty.
        • BudgetType (string) – The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.
    • NextToken (string) – A generic String.
describe_notifications_for_budget(**kwargs)

Get notifications of a budget

See also: AWS API Documentation

Request Syntax

response = client.describe_notifications_for_budget(
    AccountId='string',
    BudgetName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
  • MaxResults (integer) – An integer to represent how many entries should a pagianted response contains. Maxium is set to 100.
  • NextToken (string) – A generic String.
Return type:

dict
Returns:

Response Syntax

{
    'Notifications': [
        {
            'NotificationType': 'ACTUAL'|'FORECASTED',
            'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
            'Threshold': 123.0
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) – Response of GetNotificationsForBudget
    • Notifications (list) – A list of notifications.
      • (dict) – Notification model. Each budget may contain multiple notifications with different settings.
        • NotificationType (string) – The type of a notification. It should be ACTUAL or FORECASTED.
        • ComparisonOperator (string) – The comparison operator of a notification. Currently we support less than, equal to and greater than.
        • Threshold (float) – The threshold of the a notification. It should be a number between 0 and 100.
    • NextToken (string) – A generic String.
describe_subscribers_for_notification(**kwargs)

Get subscribers of a notification

See also: AWS API Documentation

Request Syntax

response = client.describe_subscribers_for_notification(
    AccountId='string',
    BudgetName='string',
    Notification={
        'NotificationType': 'ACTUAL'|'FORECASTED',
        'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
        'Threshold': 123.0
    },
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
  • Notification (dict) –

    [REQUIRED] Notification model. Each budget may contain multiple notifications with different settings.

    • NotificationType (string) – [REQUIRED] The type of a notification. It should be ACTUAL or FORECASTED.
    • ComparisonOperator (string) – [REQUIRED] The comparison operator of a notification. Currently we support less than, equal to and greater than.
    • Threshold (float) – [REQUIRED] The threshold of the a notification. It should be a number between 0 and 100.
  • MaxResults (integer) – An integer to represent how many entries should a pagianted response contains. Maxium is set to 100.
  • NextToken (string) – A generic String.
Return type:

dict
Returns:

Response Syntax

{
    'Subscribers': [
        {
            'SubscriptionType': 'SNS'|'EMAIL',
            'Address': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) – Response of DescribeSubscribersForNotification
    • Subscribers (list) – A list of subscribers.
      • (dict) – Subscriber model. Each notification may contain multiple subscribers with different addresses.
        • SubscriptionType (string) – The subscription type of the subscriber. It can be SMS or EMAIL.
        • Address (string) – A generic String.
    • NextToken (string) – A generic String.
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters:
  • ClientMethod (string) – The client method to presign for
  • Params (dict) – The parameters normally passed to ClientMethod.
  • ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
Returns:

The presigned url
get_paginator(operation_name)

Create a paginator for an operation.

Parameters:operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you’d normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises:OperationNotPageableError – Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type:L{botocore.paginate.Paginator}
Returns:A paginator object.
get_waiter(waiter_name)
update_budget(**kwargs)

Update the information of a budget already created

See also: AWS API Documentation

Request Syntax

response = client.update_budget(
    AccountId='string',
    NewBudget={
        'BudgetName': 'string',
        'BudgetLimit': {
            'Amount': 'string',
            'Unit': 'string'
        },
        'CostFilters': {
            'string': [
                'string',
            ]
        },
        'CostTypes': {
            'IncludeTax': True|False,
            'IncludeSubscription': True|False,
            'UseBlended': True|False
        },
        'TimeUnit': 'DAILY'|'MONTHLY'|'QUARTERLY'|'ANNUALLY',
        'TimePeriod': {
            'Start': datetime(2015, 1, 1),
            'End': datetime(2015, 1, 1)
        },
        'CalculatedSpend': {
            'ActualSpend': {
                'Amount': 'string',
                'Unit': 'string'
            },
            'ForecastedSpend': {
                'Amount': 'string',
                'Unit': 'string'
            }
        },
        'BudgetType': 'USAGE'|'COST'|'RI_UTILIZATION'
    }
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • NewBudget (dict) –

    [REQUIRED] AWS Budget model

    • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
    • BudgetLimit (dict) – [REQUIRED] A structure represent either a cost spend or usage spend. Contains an amount and a unit.
      • Amount (string) – [REQUIRED] A string to represent NumericValue.
      • Unit (string) – [REQUIRED] A string to represent budget spend unit. It should be not null and not empty.
    • CostFilters (dict) – A map represents the cost filters applied to the budget.
      • (string) – A generic String.
        • (list) –
          • (string) – A generic String.
    • CostTypes (dict) – [REQUIRED] This includes the options for getting the cost of a budget.
      • IncludeTax (boolean) – [REQUIRED] A generic boolean value.
      • IncludeSubscription (boolean) – [REQUIRED] A generic boolean value.
      • UseBlended (boolean) – [REQUIRED] A generic boolean value.
    • TimeUnit (string) – [REQUIRED] The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.
    • TimePeriod (dict) – [REQUIRED] A time period indicated the start date and end date of a budget.
      • Start (datetime) – [REQUIRED] A generic timestamp. In Java it is transformed to a Date object.
      • End (datetime) – [REQUIRED] A generic timestamp. In Java it is transformed to a Date object.
    • CalculatedSpend (dict) – A structure holds the actual and forecasted spend for a budget.
      • ActualSpend (dict) – [REQUIRED] A structure represent either a cost spend or usage spend. Contains an amount and a unit.
        • Amount (string) – [REQUIRED] A string to represent NumericValue.
        • Unit (string) – [REQUIRED] A string to represent budget spend unit. It should be not null and not empty.
      • ForecastedSpend (dict) – A structure represent either a cost spend or usage spend. Contains an amount and a unit.
        • Amount (string) – [REQUIRED] A string to represent NumericValue.
        • Unit (string) – [REQUIRED] A string to represent budget spend unit. It should be not null and not empty.
    • BudgetType (string) – [REQUIRED] The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.
Return type:

dict
Returns:

Response Syntax

{}

Response Structure

  • (dict) – Response of UpdateBudget
update_notification(**kwargs)

Update the information about a notification already created

See also: AWS API Documentation

Request Syntax

response = client.update_notification(
    AccountId='string',
    BudgetName='string',
    OldNotification={
        'NotificationType': 'ACTUAL'|'FORECASTED',
        'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
        'Threshold': 123.0
    },
    NewNotification={
        'NotificationType': 'ACTUAL'|'FORECASTED',
        'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
        'Threshold': 123.0
    }
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
  • OldNotification (dict) –

    [REQUIRED] Notification model. Each budget may contain multiple notifications with different settings.

    • NotificationType (string) – [REQUIRED] The type of a notification. It should be ACTUAL or FORECASTED.
    • ComparisonOperator (string) – [REQUIRED] The comparison operator of a notification. Currently we support less than, equal to and greater than.
    • Threshold (float) – [REQUIRED] The threshold of the a notification. It should be a number between 0 and 100.
  • NewNotification (dict) –

    [REQUIRED] Notification model. Each budget may contain multiple notifications with different settings.

    • NotificationType (string) – [REQUIRED] The type of a notification. It should be ACTUAL or FORECASTED.
    • ComparisonOperator (string) – [REQUIRED] The comparison operator of a notification. Currently we support less than, equal to and greater than.
    • Threshold (float) – [REQUIRED] The threshold of the a notification. It should be a number between 0 and 100.
Return type:

dict
Returns:

Response Syntax

{}

Response Structure

  • (dict) – Response of UpdateNotification
update_subscriber(**kwargs)

Update a subscriber

See also: AWS API Documentation

Request Syntax

response = client.update_subscriber(
    AccountId='string',
    BudgetName='string',
    Notification={
        'NotificationType': 'ACTUAL'|'FORECASTED',
        'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
        'Threshold': 123.0
    },
    OldSubscriber={
        'SubscriptionType': 'SNS'|'EMAIL',
        'Address': 'string'
    },
    NewSubscriber={
        'SubscriptionType': 'SNS'|'EMAIL',
        'Address': 'string'
    }
)
Parameters:
  • AccountId (string) – [REQUIRED] Account Id of the customer. It should be a 12 digit number.
  • BudgetName (string) – [REQUIRED] A string represents the budget name. No “:” and “” character is allowed.
  • Notification (dict) –

    [REQUIRED] Notification model. Each budget may contain multiple notifications with different settings.

    • NotificationType (string) – [REQUIRED] The type of a notification. It should be ACTUAL or FORECASTED.
    • ComparisonOperator (string) – [REQUIRED] The comparison operator of a notification. Currently we support less than, equal to and greater than.
    • Threshold (float) – [REQUIRED] The threshold of the a notification. It should be a number between 0 and 100.
  • OldSubscriber (dict) –

    [REQUIRED] Subscriber model. Each notification may contain multiple subscribers with different addresses.

    • SubscriptionType (string) – [REQUIRED] The subscription type of the subscriber. It can be SMS or EMAIL.
    • Address (string) – [REQUIRED] A generic String.
  • NewSubscriber (dict) –

    [REQUIRED] Subscriber model. Each notification may contain multiple subscribers with different addresses.

    • SubscriptionType (string) – [REQUIRED] The subscription type of the subscriber. It can be SMS or EMAIL.
    • Address (string) – [REQUIRED] A generic String.
Return type:

dict
Returns:

Response Syntax

{}

Response Structure

  • (dict) – Response of UpdateSubscriber

Paginators

The available paginators are:

Batch
CloudDirectory
© Copyright 2019, Mitch Garnaat. Created using Sphinx.