BillingConductor / Client / list_account_associations

list_account_associations#

BillingConductor.Client.list_account_associations(**kwargs)#

This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group that’s associated with the linked account.

See also: AWS API Documentation

Request Syntax

response = client.list_account_associations(
    BillingPeriod='string',
    Filters={
        'Association': 'string',
        'AccountId': 'string',
        'AccountIds': [
            'string',
        ]
    },
    NextToken='string'
)
Parameters:

  • BillingPeriod (string) – The preferred billing period to get account associations.

  • Filters (dict) –

    The filter on the account ID of the linked account, or any of the following:

    MONITORED: linked accounts that are associated to billing groups.

    UNMONITORED: linked accounts that aren’t associated to billing groups.

    Billing Group Arn: linked accounts that are associated to the provided billing group Arn.

    • Association (string) –

      MONITORED: linked accounts that are associated to billing groups.

      UNMONITORED: linked accounts that are not associated to billing groups.

      Billing Group Arn: linked accounts that are associated to the provided Billing Group Arn.

    • AccountId (string) –

      The Amazon Web Services account ID to filter on.

    • AccountIds (list) –

      The list of Amazon Web Services IDs to retrieve their associated billing group for a given time range.

      • (string) –

  • NextToken (string) – The pagination token that’s used on subsequent calls to retrieve accounts.

Return type:

dict

Returns:

Response Syntax

{
    'LinkedAccounts': [
        {
            'AccountId': 'string',
            'BillingGroupArn': 'string',
            'AccountName': 'string',
            'AccountEmail': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • LinkedAccounts (list) –

      The list of linked accounts in the payer account.

      • (dict) –

        A representation of a linked account.

        • AccountId (string) –

          The associating array of account IDs.

        • BillingGroupArn (string) –

          The Billing Group Arn that the linked account is associated to.

        • AccountName (string) –

          The Amazon Web Services account name.

        • AccountEmail (string) –

          The Amazon Web Services account email.

    • NextToken (string) –

      The pagination token that’s used on subsequent calls to get accounts.

Exceptions