BillingConductor / Paginator / ListAccountAssociations

ListAccountAssociations#

class BillingConductor.Paginator.ListAccountAssociations#
paginator = client.get_paginator('list_account_associations')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from BillingConductor.Client.list_account_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    BillingPeriod='string',
    Filters={
        'Association': 'string',
        'AccountId': 'string',
        'AccountIds': [
            'string',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': '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) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'LinkedAccounts': [
        {
            'AccountId': 'string',
            'BillingGroupArn': 'string',
            'AccountName': 'string',
            'AccountEmail': '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.