CreateBillingGroup
Creates a billing group. If this call is made multiple times using
the same billing group name and configuration, the call will succeed. If this call is made with
the same billing group name but different configuration a ResourceAlreadyExistsException
is thrown.
Requires permission to access the CreateBillingGroup action.
Request Syntax
POST /billing-groups/billingGroupName
HTTP/1.1
Content-type: application/json
{
"billingGroupProperties": {
"billingGroupDescription": "string
"
},
"tags": [
{
"Key": "string
",
"Value": "string
"
}
]
}
URI Request Parameters
The request uses the following URI parameters.
- billingGroupName
-
The name you wish to give to the billing group.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+
Required: Yes
Request Body
The request accepts the following data in JSON format.
- billingGroupProperties
-
The properties of the billing group.
Type: BillingGroupProperties object
Required: No
-
Metadata which can be used to manage the billing group.
Type: Array of Tag objects
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"billingGroupArn": "string",
"billingGroupId": "string",
"billingGroupName": "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.
- billingGroupArn
-
The ARN of the billing group.
Type: String
- billingGroupId
-
The ID of the billing group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9\-]+
- billingGroupName
-
The name you gave to the billing group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceAlreadyExistsException
-
The resource already exists.
HTTP Status Code: 409
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: