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

ListBillingGroups

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups action.

Request Syntax


GET /billing-groups?maxResults=maxResults&namePrefixFilter=namePrefixFilter&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return per request.

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

namePrefixFilter

Limit the results to billing groups whose names have the given prefix.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:_-]+

nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "billingGroups": [ 
      { 
         "groupArn": "string",
         "groupName": "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

The list of billing groups.

Type: Array of GroupNameAndArn objects

nextToken

The token to use to get the next set of results, or null if there are no additional results.

Type: String

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400