UpdateBillingGroup - AWS Billing Conductor

UpdateBillingGroup

This updates an existing billing group.

Request Syntax

POST /update-billing-group HTTP/1.1 Content-type: application/json { "Arn": "string", "ComputationPreference": { "PricingPlanArn": "string" }, "Description": "string", "Name": "string", "Status": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Arn

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

Type: String

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

Required: Yes

ComputationPreference

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

Type: ComputationPreference object

Required: No

Description

A description of the billing group.

Type: String

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

Required: No

Name

The name of the billing group. The names must be unique to each billing group.

Type: String

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

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

Required: No

Status

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

Type: String

Valid Values: ACTIVE | PRIMARY_ACCOUNT_MISSING

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "Description": "string", "LastModifiedTime": number, "Name": "string", "PricingPlanArn": "string", "PrimaryAccountId": "string", "Size": number, "Status": "string", "StatusReason": "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 billing group that was updated.

Type: String

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

Description

A description of the billing group.

Type: String

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

LastModifiedTime

The most recent time the billing group was modified.

Type: Long

Name

The name of the billing group. The names must be unique to each billing group.

Type: String

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

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

PricingPlanArn

The Amazon Resource Name (ARN) of the pricing plan to compute AWS charges for the billing group.

Type: String

Pattern: (arn:aws:billingconductor::[0-9]{12}:pricingplan/)?[a-zA-Z0-9]{10}

PrimaryAccountId

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

Type: String

Pattern: [0-9]{12}

Size

The number of accounts in the particular billing group.

Type: Long

Valid Range: Minimum value of 0.

Status

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

Type: String

Valid Values: ACTIVE | PRIMARY_ACCOUNT_MISSING

StatusReason

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

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

ConflictException

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

HTTP Status Code: 409

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: