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

update-billing-group¶

Description¶

This updates an existing billing group.

Synopsis¶

  update-billing-group
--arn <value>
[--name <value>]
[--status <value>]
[--computation-preference <value>]
[--description <value>]
[--account-grouping <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¶

--arn (string)

The Amazon Resource Name (ARN) of the billing group being updated.

--name (string)

The name of the billing group. The names must be unique to each billing group.

--status (string)

The status of the billing group. Only one of the valid values can be used.

Possible values:

ACTIVE

PRIMARY_ACCOUNT_MISSING

--computation-preference (structure)

The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

PricingPlanArn -> (string)

The Amazon Resource Name (ARN) of the pricing plan that's used to compute the Amazon Web Services charges for a billing group.

Shorthand Syntax:

PricingPlanArn=string

JSON Syntax:

{
  "PricingPlanArn": "string"
}

--description (string)

A description of the billing group.

--account-grouping (structure)

Specifies if the billing group has automatic account association (AutoAssociate ) enabled.

AutoAssociate -> (boolean)

Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.

Shorthand Syntax:

AutoAssociate=boolean

JSON Syntax:

{
  "AutoAssociate": true|false
}

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

Arn -> (string)

The Amazon Resource Name (ARN) of the billing group that was updated.

Name -> (string)

The name of the billing group. The names must be unique to each billing group.

Description -> (string)

A description of the billing group.

PrimaryAccountId -> (string)

The account ID that serves as the main account in a billing group.

PricingPlanArn -> (string)

The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web Services charges for the billing group.

Size -> (long)

The number of accounts in the particular billing group.

LastModifiedTime -> (long)

The most recent time when the billing group was modified.

Status -> (string)

The status of the billing group. Only one of the valid values can be used.

StatusReason -> (string)

The reason why the billing group is in its current status.

AccountGrouping -> (structure)