get-budget
--farm-id <value>
--budget-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--farm-id
(string)
The farm ID of the farm connected to the budget.
--budget-id
(string)
The budget ID.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--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.
--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.
--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.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
budgetId -> (string)
The budget ID.
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.
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.
displayName -> (string)
The display name of the budget.
Warning
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
description -> (string)
The description of the budget.
Warning
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
approximateDollarLimit -> (float)
The consumed usage limit for the budget.
usages -> (structure)
The usages of the budget.
approximateDollarUsage -> (float)
The amount of the budget consumed.
actions -> (list)
The budget actions for the budget.
(structure)
The details of a budget action.
type -> (string)
The action taken on the budget once scheduling stops.thresholdPercentage -> (float)
The percentage threshold for the budget.description -> (string)
The budget action description.
Warning
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
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.
startTime -> (timestamp)
When the budget starts.endTime -> (timestamp)
When the budget ends.
createdBy -> (string)
The user or system that created this resource.
createdAt -> (timestamp)
The date and time the resource was created.
updatedBy -> (string)
The user or system that updated this resource.
updatedAt -> (timestamp)
The date and time the resource was updated.
queueStoppedAt -> (timestamp)
The date and time the queue stopped.