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

update-billing-group

Description

Updates information about the billing group.

Requires permission to access the UpdateBillingGroup action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-billing-group
--billing-group-name <value>
--billing-group-properties <value>
[--expected-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--billing-group-name (string)

The name of the billing group.

--billing-group-properties (structure)

The properties of the billing group.

billingGroupDescription -> (string)

The description of the billing group.

Shorthand Syntax:

billingGroupDescription=string

JSON Syntax:

{
  "billingGroupDescription": "string"
}

--expected-version (long)

The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException .

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

See 'aws help' for descriptions of global parameters.

Examples

To update information about a billing group

The following update-billing-group example updates the description for the specified billing group.

aws iot update-billing-group \
    --billing-group-name GroupOne \
    --billing-group-properties "billingGroupDescription=\"Primary bulb billing group\""

Output:

{
    "version": 2
}

For more information, see Billing Groups in the AWS IoT Developers Guide.

Output

version -> (long)

The latest version of the billing group.