BillingConductor / Client / update_billing_group

update_billing_group#

BillingConductor.Client.update_billing_group(**kwargs)#

This updates an existing billing group.

See also: AWS API Documentation

Request Syntax

response = client.update_billing_group(
    Arn='string',
    Name='string',
    Status='ACTIVE'|'PRIMARY_ACCOUNT_MISSING',
    ComputationPreference={
        'PricingPlanArn': 'string'
    },
    Description='string',
    AccountGrouping={
        'AutoAssociate': True|False
    }
)
Parameters:

  • Arn (string) –

    [REQUIRED]

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

  • Name (string) – The name of the billing group. The names must be unique to each billing group.

  • Status (string) – The status of the billing group. Only one of the valid values can be used.

  • ComputationPreference (dict) –

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

    • PricingPlanArn (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of the pricing plan that’s used to compute the Amazon Web Services charges for a billing group.

  • Description (string) – A description of the billing group.

  • AccountGrouping (dict) –

    Specifies if the billing group has automatic account association ( AutoAssociate) enabled.

    • AutoAssociate (boolean) –

      Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'Description': 'string',
    'PrimaryAccountId': 'string',
    'PricingPlanArn': 'string',
    'Size': 123,
    'LastModifiedTime': 123,
    'Status': 'ACTIVE'|'PRIMARY_ACCOUNT_MISSING',
    'StatusReason': 'string',
    'AccountGrouping': {
        'AutoAssociate': True|False
    }
}

Response Structure

  • (dict) –

    • Arn (string) –

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

    • Name (string) –

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

    • Description (string) –

      A description of the billing group.

    • PrimaryAccountId (string) –

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

    • PricingPlanArn (string) –

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

    • Size (integer) –

      The number of accounts in the particular billing group.

    • LastModifiedTime (integer) –

      The most recent time when the billing group was modified.

    • Status (string) –

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

    • StatusReason (string) –

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

    • AccountGrouping (dict) –

      Specifies if the billing group has automatic account association ( AutoAssociate) enabled.

      • AutoAssociate (boolean) –

        Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.

Exceptions

  • BillingConductor.Client.exceptions.ThrottlingException

  • BillingConductor.Client.exceptions.ConflictException

  • BillingConductor.Client.exceptions.AccessDeniedException

  • BillingConductor.Client.exceptions.ValidationException

  • BillingConductor.Client.exceptions.InternalServerException

  • BillingConductor.Client.exceptions.ResourceNotFoundException