[ aws . iot ]

describe-billing-group

Description

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--billing-group-name (string)

The name of 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.

See ‘aws help’ for descriptions of global parameters.

Examples

To get information about a billing group

The following describe-billing-group example gets information for the specified billing group.

aws iot describe-billing-group --billing-group-name GroupOne

Output:

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

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

Output

billingGroupName -> (string)

The name of the billing group.

billingGroupId -> (string)

The ID of the billing group.

billingGroupArn -> (string)

The ARN of the billing group.

version -> (long)

The version of the billing group.

billingGroupProperties -> (structure)

The properties of the billing group.

billingGroupDescription -> (string)

The description of the billing group.

billingGroupMetadata -> (structure)

Additional information about the billing group.

creationDate -> (timestamp)

The date the billing group was created.