AWSSDK.Budgets.jl

AWSSDK.Budgets

All public APIs for AWS Budgets

This document is generated from apis/budgets-2016-10-20.normal.json. See JuliaCloud/AWSCore.jl.

using AWSSDK.Budgets.create_budget
create_budget([::AWSConfig], arguments::Dict)
create_budget([::AWSConfig]; AccountId=, Budget=, <keyword arguments>)

using AWSCore.Services.budgets
budgets([::AWSConfig], "CreateBudget", arguments::Dict)
budgets([::AWSConfig], "CreateBudget", AccountId=, Budget=, <keyword arguments>)

CreateBudget Operation

Create a new budget

Arguments

AccountId = ::StringRequired

Budget = [ ... ]Required

 Budget = [
        "BudgetName" => <required> ::String,
        "BudgetLimit" => <required> [
            "Amount" => <required> ::String,
            "Unit" => <required> ::String
        ],
        "CostFilters" =>  ::Dict{String,String},
        "CostTypes" => <required> [
            "IncludeTax" => <required> ::Bool,
            "IncludeSubscription" => <required> ::Bool,
            "UseBlended" => <required> ::Bool
        ],
        "TimeUnit" => <required> "DAILY", "MONTHLY", "QUARTERLY" or "ANNUALLY",
        "TimePeriod" => <required> [
            "Start" => <required> timestamp,
            "End" => <required> timestamp
        ],
        "CalculatedSpend" =>  [
            "ActualSpend" => <required> [
                "Amount" => <required> ::String,
                "Unit" => <required> ::String
            ],
            "ForecastedSpend" =>  [
                "Amount" => <required> ::String,
                "Unit" => <required> ::String
            ]
        ],
        "BudgetType" => <required> "USAGE", "COST" or "RI_UTILIZATION"
    ]

NotificationsWithSubscribers = [[ ... ], ...]

 NotificationsWithSubscribers = [[
        "Notification" => <required> [
            "NotificationType" => <required> "ACTUAL" or "FORECASTED",
            "ComparisonOperator" => <required> "GREATER_THAN", "LESS_THAN" or "EQUAL_TO",
            "Threshold" => <required> double,
            "ThresholdType" =>  "PERCENTAGE" or "ABSOLUTE_VALUE"
        ],
        "Subscribers" => <required> [[
            "SubscriptionType" => <required> "SNS" or "EMAIL",
            "Address" => <required> ::String
        ], ...]
    ], ...]

Returns

CreateBudgetResponse

Exceptions

InvalidParameterException, InternalErrorException, CreationLimitExceededException or DuplicateRecordException.

See also: AWS API Documentation

using AWSSDK.Budgets.create_notification
create_notification([::AWSConfig], arguments::Dict)
create_notification([::AWSConfig]; AccountId=, BudgetName=, Notification=, Subscribers=)

using AWSCore.Services.budgets
budgets([::AWSConfig], "CreateNotification", arguments::Dict)
budgets([::AWSConfig], "CreateNotification", AccountId=, BudgetName=, Notification=, Subscribers=)

CreateNotification Operation

Create a new Notification with subscribers for a budget

Arguments

AccountId = ::StringRequired

BudgetName = ::StringRequired

Notification = [ ... ]Required

 Notification = [
        "NotificationType" => <required> "ACTUAL" or "FORECASTED",
        "ComparisonOperator" => <required> "GREATER_THAN", "LESS_THAN" or "EQUAL_TO",
        "Threshold" => <required> double,
        "ThresholdType" =>  "PERCENTAGE" or "ABSOLUTE_VALUE"
    ]

Subscribers = [[ ... ], ...]Required

 Subscribers = [[
        "SubscriptionType" => <required> "SNS" or "EMAIL",
        "Address" => <required> ::String
    ], ...]

Returns

CreateNotificationResponse

Exceptions

InternalErrorException, InvalidParameterException, NotFoundException, CreationLimitExceededException or DuplicateRecordException.

See also: AWS API Documentation

using AWSSDK.Budgets.create_subscriber
create_subscriber([::AWSConfig], arguments::Dict)
create_subscriber([::AWSConfig]; AccountId=, BudgetName=, Notification=, Subscriber=)

