[ aws . iot ]

add-thing-to-billing-group

Description

Adds a thing to a billing group.

Requires permission to access the AddThingToBillingGroup action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  add-thing-to-billing-group
[--billing-group-name <value>]
[--billing-group-arn <value>]
[--thing-name <value>]
[--thing-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--billing-group-name (string)

The name of the billing group.

Note

This call is asynchronous. It might take several seconds for the detachment to propagate.

--billing-group-arn (string)

The ARN of the billing group.

--thing-name (string)

The name of the thing to be added to the billing group.

--thing-arn (string)

The ARN of the thing to be added to the billing group.

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

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Example 1: To add a thing by name to a billing group

The following add-thing-to-billing-group example adds the thing named MyLightBulb to the billing group named GroupOne.

aws iot add-thing-to-billing-group \
    --billing-group-name GroupOne \
    --thing-name MyLightBulb

This command produces no output.

Example 2: To add a thing by ARN to a billing group

The following add-thing-to-billing-group example adds a thing with a specified ARN to a billing group with the specified ARN. Specifying an ARN is helpful if you work with multiple AWS Regions or accounts. It can help ensure that you are adding to the right Region and account.

aws iot add-thing-to-thing-group \
    --billing-group-arn "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" \
    --thing-arn "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb"

This command produces no output.

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

Output

None