Invoicing ********* Client ====== class Invoicing.Client A low-level client representing AWS Invoicing **Amazon Web Services Invoice Configuration** You can use Amazon Web Services Invoice Configuration APIs to programmatically create, update, delete, get, and list invoice units. You can also programmatically fetch the information of the invoice receiver. For example, business legal name, address, and invoicing contacts. You can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units. Service endpoint You can use the following endpoints for Amazon Web Services Invoice Configuration: * "https://invoicing.us-east-1.api.aws" import boto3 client = boto3.client('invoicing') These are the available methods: * batch_get_invoice_profile * can_paginate * close * create_invoice_unit * delete_invoice_unit * get_invoice_unit * get_paginator * get_waiter * list_invoice_summaries * list_invoice_units * list_tags_for_resource * tag_resource * untag_resource * update_invoice_unit Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListInvoiceSummaries * ListInvoiceUnits Invoicing / Paginator / ListInvoiceSummaries ListInvoiceSummaries ******************** class Invoicing.Paginator.ListInvoiceSummaries paginator = client.get_paginator('list_invoice_summaries') paginate(**kwargs) Creates an iterator that will paginate through responses from "Invoicing.Client.list_invoice_summaries()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Selector={ 'ResourceType': 'ACCOUNT_ID'|'INVOICE_ID', 'Value': 'string' }, Filter={ 'TimeInterval': { 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1) }, 'BillingPeriod': { 'Month': 123, 'Year': 123 }, 'InvoicingEntity': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Selector** (*dict*) -- **[REQUIRED]** The option to retrieve details for a specific invoice by providing its unique ID. Alternatively, access information for all invoices linked to the account by providing an account ID. * **ResourceType** *(string) --* **[REQUIRED]** The query identifier type ( "INVOICE_ID" or "ACCOUNT_ID"). * **Value** *(string) --* **[REQUIRED]** The value of the query identifier. * **Filter** (*dict*) -- Filters you can use to customize your invoice summary. * **TimeInterval** *(dict) --* The date range for invoice summary retrieval. * **StartDate** *(datetime) --* **[REQUIRED]** The beginning of the time period that you want invoice- related documents for. The start date is inclusive. For example, if "start" is "2019-01-01", AWS retrieves invoices starting at "2019-01-01" up to the end date. * **EndDate** *(datetime) --* **[REQUIRED]** The end of the time period that you want invoice- related documents for. The end date is exclusive. For example, if "end" is "2019-01-10", Amazon Web Services retrieves invoice-related documents from the start date up to, but not including, "2018-01-10". * **BillingPeriod** *(dict) --* The billing period associated with the invoice documents. * **Month** *(integer) --* **[REQUIRED]** The billing period month. * **Year** *(integer) --* **[REQUIRED]** The billing period year. * **InvoicingEntity** *(string) --* The name of the entity that issues the Amazon Web Services invoice. * **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** { 'InvoiceSummaries': [ { 'AccountId': 'string', 'InvoiceId': 'string', 'IssuedDate': datetime(2015, 1, 1), 'DueDate': datetime(2015, 1, 1), 'Entity': { 'InvoicingEntity': 'string' }, 'BillingPeriod': { 'Month': 123, 'Year': 123 }, 'InvoiceType': 'INVOICE'|'CREDIT_MEMO', 'OriginalInvoiceId': 'string', 'PurchaseOrderNumber': 'string', 'BaseCurrencyAmount': { 'TotalAmount': 'string', 'TotalAmountBeforeTax': 'string', 'CurrencyCode': 'string', 'AmountBreakdown': { 'SubTotalAmount': 'string', 'Discounts': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Taxes': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Fees': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' } }, 'CurrencyExchangeDetails': { 'SourceCurrencyCode': 'string', 'TargetCurrencyCode': 'string', 'Rate': 'string' } }, 'TaxCurrencyAmount': { 'TotalAmount': 'string', 'TotalAmountBeforeTax': 'string', 'CurrencyCode': 'string', 'AmountBreakdown': { 'SubTotalAmount': 'string', 'Discounts': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Taxes': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Fees': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' } }, 'CurrencyExchangeDetails': { 'SourceCurrencyCode': 'string', 'TargetCurrencyCode': 'string', 'Rate': 'string' } }, 'PaymentCurrencyAmount': { 'TotalAmount': 'string', 'TotalAmountBeforeTax': 'string', 'CurrencyCode': 'string', 'AmountBreakdown': { 'SubTotalAmount': 'string', 'Discounts': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Taxes': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Fees': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' } }, 'CurrencyExchangeDetails': { 'SourceCurrencyCode': 'string', 'TargetCurrencyCode': 'string', 'Rate': 'string' } } }, ], } **Response Structure** * *(dict) --* * **InvoiceSummaries** *(list) --* List of key (summary level) invoice details without line item details. * *(dict) --* The invoice that the API retrieved. * **AccountId** *(string) --* The Amazon Web Services account ID. * **InvoiceId** *(string) --* The invoice ID. * **IssuedDate** *(datetime) --* The issued date of the invoice. * **DueDate** *(datetime) --* The invoice due date. * **Entity** *(dict) --* The organization name providing Amazon Web Services services. * **InvoicingEntity** *(string) --* The name of the entity that issues the Amazon Web Services invoice. * **BillingPeriod** *(dict) --* The billing period of the invoice-related document. * **Month** *(integer) --* The billing period month. * **Year** *(integer) --* The billing period year. * **InvoiceType** *(string) --* The type of invoice. * **OriginalInvoiceId** *(string) --* The initial or original invoice ID. * **PurchaseOrderNumber** *(string) --* The purchase order number associated to the invoice. * **BaseCurrencyAmount** *(dict) --* The summary with the product and service currency. * **TotalAmount** *(string) --* The invoice currency amount. * **TotalAmountBeforeTax** *(string) --* Details about the invoice total amount before tax. * **CurrencyCode** *(string) --* The currency dominion of the invoice document. * **AmountBreakdown** *(dict) --* Details about the invoice currency amount. * **SubTotalAmount** *(string) --* The total of a set of the breakdown. * **Discounts** *(dict) --* The discounted amount. * **Breakdown** *(list) --* The list of discounts information. * *(dict) --* The discounted amount. * **Description** *(string) --* The list of discounts information. * **Amount** *(string) --* The discounted amount. * **Rate** *(string) --* The details for the discount rate.. * **TotalAmount** *(string) --* The discount's total amount. * **Taxes** *(dict) --* The tax amount. * **Breakdown** *(list) --* A list of tax information. * *(dict) --* The tax amount. * **Description** *(string) --* The details of the taxes. * **Amount** *(string) --* The tax amount. * **Rate** *(string) --* The details of the tax rate. * **TotalAmount** *(string) --* The total amount for your taxes. * **Fees** *(dict) --* The fee amount. * **Breakdown** *(list) --* The list of fees information. * *(dict) --* The fee amount. * **Description** *(string) --* The list of fees information. * **Amount** *(string) --* The fee amount. * **Rate** *(string) --* Details about the rate amount. * **TotalAmount** *(string) --* The total amount of fees. * **CurrencyExchangeDetails** *(dict) --* The details of currency exchange. * **SourceCurrencyCode** *(string) --* The exchange source currency. * **TargetCurrencyCode** *(string) --* The exchange target currency. * **Rate** *(string) --* The currency exchange rate. * **TaxCurrencyAmount** *(dict) --* The summary with the tax currency. * **TotalAmount** *(string) --* The invoice currency amount. * **TotalAmountBeforeTax** *(string) --* Details about the invoice total amount before tax. * **CurrencyCode** *(string) --* The currency dominion of the invoice document. * **AmountBreakdown** *(dict) --* Details about the invoice currency amount. * **SubTotalAmount** *(string) --* The total of a set of the breakdown. * **Discounts** *(dict) --* The discounted amount. * **Breakdown** *(list) --* The list of discounts information. * *(dict) --* The discounted amount. * **Description** *(string) --* The list of discounts information. * **Amount** *(string) --* The discounted amount. * **Rate** *(string) --* The details for the discount rate.. * **TotalAmount** *(string) --* The discount's total amount. * **Taxes** *(dict) --* The tax amount. * **Breakdown** *(list) --* A list of tax information. * *(dict) --* The tax amount. * **Description** *(string) --* The details of the taxes. * **Amount** *(string) --* The tax amount. * **Rate** *(string) --* The details of the tax rate. * **TotalAmount** *(string) --* The total amount for your taxes. * **Fees** *(dict) --* The fee amount. * **Breakdown** *(list) --* The list of fees information. * *(dict) --* The fee amount. * **Description** *(string) --* The list of fees information. * **Amount** *(string) --* The fee amount. * **Rate** *(string) --* Details about the rate amount. * **TotalAmount** *(string) --* The total amount of fees. * **CurrencyExchangeDetails** *(dict) --* The details of currency exchange. * **SourceCurrencyCode** *(string) --* The exchange source currency. * **TargetCurrencyCode** *(string) --* The exchange target currency. * **Rate** *(string) --* The currency exchange rate. * **PaymentCurrencyAmount** *(dict) --* The summary with the customer configured currency. * **TotalAmount** *(string) --* The invoice currency amount. * **TotalAmountBeforeTax** *(string) --* Details about the invoice total amount before tax. * **CurrencyCode** *(string) --* The currency dominion of the invoice document. * **AmountBreakdown** *(dict) --* Details about the invoice currency amount. * **SubTotalAmount** *(string) --* The total of a set of the breakdown. * **Discounts** *(dict) --* The discounted amount. * **Breakdown** *(list) --* The list of discounts information. * *(dict) --* The discounted amount. * **Description** *(string) --* The list of discounts information. * **Amount** *(string) --* The discounted amount. * **Rate** *(string) --* The details for the discount rate.. * **TotalAmount** *(string) --* The discount's total amount. * **Taxes** *(dict) --* The tax amount. * **Breakdown** *(list) --* A list of tax information. * *(dict) --* The tax amount. * **Description** *(string) --* The details of the taxes. * **Amount** *(string) --* The tax amount. * **Rate** *(string) --* The details of the tax rate. * **TotalAmount** *(string) --* The total amount for your taxes. * **Fees** *(dict) --* The fee amount. * **Breakdown** *(list) --* The list of fees information. * *(dict) --* The fee amount. * **Description** *(string) --* The list of fees information. * **Amount** *(string) --* The fee amount. * **Rate** *(string) --* Details about the rate amount. * **TotalAmount** *(string) --* The total amount of fees. * **CurrencyExchangeDetails** *(dict) --* The details of currency exchange. * **SourceCurrencyCode** *(string) --* The exchange source currency. * **TargetCurrencyCode** *(string) --* The exchange target currency. * **Rate** *(string) --* The currency exchange rate. 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. Invoicing / Client / get_paginator get_paginator ************* Invoicing.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Invoicing / Client / can_paginate can_paginate ************ Invoicing.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. Invoicing / Client / list_invoice_units list_invoice_units ****************** Invoicing.Client.list_invoice_units(**kwargs) This fetches a list of all invoice unit definitions for a given account, as of the provided "AsOf" date. See also: AWS API Documentation **Request Syntax** response = client.list_invoice_units( Filters={ 'Names': [ 'string', ], 'InvoiceReceivers': [ 'string', ], 'Accounts': [ 'string', ] }, NextToken='string', MaxResults=123, AsOf=datetime(2015, 1, 1) ) 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) --* * **NextToken** (*string*) -- The next token used to indicate where the returned list should start from. * **MaxResults** (*integer*) -- The maximum number of invoice units that can be returned. * **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. 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) }, ], 'NextToken': 'string' } **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. * **NextToken** *(string) --* The next token used to indicate where the returned list should start from. **Exceptions** * "Invoicing.Client.exceptions.ValidationException" * "Invoicing.Client.exceptions.InternalServerException" * "Invoicing.Client.exceptions.ThrottlingException" * "Invoicing.Client.exceptions.AccessDeniedException" Invoicing / Client / list_tags_for_resource list_tags_for_resource ********************** Invoicing.Client.list_tags_for_resource(**kwargs) Lists the tags for a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of tags to list. Return type: dict Returns: **Response Syntax** { 'ResourceTags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **ResourceTags** *(list) --* Adds a tag to a resource. * *(dict) --* The tag structure that contains a tag key and value. * **Key** *(string) --* The object key of your of your resource tag. * **Value** *(string) --* The specific value of the resource tag. **Exceptions** * "Invoicing.Client.exceptions.ResourceNotFoundException" * "Invoicing.Client.exceptions.ValidationException" * "Invoicing.Client.exceptions.InternalServerException" * "Invoicing.Client.exceptions.ThrottlingException" * "Invoicing.Client.exceptions.AccessDeniedException" Invoicing / Client / delete_invoice_unit delete_invoice_unit ******************* Invoicing.Client.delete_invoice_unit(**kwargs) This deletes an invoice unit with the provided invoice unit ARN. See also: AWS API Documentation **Request Syntax** response = client.delete_invoice_unit( InvoiceUnitArn='string' ) Parameters: **InvoiceUnitArn** (*string*) -- **[REQUIRED]** The ARN to identify an invoice unit. This information can't be modified or deleted. Return type: dict Returns: **Response Syntax** { 'InvoiceUnitArn': 'string' } **Response Structure** * *(dict) --* * **InvoiceUnitArn** *(string) --* The ARN to identify an invoice unit. This information can't be modified or deleted. **Exceptions** * "Invoicing.Client.exceptions.ResourceNotFoundException" * "Invoicing.Client.exceptions.ValidationException" * "Invoicing.Client.exceptions.InternalServerException" * "Invoicing.Client.exceptions.ThrottlingException" * "Invoicing.Client.exceptions.AccessDeniedException" Invoicing / Client / untag_resource untag_resource ************** Invoicing.Client.untag_resource(**kwargs) Removes a tag from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', ResourceTagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) to untag. * **ResourceTagKeys** (*list*) -- **[REQUIRED]** Keys for the tags to be removed. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Invoicing.Client.exceptions.ResourceNotFoundException" * "Invoicing.Client.exceptions.ValidationException" * "Invoicing.Client.exceptions.InternalServerException" * "Invoicing.Client.exceptions.ThrottlingException" * "Invoicing.Client.exceptions.AccessDeniedException" Invoicing / Client / get_waiter get_waiter ********** Invoicing.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Invoicing / Client / batch_get_invoice_profile batch_get_invoice_profile ************************* Invoicing.Client.batch_get_invoice_profile(**kwargs) This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization. See also: AWS API Documentation **Request Syntax** response = client.batch_get_invoice_profile( AccountIds=[ 'string', ] ) Parameters: **AccountIds** (*list*) -- **[REQUIRED]** Retrieves the corresponding invoice profile data for these account IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Profiles': [ { 'AccountId': 'string', 'ReceiverName': 'string', 'ReceiverAddress': { 'AddressLine1': 'string', 'AddressLine2': 'string', 'AddressLine3': 'string', 'DistrictOrCounty': 'string', 'City': 'string', 'StateOrRegion': 'string', 'CountryCode': 'string', 'CompanyName': 'string', 'PostalCode': 'string' }, 'ReceiverEmail': 'string', 'Issuer': 'string', 'TaxRegistrationNumber': 'string' }, ] } **Response Structure** * *(dict) --* * **Profiles** *(list) --* A list of invoice profiles corresponding to the requested accounts. * *(dict) --* Contains high-level information about the invoice receiver. * **AccountId** *(string) --* The account ID the invoice profile is generated for. * **ReceiverName** *(string) --* The name of the person receiving the invoice profile. * **ReceiverAddress** *(dict) --* The address of the receiver that will be printed on the invoice. * **AddressLine1** *(string) --* The first line of the address. * **AddressLine2** *(string) --* The second line of the address, if applicable. * **AddressLine3** *(string) --* The third line of the address, if applicable. * **DistrictOrCounty** *(string) --* The district or country the address is located in. * **City** *(string) --* The city that the address is in. * **StateOrRegion** *(string) --* The state, region, or province the address is located. * **CountryCode** *(string) --* The country code for the country the address is in. * **CompanyName** *(string) --* A unique company name. * **PostalCode** *(string) --* The postal code associated with the address. * **ReceiverEmail** *(string) --* The email address for the invoice profile receiver. * **Issuer** *(string) --* This specifies the issuing entity of the invoice. * **TaxRegistrationNumber** *(string) --* Your Tax Registration Number (TRN) information. **Exceptions** * "Invoicing.Client.exceptions.ResourceNotFoundException" * "Invoicing.Client.exceptions.ValidationException" * "Invoicing.Client.exceptions.InternalServerException" * "Invoicing.Client.exceptions.ThrottlingException" * "Invoicing.Client.exceptions.AccessDeniedException" Invoicing / Client / create_invoice_unit create_invoice_unit ******************* Invoicing.Client.create_invoice_unit(**kwargs) This creates a new invoice unit with the provided definition. See also: AWS API Documentation **Request Syntax** response = client.create_invoice_unit( Name='string', InvoiceReceiver='string', Description='string', TaxInheritanceDisabled=True|False, Rule={ 'LinkedAccounts': [ 'string', ] }, ResourceTags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The unique name of the invoice unit that is shown on the generated invoice. This can't be changed once it is set. To change this name, you must delete the invoice unit recreate. * **InvoiceReceiver** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID. * **Description** (*string*) -- The invoice unit's description. This can be changed at a later time. * **TaxInheritanceDisabled** (*boolean*) -- Whether the invoice unit based tax inheritance is/ should be enabled or disabled. * **Rule** (*dict*) -- **[REQUIRED]** The "InvoiceUnitRule" object used to create invoice units. * **LinkedAccounts** *(list) --* The list of "LINKED_ACCOUNT" IDs where charges are included within the invoice unit. * *(string) --* * **ResourceTags** (*list*) -- The tag structure that contains a tag key and value. * *(dict) --* The tag structure that contains a tag key and value. * **Key** *(string) --* **[REQUIRED]** The object key of your of your resource tag. * **Value** *(string) --* **[REQUIRED]** The specific value of the resource tag. Return type: dict Returns: **Response Syntax** { 'InvoiceUnitArn': 'string' } **Response Structure** * *(dict) --* * **InvoiceUnitArn** *(string) --* The ARN to identify an invoice unit. This information can't be modified or deleted. **Exceptions** * "Invoicing.Client.exceptions.ValidationException" * "Invoicing.Client.exceptions.InternalServerException" * "Invoicing.Client.exceptions.ThrottlingException" * "Invoicing.Client.exceptions.AccessDeniedException" Invoicing / Client / get_invoice_unit get_invoice_unit **************** Invoicing.Client.get_invoice_unit(**kwargs) This retrieves the invoice unit definition. See also: AWS API Documentation **Request Syntax** response = client.get_invoice_unit( InvoiceUnitArn='string', AsOf=datetime(2015, 1, 1) ) Parameters: * **InvoiceUnitArn** (*string*) -- **[REQUIRED]** The ARN to identify an invoice unit. This information can't be modified or deleted. * **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. Return type: dict Returns: **Response Syntax** { 'InvoiceUnitArn': 'string', 'InvoiceReceiver': 'string', 'Name': 'string', 'Description': 'string', 'TaxInheritanceDisabled': True|False, 'Rule': { 'LinkedAccounts': [ 'string', ] }, 'LastModified': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **InvoiceUnitArn** *(string) --* The ARN to identify an invoice unit. This information can't be modified or deleted. * **InvoiceReceiver** *(string) --* The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID. * **Name** *(string) --* The unique name of the invoice unit that is shown on the generated invoice. * **Description** *(string) --* The assigned description for an invoice unit. * **TaxInheritanceDisabled** *(boolean) --* Whether the invoice unit based tax inheritance is/ should be enabled or disabled. * **Rule** *(dict) --* This is used to categorize the invoice unit. Values are Amazon Web Services account IDs. Currently, the only supported rule is "LINKED_ACCOUNT". * **LinkedAccounts** *(list) --* The list of "LINKED_ACCOUNT" IDs where charges are included within the invoice unit. * *(string) --* * **LastModified** *(datetime) --* The most recent date the invoice unit response was updated. **Exceptions** * "Invoicing.Client.exceptions.ResourceNotFoundException" * "Invoicing.Client.exceptions.ValidationException" * "Invoicing.Client.exceptions.InternalServerException" * "Invoicing.Client.exceptions.ThrottlingException" * "Invoicing.Client.exceptions.AccessDeniedException" Invoicing / Client / list_invoice_summaries list_invoice_summaries ********************** Invoicing.Client.list_invoice_summaries(**kwargs) Retrieves your invoice details programmatically, without line item details. See also: AWS API Documentation **Request Syntax** response = client.list_invoice_summaries( Selector={ 'ResourceType': 'ACCOUNT_ID'|'INVOICE_ID', 'Value': 'string' }, Filter={ 'TimeInterval': { 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1) }, 'BillingPeriod': { 'Month': 123, 'Year': 123 }, 'InvoicingEntity': 'string' }, NextToken='string', MaxResults=123 ) Parameters: * **Selector** (*dict*) -- **[REQUIRED]** The option to retrieve details for a specific invoice by providing its unique ID. Alternatively, access information for all invoices linked to the account by providing an account ID. * **ResourceType** *(string) --* **[REQUIRED]** The query identifier type ( "INVOICE_ID" or "ACCOUNT_ID"). * **Value** *(string) --* **[REQUIRED]** The value of the query identifier. * **Filter** (*dict*) -- Filters you can use to customize your invoice summary. * **TimeInterval** *(dict) --* The date range for invoice summary retrieval. * **StartDate** *(datetime) --* **[REQUIRED]** The beginning of the time period that you want invoice- related documents for. The start date is inclusive. For example, if "start" is "2019-01-01", AWS retrieves invoices starting at "2019-01-01" up to the end date. * **EndDate** *(datetime) --* **[REQUIRED]** The end of the time period that you want invoice-related documents for. The end date is exclusive. For example, if "end" is "2019-01-10", Amazon Web Services retrieves invoice-related documents from the start date up to, but not including, "2018-01-10". * **BillingPeriod** *(dict) --* The billing period associated with the invoice documents. * **Month** *(integer) --* **[REQUIRED]** The billing period month. * **Year** *(integer) --* **[REQUIRED]** The billing period year. * **InvoicingEntity** *(string) --* The name of the entity that issues the Amazon Web Services invoice. * **NextToken** (*string*) -- The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. * **MaxResults** (*integer*) -- The maximum number of invoice summaries a paginated response can contain. Return type: dict Returns: **Response Syntax** { 'InvoiceSummaries': [ { 'AccountId': 'string', 'InvoiceId': 'string', 'IssuedDate': datetime(2015, 1, 1), 'DueDate': datetime(2015, 1, 1), 'Entity': { 'InvoicingEntity': 'string' }, 'BillingPeriod': { 'Month': 123, 'Year': 123 }, 'InvoiceType': 'INVOICE'|'CREDIT_MEMO', 'OriginalInvoiceId': 'string', 'PurchaseOrderNumber': 'string', 'BaseCurrencyAmount': { 'TotalAmount': 'string', 'TotalAmountBeforeTax': 'string', 'CurrencyCode': 'string', 'AmountBreakdown': { 'SubTotalAmount': 'string', 'Discounts': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Taxes': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Fees': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' } }, 'CurrencyExchangeDetails': { 'SourceCurrencyCode': 'string', 'TargetCurrencyCode': 'string', 'Rate': 'string' } }, 'TaxCurrencyAmount': { 'TotalAmount': 'string', 'TotalAmountBeforeTax': 'string', 'CurrencyCode': 'string', 'AmountBreakdown': { 'SubTotalAmount': 'string', 'Discounts': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Taxes': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Fees': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' } }, 'CurrencyExchangeDetails': { 'SourceCurrencyCode': 'string', 'TargetCurrencyCode': 'string', 'Rate': 'string' } }, 'PaymentCurrencyAmount': { 'TotalAmount': 'string', 'TotalAmountBeforeTax': 'string', 'CurrencyCode': 'string', 'AmountBreakdown': { 'SubTotalAmount': 'string', 'Discounts': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Taxes': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' }, 'Fees': { 'Breakdown': [ { 'Description': 'string', 'Amount': 'string', 'Rate': 'string' }, ], 'TotalAmount': 'string' } }, 'CurrencyExchangeDetails': { 'SourceCurrencyCode': 'string', 'TargetCurrencyCode': 'string', 'Rate': 'string' } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **InvoiceSummaries** *(list) --* List of key (summary level) invoice details without line item details. * *(dict) --* The invoice that the API retrieved. * **AccountId** *(string) --* The Amazon Web Services account ID. * **InvoiceId** *(string) --* The invoice ID. * **IssuedDate** *(datetime) --* The issued date of the invoice. * **DueDate** *(datetime) --* The invoice due date. * **Entity** *(dict) --* The organization name providing Amazon Web Services services. * **InvoicingEntity** *(string) --* The name of the entity that issues the Amazon Web Services invoice. * **BillingPeriod** *(dict) --* The billing period of the invoice-related document. * **Month** *(integer) --* The billing period month. * **Year** *(integer) --* The billing period year. * **InvoiceType** *(string) --* The type of invoice. * **OriginalInvoiceId** *(string) --* The initial or original invoice ID. * **PurchaseOrderNumber** *(string) --* The purchase order number associated to the invoice. * **BaseCurrencyAmount** *(dict) --* The summary with the product and service currency. * **TotalAmount** *(string) --* The invoice currency amount. * **TotalAmountBeforeTax** *(string) --* Details about the invoice total amount before tax. * **CurrencyCode** *(string) --* The currency dominion of the invoice document. * **AmountBreakdown** *(dict) --* Details about the invoice currency amount. * **SubTotalAmount** *(string) --* The total of a set of the breakdown. * **Discounts** *(dict) --* The discounted amount. * **Breakdown** *(list) --* The list of discounts information. * *(dict) --* The discounted amount. * **Description** *(string) --* The list of discounts information. * **Amount** *(string) --* The discounted amount. * **Rate** *(string) --* The details for the discount rate.. * **TotalAmount** *(string) --* The discount's total amount. * **Taxes** *(dict) --* The tax amount. * **Breakdown** *(list) --* A list of tax information. * *(dict) --* The tax amount. * **Description** *(string) --* The details of the taxes. * **Amount** *(string) --* The tax amount. * **Rate** *(string) --* The details of the tax rate. * **TotalAmount** *(string) --* The total amount for your taxes. * **Fees** *(dict) --* The fee amount. * **Breakdown** *(list) --* The list of fees information. * *(dict) --* The fee amount. * **Description** *(string) --* The list of fees information. * **Amount** *(string) --* The fee amount. * **Rate** *(string) --* Details about the rate amount. * **TotalAmount** *(string) --* The total amount of fees. * **CurrencyExchangeDetails** *(dict) --* The details of currency exchange. * **SourceCurrencyCode** *(string) --* The exchange source currency. * **TargetCurrencyCode** *(string) --* The exchange target currency. * **Rate** *(string) --* The currency exchange rate. * **TaxCurrencyAmount** *(dict) --* The summary with the tax currency. * **TotalAmount** *(string) --* The invoice currency amount. * **TotalAmountBeforeTax** *(string) --* Details about the invoice total amount before tax. * **CurrencyCode** *(string) --* The currency dominion of the invoice document. * **AmountBreakdown** *(dict) --* Details about the invoice currency amount. * **SubTotalAmount** *(string) --* The total of a set of the breakdown. * **Discounts** *(dict) --* The discounted amount. * **Breakdown** *(list) --* The list of discounts information. * *(dict) --* The discounted amount. * **Description** *(string) --* The list of discounts information. * **Amount** *(string) --* The discounted amount. * **Rate** *(string) --* The details for the discount rate.. * **TotalAmount** *(string) --* The discount's total amount. * **Taxes** *(dict) --* The tax amount. * **Breakdown** *(list) --* A list of tax information. * *(dict) --* The tax amount. * **Description** *(string) --* The details of the taxes. * **Amount** *(string) --* The tax amount. * **Rate** *(string) --* The details of the tax rate. * **TotalAmount** *(string) --* The total amount for your taxes. * **Fees** *(dict) --* The fee amount. * **Breakdown** *(list) --* The list of fees information. * *(dict) --* The fee amount. * **Description** *(string) --* The list of fees information. * **Amount** *(string) --* The fee amount. * **Rate** *(string) --* Details about the rate amount. * **TotalAmount** *(string) --* The total amount of fees. * **CurrencyExchangeDetails** *(dict) --* The details of currency exchange. * **SourceCurrencyCode** *(string) --* The exchange source currency. * **TargetCurrencyCode** *(string) --* The exchange target currency. * **Rate** *(string) --* The currency exchange rate. * **PaymentCurrencyAmount** *(dict) --* The summary with the customer configured currency. * **TotalAmount** *(string) --* The invoice currency amount. * **TotalAmountBeforeTax** *(string) --* Details about the invoice total amount before tax. * **CurrencyCode** *(string) --* The currency dominion of the invoice document. * **AmountBreakdown** *(dict) --* Details about the invoice currency amount. * **SubTotalAmount** *(string) --* The total of a set of the breakdown. * **Discounts** *(dict) --* The discounted amount. * **Breakdown** *(list) --* The list of discounts information. * *(dict) --* The discounted amount. * **Description** *(string) --* The list of discounts information. * **Amount** *(string) --* The discounted amount. * **Rate** *(string) --* The details for the discount rate.. * **TotalAmount** *(string) --* The discount's total amount. * **Taxes** *(dict) --* The tax amount. * **Breakdown** *(list) --* A list of tax information. * *(dict) --* The tax amount. * **Description** *(string) --* The details of the taxes. * **Amount** *(string) --* The tax amount. * **Rate** *(string) --* The details of the tax rate. * **TotalAmount** *(string) --* The total amount for your taxes. * **Fees** *(dict) --* The fee amount. * **Breakdown** *(list) --* The list of fees information. * *(dict) --* The fee amount. * **Description** *(string) --* The list of fees information. * **Amount** *(string) --* The fee amount. * **Rate** *(string) --* Details about the rate amount. * **TotalAmount** *(string) --* The total amount of fees. * **CurrencyExchangeDetails** *(dict) --* The details of currency exchange. * **SourceCurrencyCode** *(string) --* The exchange source currency. * **TargetCurrencyCode** *(string) --* The exchange target currency. * **Rate** *(string) --* The currency exchange rate. * **NextToken** *(string) --* The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. **Exceptions** * "Invoicing.Client.exceptions.ResourceNotFoundException" * "Invoicing.Client.exceptions.ValidationException" * "Invoicing.Client.exceptions.InternalServerException" * "Invoicing.Client.exceptions.ThrottlingException" * "Invoicing.Client.exceptions.AccessDeniedException" Invoicing / Client / close close ***** Invoicing.Client.close() Closes underlying endpoint connections. Invoicing / Client / update_invoice_unit update_invoice_unit ******************* Invoicing.Client.update_invoice_unit(**kwargs) You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month. See also: AWS API Documentation **Request Syntax** response = client.update_invoice_unit( InvoiceUnitArn='string', Description='string', TaxInheritanceDisabled=True|False, Rule={ 'LinkedAccounts': [ 'string', ] } ) Parameters: * **InvoiceUnitArn** (*string*) -- **[REQUIRED]** The ARN to identify an invoice unit. This information can't be modified or deleted. * **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*) -- The "InvoiceUnitRule" object used to update invoice units. * **LinkedAccounts** *(list) --* The list of "LINKED_ACCOUNT" IDs where charges are included within the invoice unit. * *(string) --* Return type: dict Returns: **Response Syntax** { 'InvoiceUnitArn': 'string' } **Response Structure** * *(dict) --* * **InvoiceUnitArn** *(string) --* The ARN to identify an invoice unit. This information can't be modified or deleted. **Exceptions** * "Invoicing.Client.exceptions.ResourceNotFoundException" * "Invoicing.Client.exceptions.ValidationException" * "Invoicing.Client.exceptions.InternalServerException" * "Invoicing.Client.exceptions.ThrottlingException" * "Invoicing.Client.exceptions.AccessDeniedException" Invoicing / Client / tag_resource tag_resource ************ Invoicing.Client.tag_resource(**kwargs) Adds a tag to a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', ResourceTags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the tags. * **ResourceTags** (*list*) -- **[REQUIRED]** Adds a tag to a resource. * *(dict) --* The tag structure that contains a tag key and value. * **Key** *(string) --* **[REQUIRED]** The object key of your of your resource tag. * **Value** *(string) --* **[REQUIRED]** The specific value of the resource tag. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Invoicing.Client.exceptions.ResourceNotFoundException" * "Invoicing.Client.exceptions.ValidationException" * "Invoicing.Client.exceptions.InternalServerException" * "Invoicing.Client.exceptions.ServiceQuotaExceededException" * "Invoicing.Client.exceptions.ThrottlingException" * "Invoicing.Client.exceptions.AccessDeniedException"