- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateBillingGroupCommand
This updates an existing billing group.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { BillingconductorClient, UpdateBillingGroupCommand } from "@aws-sdk/client-billingconductor"; // ES Modules import
// const { BillingconductorClient, UpdateBillingGroupCommand } = require("@aws-sdk/client-billingconductor"); // CommonJS import
const client = new BillingconductorClient(config);
const input = { // UpdateBillingGroupInput
Arn: "STRING_VALUE", // required
Name: "STRING_VALUE",
Status: "STRING_VALUE",
ComputationPreference: { // ComputationPreference
PricingPlanArn: "STRING_VALUE", // required
},
Description: "STRING_VALUE",
AccountGrouping: { // UpdateBillingGroupAccountGrouping
AutoAssociate: true || false,
},
};
const command = new UpdateBillingGroupCommand(input);
const response = await client.send(command);
// { // UpdateBillingGroupOutput
// Arn: "STRING_VALUE",
// Name: "STRING_VALUE",
// Description: "STRING_VALUE",
// PrimaryAccountId: "STRING_VALUE",
// PricingPlanArn: "STRING_VALUE",
// Size: Number("long"),
// LastModifiedTime: Number("long"),
// Status: "STRING_VALUE",
// StatusReason: "STRING_VALUE",
// AccountGrouping: { // UpdateBillingGroupAccountGrouping
// AutoAssociate: true || false,
// },
// };
UpdateBillingGroupCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ArnRequired | string | undefined | The Amazon Resource Name (ARN) of the billing group being updated. |
AccountGrouping | UpdateBillingGroupAccountGrouping | undefined | Specifies if the billing group has automatic account association ( |
ComputationPreference | ComputationPreference | undefined | The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group. |
Description | string | undefined | A description of the billing group. |
Name | string | undefined | The name of the billing group. The names must be unique to each billing group. |
Status | BillingGroupStatus | undefined | The status of the billing group. Only one of the valid values can be used. |
UpdateBillingGroupCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
AccountGrouping | UpdateBillingGroupAccountGrouping | undefined | Specifies if the billing group has automatic account association ( |
Arn | string | undefined | The Amazon Resource Name (ARN) of the billing group that was updated. |
Description | string | undefined | A description of the billing group. |
LastModifiedTime | number | undefined | The most recent time when the billing group was modified. |
Name | string | undefined | The name of the billing group. The names must be unique to each billing group. |
PricingPlanArn | string | undefined | The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web Services charges for the billing group. |
PrimaryAccountId | string | undefined | The account ID that serves as the main account in a billing group. |
Size | number | undefined | The number of accounts in the particular billing group. |
Status | BillingGroupStatus | undefined | The status of the billing group. Only one of the valid values can be used. |
StatusReason | string | undefined | The reason why the billing group is in its current status. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient access to perform this action. |
| ConflictException | client | You can cause an inconsistent state by updating or deleting a resource. |
| InternalServerException | server | An unexpected error occurred while processing a request. |
| ResourceNotFoundException | client | The request references a resource that doesn't exist. |
| ThrottlingException | client | The request was denied due to request throttling. |
| ValidationException | client | The input doesn't match with the constraints specified by Amazon Web Services. |
| BillingconductorServiceException | Base exception class for all service exceptions from Billingconductor service. |