github.com/aavshr/aws-sdk-go@v1.41.3/service/budgets/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package budgets provides the client and types for making API
     4  // requests to AWS Budgets.
     5  //
     6  // The AWS Budgets API enables you to use AWS Budgets to plan your service usage,
     7  // service costs, and instance reservations. The API reference provides descriptions,
     8  // syntax, and usage examples for each of the actions and data types for AWS
     9  // Budgets.
    10  //
    11  // Budgets provide you with a way to see the following information:
    12  //
    13  //    * How close your plan is to your budgeted amount or to the free tier limits
    14  //
    15  //    * Your usage-to-date, including how much you've used of your Reserved
    16  //    Instances (RIs)
    17  //
    18  //    * Your current estimated charges from AWS, and how much your predicted
    19  //    usage will accrue in charges by the end of the month
    20  //
    21  //    * How much of your budget has been used
    22  //
    23  // AWS updates your budget status several times a day. Budgets track your unblended
    24  // costs, subscriptions, refunds, and RIs. You can create the following types
    25  // of budgets:
    26  //
    27  //    * Cost budgets - Plan how much you want to spend on a service.
    28  //
    29  //    * Usage budgets - Plan how much you want to use one or more services.
    30  //
    31  //    * RI utilization budgets - Define a utilization threshold, and receive
    32  //    alerts when your RI usage falls below that threshold. This lets you see
    33  //    if your RIs are unused or under-utilized.
    34  //
    35  //    * RI coverage budgets - Define a coverage threshold, and receive alerts
    36  //    when the number of your instance hours that are covered by RIs fall below
    37  //    that threshold. This lets you see how much of your instance usage is covered
    38  //    by a reservation.
    39  //
    40  // Service Endpoint
    41  //
    42  // The AWS Budgets API provides the following endpoint:
    43  //
    44  //    * https://budgets.amazonaws.com
    45  //
    46  // For information about costs that are associated with the AWS Budgets API,
    47  // see AWS Cost Management Pricing (https://aws.amazon.com/aws-cost-management/pricing/).
    48  //
    49  // See budgets package documentation for more information.
    50  // https://docs.aws.amazon.com/sdk-for-go/api/service/budgets/
    51  //
    52  // Using the Client
    53  //
    54  // To contact AWS Budgets with the SDK use the New function to create
    55  // a new service client. With that client you can make API requests to the service.
    56  // These clients are safe to use concurrently.
    57  //
    58  // See the SDK's documentation for more information on how to use the SDK.
    59  // https://docs.aws.amazon.com/sdk-for-go/api/
    60  //
    61  // See aws.Config documentation for more information on configuring SDK clients.
    62  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    63  //
    64  // See the AWS Budgets client Budgets for more
    65  // information on creating client for this service.
    66  // https://docs.aws.amazon.com/sdk-for-go/api/service/budgets/#New
    67  package budgets