using AWSCore.Services.budgets
budgets([::AWSConfig], "CreateSubscriber", arguments::Dict)
budgets([::AWSConfig], "CreateSubscriber", AccountId=, BudgetName=, Notification=, Subscriber=)

CreateSubscriber Operation

Create a new Subscriber for a notification

Arguments

AccountId = ::StringRequired

BudgetName = ::StringRequired

Notification = [ ... ]Required

 Notification = [
        "NotificationType" => <required> "ACTUAL" or "FORECASTED",
        "ComparisonOperator" => <required> "GREATER_THAN", "LESS_THAN" or "EQUAL_TO",
        "Threshold" => <required> double,
        "ThresholdType" =>  "PERCENTAGE" or "ABSOLUTE_VALUE"
    ]

Subscriber = [ ... ]Required

 Subscriber = [
        "SubscriptionType" => <required> "SNS" or "EMAIL",
        "Address" => <required> ::String
    ]

Returns

CreateSubscriberResponse

Exceptions

InternalErrorException, InvalidParameterException, CreationLimitExceededException, DuplicateRecordException or NotFoundException.

See also: AWS API Documentation

using AWSSDK.Budgets.delete_budget
delete_budget([::AWSConfig], arguments::Dict)
delete_budget([::AWSConfig]; AccountId=, BudgetName=)

using AWSCore.Services.budgets
budgets([::AWSConfig], "DeleteBudget", arguments::Dict)
budgets([::AWSConfig], "DeleteBudget", AccountId=, BudgetName=)

DeleteBudget Operation

Delete a budget and related notifications

Arguments

AccountId = ::StringRequired

BudgetName = ::StringRequired

Returns

DeleteBudgetResponse

Exceptions

InternalErrorException, InvalidParameterException or NotFoundException.

See also: AWS API Documentation

using AWSSDK.Budgets.delete_notification
delete_notification([::AWSConfig], arguments::Dict)
delete_notification([::AWSConfig]; AccountId=, BudgetName=, Notification=)

using AWSCore.Services.budgets
budgets([::AWSConfig], "DeleteNotification", arguments::Dict)
budgets([::AWSConfig], "DeleteNotification", AccountId=, BudgetName=, Notification=)

DeleteNotification Operation

Delete a notification and related subscribers

Arguments

AccountId = ::StringRequired

BudgetName = ::StringRequired

Notification = [ ... ]Required

 Notification = [
        "NotificationType" => <required> "ACTUAL" or "FORECASTED",
        "ComparisonOperator" => <required> "GREATER_THAN", "LESS_THAN" or "EQUAL_TO",
        "Threshold" => <required> double,
        "ThresholdType" =>  "PERCENTAGE" or "ABSOLUTE_VALUE"
    ]

Returns

DeleteNotificationResponse

Exceptions

InvalidParameterException, InternalErrorException or NotFoundException.

See also: AWS API Documentation

using AWSSDK.Budgets.delete_subscriber
delete_subscriber([::AWSConfig], arguments::Dict)
delete_subscriber([::AWSConfig]; AccountId=, BudgetName=, Notification=, Subscriber=)

using AWSCore.Services.budgets
budgets([::AWSConfig], "DeleteSubscriber", arguments::Dict)
budgets([::AWSConfig], "DeleteSubscriber", AccountId=, BudgetName=, Notification=, Subscriber=)

DeleteSubscriber Operation

Delete a Subscriber for a notification

Arguments

AccountId = ::StringRequired

BudgetName = ::StringRequired

Notification = [ ... ]Required

 Notification = [
        "NotificationType" => <required> "ACTUAL" or "FORECASTED",
        "ComparisonOperator" => <required> "GREATER_THAN", "LESS_THAN" or "EQUAL_TO",
        "Threshold" => <required> double,
        "ThresholdType" =>  "PERCENTAGE" or "ABSOLUTE_VALUE"
    ]

Subscriber = [ ... ]Required

 Subscriber = [
        "SubscriptionType" => <required> "SNS" or "EMAIL",
        "Address" => <required> ::String
    ]

Returns

DeleteSubscriberResponse

Exceptions

InternalErrorException, InvalidParameterException or NotFoundException.

