AWS CLI Command Reference

[ aws . billing ]

get-billing-preferences

Description

Retrieves billing preferences for the specified feature. Each feature controls a distinct billing capability: which accounts can share Reserved Instances or credits, whether billing alerts are enabled, the historical record of sharing changes, and per-credit options.

See also: AWS API Documentation

Synopsis

  get-billing-preferences
[--next-token <value>]
[--max-results <value>]
--features <value>
[--filters <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]
[--cli-error-format <value>]

Options

--next-token (string)

Pagination token from a previous response. Pass the value returned in nextToken to retrieve the next page of results.

Constraints:

  • min: 1
  • max: 4095
  • pattern: [-a-zA-Z0-9+=/_]+

--max-results (integer)

The maximum number of records to return per page. Range: 1 to 50. Default: 50.

Constraints:

  • min: 1
  • max: 50

--features (list) [required]

The feature to retrieve. Specify exactly one value. Valid values: BILLING_ALERTS , RI_SHARING , RI_SHARING_HISTORY , CREDIT_SHARING , CREDIT_SHARING_HISTORY , CREDIT_LEVEL_SHARING , CREDIT_PREFERENCE_OPTIONS .

Constraints:

  • min: 1
  • max: 1

(string)

Possible values:

  • RI_SHARING
  • RI_SHARING_HISTORY
  • CREDIT_SHARING
  • CREDIT_SHARING_HISTORY
  • CREDIT_LEVEL_SHARING
  • BILLING_ALERTS
  • CREDIT_PREFERENCE_OPTIONS

Syntax:

"string" "string" ...

--filters (list)

Filters to narrow results. Specify exactly one filter when supplied. The supported filter name is PREFERENCE_KEY , which accepts 1 to 10 values to match preference keys.

Constraints:

  • min: 1
  • max: 1

(structure)

A filter that narrows the set of preferences returned by GetBillingPreferences .

name -> (string)

The filter name. Currently the only supported value is PREFERENCE_KEY .

Possible values:

  • PREFERENCE_KEY

value -> (list)

The filter values to match. For PREFERENCE_KEY , supply 1 to 10 preference key values to match.

Constraints:

  • min: 1
  • max: 10

(string)

Constraints:

  • min: 1
  • max: 100
  • pattern: [a-zA-Z0-9-/]+

Shorthand Syntax:

name=string,value=string,string ...

JSON Syntax:

[
  {
    "name": "PREFERENCE_KEY",
    "value": ["string", ...]
  }
  ...
]

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

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
  • yaml
  • yaml-stream
  • off

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

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

  • base64
  • raw-in-base64-out

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

billingPreferences -> (list)

The list of preference entries matching the request.

(structure)

A single billing preference entry returned by GetBillingPreferences .

feature -> (string) [required]

The feature this preference belongs to.

Possible values:

  • RI_SHARING
  • RI_SHARING_HISTORY
  • CREDIT_SHARING
  • CREDIT_SHARING_HISTORY
  • CREDIT_LEVEL_SHARING
  • BILLING_ALERTS
  • CREDIT_PREFERENCE_OPTIONS

key -> (string) [required]

The preference key. Format depends on the feature.

Constraints:

  • min: 1
  • max: 2148
  • pattern: [a-zA-Z0-9-\/\*: ]+

value -> (string) [required]

The preference value. Valid values: ENABLED or DISABLED .

Possible values:

  • ENABLED
  • DISABLED

accountName -> (string)

The display name of the account. Populated together with accountId ; null otherwise.

Constraints:

  • min: 1
  • max: 50

accountId -> (string)

The associated Amazon Web Services account ID. Populated for account-list keys; null otherwise.

Constraints:

  • pattern: [0-9]{12}

billingPeriod -> (structure)

The billing period associated with the preference change. Populated only for the history features RI_SHARING_HISTORY and CREDIT_SHARING_HISTORY .

year -> (integer) [required]

The four-digit year of the billing period.

Constraints:

  • min: 2005
  • max: 2120

month -> (integer) [required]

The month of the billing period as an integer between 1 and 12.

Constraints:

  • min: 1
  • max: 12

nextToken -> (string)

Pagination token. Present when more pages are available; null when there are no more results.

Constraints:

  • min: 1
  • max: 4095
  • pattern: [-a-zA-Z0-9+=/_]+
© Copyright 2026, Amazon Web Services. Created using Sphinx.