[ aws . billingconductor ]

list-billing-groups

Description

A paginated call to retrieve a list of billing groups for the given billing period. If you don’t provide a billing group, the current billing period is used.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-billing-groups is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: BillingGroups

Synopsis

  list-billing-groups
[--billing-period <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--billing-period (string)

The preferred billing period to get billing groups.

--filters (structure)

A ListBillingGroupsFilter that specifies the billing group and pricing plan to retrieve billing group information.

Arns -> (list)

The list of billing group Amazon Resource Names (ARNs) to retrieve information.

(string)

PricingPlan -> (string)

The pricing plan Amazon Resource Names (ARNs) to retrieve information.

Shorthand Syntax:

Arns=string,string,PricingPlan=string

JSON Syntax:

{
  "Arns": ["string", ...],
  "PricingPlan": "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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Output

BillingGroups -> (list)

A list of BillingGroupListElement retrieved.

(structure)

A representation of a billing group.

Name -> (string)

The billing group’s name.

Arn -> (string)

The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group.

Description -> (string)

The billing group description.

PrimaryAccountId -> (string)

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

ComputationPreference -> (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 used to compute the Amazon Web Services charges for a billing group.

Size -> (long)

The number of accounts in the particular billing group.

CreationTime -> (long)

The time the billing group was created.

LastModifiedTime -> (long)

The most recent time the billing group was modified.

Status -> (string)

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

StatusReason -> (string)

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

NextToken -> (string)

The pagination token used on subsequent calls to get billing groups.