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

CreateBillingGroup

Creates a billing group that resembles a consolidated billing family that AWS charges, based off of the predefined pricing plan computation.

Request Syntax


POST /create-billing-group HTTP/1.1
X-Amzn-Client-Token: ClientToken
Content-type: application/json

{
   "AccountGrouping": { 
      "AutoAssociate": boolean,
      "LinkedAccountIds": [ "string" ]
   },
   "ComputationPreference": { 
      "PricingPlanArn": "string"
   },
   "Description": "string",
   "Name": "string",
   "PrimaryAccountId": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

ClientToken

A unique, case-sensitive identifier that you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

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

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

Request Body

The request accepts the following data in JSON format.

AccountGrouping

The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated billing family.

Type: AccountGrouping object

Required: Yes

ComputationPreference

The preferences and settings that will be used to compute the AWS charges for a billing group.

Type: ComputationPreference object

Required: Yes

Description

The description of the billing group.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

Name

The billing group name. The names must be unique.

Type: String

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

Pattern: [a-zA-Z0-9_\+=\.\-@]+

Required: Yes

PrimaryAccountId

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

Type: String

Pattern: [0-9]{12}

Required: No

Tags

A map that contains tag keys and tag values that are attached to a billing group. This feature isn't available during the beta.

Type: String to string map

Map Entries: Maximum number of 200 items.

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

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "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.

Arn

The Amazon Resource Name (ARN) of the created billing group.

Type: String

Pattern: (arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}

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

ConflictException

You can cause an inconsistent state by updating or deleting a resource.

Reason: Reason for the inconsistent state.
ResourceId: Identifier of the resource in use.
ResourceType: Type of the resource in use.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing a request.

RetryAfterSeconds: Number of seconds you can retry after the call.

HTTP Status Code: 500

ServiceLimitExceededException

The request would cause a service limit to exceed.

LimitCode: The unique code identifier of the service limit that is being exceeded.
ResourceId: Identifier of the resource affected.
ResourceType: Type of the resource affected.
ServiceCode: The unique code for the service of the limit that is being exceeded.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

RetryAfterSeconds: Number of seconds you can safely retry after the call.

HTTP Status Code: 429

ValidationException

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

Fields: The fields that caused the error, if applicable.
Reason: The reason the request's validation failed.

HTTP Status Code: 400