Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListBillingGroups

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.

Request Syntax


POST /list-billing-groups HTTP/1.1
Content-type: application/json

{
   "BillingPeriod": "string",
   "Filters": { 
      "Arns": [ "string" ],
      "AutoAssociate": boolean,
      "PricingPlan": "string",
      "Statuses": [ "string" ]
   },
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

BillingPeriod

The preferred billing period to get billing groups.

Type: String

Pattern: \d{4}-(0?[1-9]|1[012])

Required: No

Filters

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

Type: ListBillingGroupsFilter object

Required: No

MaxResults

The maximum number of billing groups to retrieve.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "BillingGroups": [ 
      { 
         "AccountGrouping": { 
            "AutoAssociate": boolean
         },
         "Arn": "string",
         "ComputationPreference": { 
            "PricingPlanArn": "string"
         },
         "CreationTime": number,
         "Description": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "PrimaryAccountId": "string",
         "Size": number,
         "Status": "string",
         "StatusReason": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BillingGroups

A list of BillingGroupListElement retrieved.

Type: Array of BillingGroupListElement objects

NextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input doesn't match with the constraints specified by AWS services.

HTTP Status Code: 400