Invoicing / Paginator / ListInvoiceUnits

ListInvoiceUnits

class Invoicing.Paginator.ListInvoiceUnits

paginator = client.get_paginator('list_invoice_units')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Invoicing.Client.list_invoice_units().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters={
        'Names': [
            'string',
        ],
        'InvoiceReceivers': [
            'string',
        ],
        'Accounts': [
            'string',
        ]
    },
    AsOf=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (dict) –

  An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers, Names, and Accounts.

  • Names (list) –

    An optional input to the list API. You can specify a list of invoice unit names inside filters to return invoice units that match only the specified invoice unit names. If multiple names are provided, the result is an OR condition (match any) of the specified invoice unit names.

    • (string) –

  • InvoiceReceivers (list) –

    You can specify a list of Amazon Web Services account IDs inside filters to return invoice units that match only the specified accounts. If multiple accounts are provided, the result is an OR condition (match any) of the specified accounts. This filter only matches the specified accounts on the invoice receivers of the invoice units.

    • (string) –

  • Accounts (list) –

    You can specify a list of Amazon Web Services account IDs inside filters to return invoice units that match only the specified accounts. If multiple accounts are provided, the result is an OR condition (match any) of the specified accounts. The specified account IDs are matched with either the receiver or the linked accounts in the rules.

    • (string) –

• AsOf (datetime) – The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf time is set to before it was deleted. If an AsOf is not provided, the default value is the current time.

• 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.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'InvoiceUnits': [
        {
            'InvoiceUnitArn': 'string',
            'InvoiceReceiver': 'string',
            'Name': 'string',
            'Description': 'string',
            'TaxInheritanceDisabled': True|False,
            'Rule': {
                'LinkedAccounts': [
                    'string',
                ]
            },
            'LastModified': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • InvoiceUnits (list) –

    An invoice unit is a set of mutually exclusive accounts that correspond to your business entity.

    • (dict) –

      An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you separate Amazon Web Services account costs and configures your invoice for each business entity going forward.

      • InvoiceUnitArn (string) –

        ARN to identify an invoice unit. This information can’t be modified or deleted.

      • InvoiceReceiver (string) –

        The account that receives invoices related to the invoice unit.

      • Name (string) –

        A unique name that is distinctive within your Amazon Web Services.

      • Description (string) –

        The assigned description for an invoice unit. This information can’t be modified or deleted.

      • TaxInheritanceDisabled (boolean) –

        Whether the invoice unit based tax inheritance is/ should be enabled or disabled.

      • Rule (dict) –

        An InvoiceUnitRule object used the categorize invoice units.

        • LinkedAccounts (list) –

          The list of LINKED_ACCOUNT IDs where charges are included within the invoice unit.

          • (string) –

      • LastModified (datetime) –

        The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration.