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 ]

create-budget

Description

Creates a budget to set spending thresholds for your rendering activity.

See also: AWS API Documentation

Synopsis

  create-budget
[--client-token <value>]
--farm-id <value>
--usage-tracking-resource <value>
--display-name <value>
[--description <value>]
--approximate-dollar-limit <value>
--actions <value>
--schedule <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

--client-token (string)

The unique token which the server uses to recognize retries of the same request.

--farm-id (string)

The farm ID to include in this budget.

--usage-tracking-resource (tagged union structure)

The queue ID provided to this budget to track usage.

Note

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

queueId -> (string)

The queue ID.

Shorthand Syntax:

queueId=string

JSON Syntax:

{
  "queueId": "string"
}

--display-name (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.

--approximate-dollar-limit (float)

The dollar limit based on consumed usage.

--actions (list)

The budget actions to specify what happens when the budget runs out.

(structure)

The budget action to add.

type -> (string)

The type of budget action to add.

thresholdPercentage -> (float)

The percentage threshold for the budget action to add.

description -> (string)

A description for the budget action to add.

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.

Shorthand Syntax:

type=string,thresholdPercentage=float,description=string ...

JSON Syntax:

[
  {
    "type": "STOP_SCHEDULING_AND_COMPLETE_TASKS"|"STOP_SCHEDULING_AND_CANCEL_TASKS",
    "thresholdPercentage": float,
    "description": "string"
  }
  ...
]

--schedule (tagged union structure)

The schedule to associate with this budget.

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.

Shorthand Syntax:

fixed={startTime=timestamp,endTime=timestamp}

JSON Syntax:

{
  "fixed": {
    "startTime": timestamp,
    "endTime": timestamp
  }
}

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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

budgetId -> (string)

The budget ID.