AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . deadline ]

get-budget

Description

Get a budget.

See also: AWS API Documentation

Synopsis

  get-budget
--budget-id <value>
--farm-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--budget-id (string)

The budget ID.

--farm-id (string)

The farm ID of the farm connected to the budget.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

actions -> (list)

The budget actions for the budget.

(structure)

The details of a budget action.

description -> (string)

The budget action description.

thresholdPercentage -> (float)

The percentage threshold for the budget.

type -> (string)

The action taken on the budget once scheduling stops.

approximateDollarLimit -> (float)

The consumed usage limit for the budget.

budgetId -> (string)

The budget ID.

createdAt -> (timestamp)

The date and time the resource was created.

createdBy -> (string)

The user or system that created this resource.

description -> (string)

The description of the budget.

displayName -> (string)

The display name of the budget.

queueStoppedAt -> (timestamp)

The date and time the queue stopped.

schedule -> (tagged union structure)

The budget schedule.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: fixed.

fixed -> (structure)

The fixed start and end time of the budget's schedule.

endTime -> (timestamp)

When the budget ends.

startTime -> (timestamp)

When the budget starts.

status -> (string)

The status of the budget.

  • ACTIVE –Get a budget being evaluated.
  • INACTIVE –Get an inactive budget. This can include expired, canceled, or deleted statuses.

updatedAt -> (timestamp)

The date and time the resource was updated.

updatedBy -> (string)

The user or system that updated this resource.

usageTrackingResource -> (tagged union structure)

The resource that the budget is tracking usage for.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: queueId.

queueId -> (string)

The queue ID.

usages -> (structure)

The usages of the budget.

approximateDollarUsage -> (float)

The amount of the budget consumed.