[ aws . iot ]

create-billing-group

Description

Creates a billing group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-billing-group
--billing-group-name <value>
[--billing-group-properties <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--billing-group-name (string)

The name you wish to give to 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"
}

--tags (list)

Metadata which can be used to manage the billing group.

(structure)

A set of key/value pairs that are used to manage the resource.

Key -> (string)

The tag’s key.

Value -> (string)

The tag’s value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "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.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a billing group

The following create-billing-group example creates a simple billing group named GroupOne.

aws iot create-billing-group \
    --billing-group-name GroupOne

Output:

{
    "billingGroupName": "GroupOne",
    "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne",
    "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562"
}

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

Output

billingGroupName -> (string)

The name you gave to the billing group.

billingGroupArn -> (string)

The ARN of the billing group.

billingGroupId -> (string)

The ID of the billing group.