See also: AWS API Documentation

using AWSSDK.Budgets.describe_budget
describe_budget([::AWSConfig], arguments::Dict)
describe_budget([::AWSConfig]; AccountId=, BudgetName=)

using AWSCore.Services.budgets
budgets([::AWSConfig], "DescribeBudget", arguments::Dict)
budgets([::AWSConfig], "DescribeBudget", AccountId=, BudgetName=)

DescribeBudget Operation

Get a single budget

Arguments

AccountId = ::StringRequired

BudgetName = ::StringRequired

Returns

DescribeBudgetResponse

Exceptions

InternalErrorException, InvalidParameterException or NotFoundException.

See also: AWS API Documentation

using AWSSDK.Budgets.describe_budgets
describe_budgets([::AWSConfig], arguments::Dict)
describe_budgets([::AWSConfig]; AccountId=, <keyword arguments>)

using AWSCore.Services.budgets
budgets([::AWSConfig], "DescribeBudgets", arguments::Dict)
budgets([::AWSConfig], "DescribeBudgets", AccountId=, <keyword arguments>)

DescribeBudgets Operation

Get all budgets for an account

Arguments

AccountId = ::StringRequired

MaxResults = ::Int

NextToken = ::String

Returns

DescribeBudgetsResponse

Exceptions

InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException or ExpiredNextTokenException.

See also: AWS API Documentation

using AWSSDK.Budgets.describe_notifications_for_budget
describe_notifications_for_budget([::AWSConfig], arguments::Dict)
describe_notifications_for_budget([::AWSConfig]; AccountId=, BudgetName=, <keyword arguments>)

using AWSCore.Services.budgets
budgets([::AWSConfig], "DescribeNotificationsForBudget", arguments::Dict)
budgets([::AWSConfig], "DescribeNotificationsForBudget", AccountId=, BudgetName=, <keyword arguments>)

DescribeNotificationsForBudget Operation

Get notifications of a budget

Arguments

AccountId = ::StringRequired

BudgetName = ::StringRequired

MaxResults = ::Int

NextToken = ::String

Returns

DescribeNotificationsForBudgetResponse

Exceptions

InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException or ExpiredNextTokenException.

See also: AWS API Documentation

using AWSSDK.Budgets.describe_subscribers_for_notification
describe_subscribers_for_notification([::AWSConfig], arguments::Dict)
describe_subscribers_for_notification([::AWSConfig]; AccountId=, BudgetName=, Notification=, <keyword arguments>)

using AWSCore.Services.budgets
budgets([::AWSConfig], "DescribeSubscribersForNotification", arguments::Dict)
budgets([::AWSConfig], "DescribeSubscribersForNotification", AccountId=, BudgetName=, Notification=, <keyword arguments>)

DescribeSubscribersForNotification Operation

Get subscribers of a notification

Arguments

AccountId = ::StringRequired

BudgetName = ::StringRequired

Notification = [ ... ]Required

 Notification = [
        "NotificationType" => <required> "ACTUAL" or "FORECASTED",
        "ComparisonOperator" => <required> "GREATER_THAN", "LESS_THAN" or "EQUAL_TO",
        "Threshold" => <required> double,
        "ThresholdType" =>  "PERCENTAGE" or "ABSOLUTE_VALUE"
    ]

MaxResults = ::Int

NextToken = ::String

Returns

DescribeSubscribersForNotificationResponse

Exceptions

InternalErrorException, NotFoundException, InvalidParameterException, InvalidNextTokenException or ExpiredNextTokenException.

See also: AWS API Documentation

using AWSSDK.Budgets.update_budget
update_budget([::AWSConfig], arguments::Dict)
update_budget([::AWSConfig]; AccountId=, NewBudget=)

using AWSCore.Services.budgets
budgets([::AWSConfig], "UpdateBudget", arguments::Dict)
budgets([::AWSConfig], "UpdateBudget", AccountId=, NewBudget=)

UpdateBudget Operation

Update the information of a budget already created

Arguments

AccountId = ::StringRequired

NewBudget = [ ... ]Required

 NewBudget = [
        "BudgetName" => <required> ::String,
        "BudgetLimit" => <required> [
            "Amount" => <required> ::String,
            "Unit" => <required> ::String
        ],
        "CostFilters" =>  ::Dict{String,String},
        "CostTypes" => <required> [
            "IncludeTax" => <required> ::Bool,
            "IncludeSubscription" => <required> ::Bool,
            "UseBlended" => <required> ::Bool
        ],
        "TimeUnit" => <required> "DAILY", "MONTHLY", "QUARTERLY" or "ANNUALLY",
        "TimePeriod" => <required> [
            "Start" => <required> timestamp,
            "End" => <required> timestamp
        ],
        "CalculatedSpend" =>  [
            "ActualSpend" => <required> [
                "Amount" => <required> ::String,
                "Unit" => <required> ::String
            ],
            "ForecastedSpend" =>  [
                "Amount" => <required> ::String,
                "Unit" => <required> ::String
            ]
        ],
        "BudgetType" => <required> "USAGE", "COST" or "RI_UTILIZATION"
    ]

Returns

UpdateBudgetResponse

Exceptions

InternalErrorException, InvalidParameterException or NotFoundException.

See also: AWS API Documentation

using AWSSDK.Budgets.update_notification
update_notification([::AWSConfig], arguments::Dict)
update_notification([::AWSConfig]; AccountId=, BudgetName=, OldNotification=, NewNotification=)

using AWSCore.Services.budgets
budgets([::AWSConfig], "UpdateNotification", arguments::Dict)
budgets([::AWSConfig], "UpdateNotification", AccountId=, BudgetName=, OldNotification=, NewNotification=)

UpdateNotification Operation

Update the information about a notification already created

Arguments

AccountId = ::StringRequired

BudgetName = ::StringRequired

OldNotification = [ ... ]Required

 OldNotification = [
        "NotificationType" => <required> "ACTUAL" or "FORECASTED",
        "ComparisonOperator" => <required> "GREATER_THAN", "LESS_THAN" or "EQUAL_TO",
        "Threshold" => <required> double,
        "ThresholdType" =>  "PERCENTAGE" or "ABSOLUTE_VALUE"
    ]

NewNotification = [ ... ]Required

 NewNotification = [
        "NotificationType" => <required> "ACTUAL" or "FORECASTED",
        "ComparisonOperator" => <required> "GREATER_THAN", "LESS_THAN" or "EQUAL_TO",
        "Threshold" => <required> double,
        "ThresholdType" =>  "PERCENTAGE" or "ABSOLUTE_VALUE"
    ]

Returns

UpdateNotificationResponse

Exceptions

InternalErrorException, InvalidParameterException, NotFoundException or DuplicateRecordException.

See also: AWS API Documentation

using AWSSDK.Budgets.update_subscriber
update_subscriber([::AWSConfig], arguments::Dict)
update_subscriber([::AWSConfig]; AccountId=, BudgetName=, Notification=, OldSubscriber=, NewSubscriber=)

using AWSCore.Services.budgets
budgets([::AWSConfig], "UpdateSubscriber", arguments::Dict)
budgets([::AWSConfig], "UpdateSubscriber", AccountId=, BudgetName=, Notification=, OldSubscriber=, NewSubscriber=)

UpdateSubscriber Operation

Update a subscriber

Arguments

AccountId = ::StringRequired

BudgetName = ::StringRequired

Notification = [ ... ]Required

 Notification = [
        "NotificationType" => <required> "ACTUAL" or "FORECASTED",
        "ComparisonOperator" => <required> "GREATER_THAN", "LESS_THAN" or "EQUAL_TO",
        "Threshold" => <required> double,
        "ThresholdType" =>  "PERCENTAGE" or "ABSOLUTE_VALUE"
    ]

OldSubscriber = [ ... ]Required

 OldSubscriber = [
        "SubscriptionType" => <required> "SNS" or "EMAIL",
        "Address" => <required> ::String
    ]

NewSubscriber = [ ... ]Required

 NewSubscriber = [
        "SubscriptionType" => <required> "SNS" or "EMAIL",
        "Address" => <required> ::String
    ]

Returns

UpdateSubscriberResponse

Exceptions

InternalErrorException, InvalidParameterException, NotFoundException or DuplicateRecordException.

See also: AWS API Documentation