BillingConductor **************** Client ====== class BillingConductor.Client A low-level client representing AWSBillingConductor Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a proforma version of your billing data each month, to accurately show or chargeback your end customers. Amazon Web Services Billing Conductor doesn't change the way you're billed by Amazon Web Services each month by design. Instead, it provides you with a mechanism to configure, generate, and display rates to certain customers over a given billing period. You can also analyze the difference between the rates you apply to your accounting groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per billing group. This documentation shows how you can configure Amazon Web Services Billing Conductor using its API. For more information about using the Amazon Web Services Billing Conductor user interface, see the Amazon Web Services Billing Conductor User Guide. import boto3 client = boto3.client('billingconductor') These are the available methods: * associate_accounts * associate_pricing_rules * batch_associate_resources_to_custom_line_item * batch_disassociate_resources_from_custom_line_item * can_paginate * close * create_billing_group * create_custom_line_item * create_pricing_plan * create_pricing_rule * delete_billing_group * delete_custom_line_item * delete_pricing_plan * delete_pricing_rule * disassociate_accounts * disassociate_pricing_rules * get_billing_group_cost_report * get_paginator * get_waiter * list_account_associations * list_billing_group_cost_reports * list_billing_groups * list_custom_line_item_versions * list_custom_line_items * list_pricing_plans * list_pricing_plans_associated_with_pricing_rule * list_pricing_rules * list_pricing_rules_associated_to_pricing_plan * list_resources_associated_to_custom_line_item * list_tags_for_resource * tag_resource * untag_resource * update_billing_group * update_custom_line_item * update_pricing_plan * update_pricing_rule 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: * ListAccountAssociations * ListBillingGroupCostReports * ListBillingGroups * ListCustomLineItemVersions * ListCustomLineItems * ListPricingPlans * ListPricingPlansAssociatedWithPricingRule * ListPricingRules * ListPricingRulesAssociatedToPricingPlan * ListResourcesAssociatedToCustomLineItem BillingConductor / Paginator / ListCustomLineItems ListCustomLineItems ******************* class BillingConductor.Paginator.ListCustomLineItems paginator = client.get_paginator('list_custom_line_items') paginate(**kwargs) Creates an iterator that will paginate through responses from "BillingConductor.Client.list_custom_line_items()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BillingPeriod='string', Filters={ 'Names': [ 'string', ], 'BillingGroups': [ 'string', ], 'Arns': [ 'string', ], 'AccountIds': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BillingPeriod** (*string*) -- The preferred billing period to get custom line items (FFLIs). * **Filters** (*dict*) -- A "ListCustomLineItemsFilter" that specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information. * **Names** *(list) --* A list of custom line items to retrieve information. * *(string) --* * **BillingGroups** *(list) --* The billing group Amazon Resource Names (ARNs) to retrieve information. * *(string) --* * **Arns** *(list) --* A list of custom line item ARNs to retrieve information. * *(string) --* * **AccountIds** *(list) --* The Amazon Web Services accounts in which this custom line item will be applied to. * *(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. * **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** { 'CustomLineItems': [ { 'Arn': 'string', 'Name': 'string', 'ChargeDetails': { 'Flat': { 'ChargeValue': 123.0 }, 'Percentage': { 'PercentageValue': 123.0 }, 'Type': 'CREDIT'|'FEE', 'LineItemFilters': [ { 'Attribute': 'LINE_ITEM_TYPE', 'MatchOption': 'NOT_EQUAL', 'Values': [ 'SAVINGS_PLAN_NEGATION', ] }, ] }, 'CurrencyCode': 'USD'|'CNY', 'Description': 'string', 'ProductCode': 'string', 'BillingGroupArn': 'string', 'CreationTime': 123, 'LastModifiedTime': 123, 'AssociationSize': 123, 'AccountId': 'string' }, ], } **Response Structure** * *(dict) --* * **CustomLineItems** *(list) --* A list of "FreeFormLineItemListElements" received. * *(dict) --* A representation of a custom line item. * **Arn** *(string) --* The Amazon Resource Names (ARNs) for custom line items. * **Name** *(string) --* The custom line item's name. * **ChargeDetails** *(dict) --* A "ListCustomLineItemChargeDetails" that describes the charge details of a custom line item. * **Flat** *(dict) --* A "ListCustomLineItemFlatChargeDetails" that describes the charge details of a flat custom line item. * **ChargeValue** *(float) --* The custom line item's fixed charge value in USD. * **Percentage** *(dict) --* A "ListCustomLineItemPercentageChargeDetails" that describes the charge details of a percentage custom line item. * **PercentageValue** *(float) --* The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value. * **Type** *(string) --* The type of the custom line item that indicates whether the charge is a "fee" or "credit". * **LineItemFilters** *(list) --* A representation of the line item filter. * *(dict) --* A representation of the line item filter for your custom line item. You can use line item filters to include or exclude specific resource values from the billing group's total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plan discounts, you can update "LineItemFilter" to exclude it. * **Attribute** *(string) --* The attribute of the line item filter. This specifies what attribute that you can filter on. * **MatchOption** *(string) --* The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost. * **Values** *(list) --* The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts. * *(string) --* * **CurrencyCode** *(string) --* The custom line item's charge value currency. Only one of the valid values can be used. * **Description** *(string) --* The custom line item's description. This is shown on the Bills page in association with the charge value. * **ProductCode** *(string) --* The product code that's associated with the custom line item. * **BillingGroupArn** *(string) --* The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. * **CreationTime** *(integer) --* The time created. * **LastModifiedTime** *(integer) --* The most recent time when the custom line item was modified. * **AssociationSize** *(integer) --* The number of resources that are associated to the custom line item. * **AccountId** *(string) --* The Amazon Web Services account in which this custom line item will be applied to. BillingConductor / Paginator / ListPricingRulesAssociatedToPricingPlan ListPricingRulesAssociatedToPricingPlan *************************************** class BillingConductor.Paginator.ListPricingRulesAssociatedToPricingPlan paginator = client.get_paginator('list_pricing_rules_associated_to_pricing_plan') paginate(**kwargs) Creates an iterator that will paginate through responses from " BillingConductor.Client.list_pricing_rules_associated_to_pricin g_plan()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BillingPeriod='string', PricingPlanArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BillingPeriod** (*string*) -- The billing period for which the pricing rule associations are to be listed. * **PricingPlanArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the pricing plan for which associations are to be listed. * **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** { 'BillingPeriod': 'string', 'PricingPlanArn': 'string', 'PricingRuleArns': [ 'string', ], } **Response Structure** * *(dict) --* * **BillingPeriod** *(string) --* The billing period for which the pricing rule associations are listed. * **PricingPlanArn** *(string) --* The Amazon Resource Name (ARN) of the pricing plan for which associations are listed. * **PricingRuleArns** *(list) --* A list containing pricing rules that are associated with the requested pricing plan. * *(string) --* BillingConductor / Paginator / ListCustomLineItemVersions ListCustomLineItemVersions ************************** class BillingConductor.Paginator.ListCustomLineItemVersions paginator = client.get_paginator('list_custom_line_item_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "BillingConductor.Client.list_custom_line_item_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Arn='string', Filters={ 'BillingPeriodRange': { 'StartBillingPeriod': 'string', 'EndBillingPeriod': 'string' } }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) for the custom line item. * **Filters** (*dict*) -- A "ListCustomLineItemVersionsFilter" that specifies the billing period range in which the custom line item versions are applied. * **BillingPeriodRange** *(dict) --* The billing period range in which the custom line item version is applied. * **StartBillingPeriod** *(string) --* The inclusive start billing period that defines a billing period range where a custom line item version is applied. * **EndBillingPeriod** *(string) --* The exclusive end billing period that defines a billing period range where a custom line item version is applied. * **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** { 'CustomLineItemVersions': [ { 'Name': 'string', 'ChargeDetails': { 'Flat': { 'ChargeValue': 123.0 }, 'Percentage': { 'PercentageValue': 123.0 }, 'Type': 'CREDIT'|'FEE', 'LineItemFilters': [ { 'Attribute': 'LINE_ITEM_TYPE', 'MatchOption': 'NOT_EQUAL', 'Values': [ 'SAVINGS_PLAN_NEGATION', ] }, ] }, 'CurrencyCode': 'USD'|'CNY', 'Description': 'string', 'ProductCode': 'string', 'BillingGroupArn': 'string', 'CreationTime': 123, 'LastModifiedTime': 123, 'AssociationSize': 123, 'StartBillingPeriod': 'string', 'EndBillingPeriod': 'string', 'Arn': 'string', 'StartTime': 123, 'AccountId': 'string' }, ], } **Response Structure** * *(dict) --* * **CustomLineItemVersions** *(list) --* A list of "CustomLineItemVersionListElements" that are received. * *(dict) --* A representation of a custom line item version. * **Name** *(string) --* The name of the custom line item. * **ChargeDetails** *(dict) --* A representation of the charge details of a custom line item. * **Flat** *(dict) --* A "ListCustomLineItemFlatChargeDetails" that describes the charge details of a flat custom line item. * **ChargeValue** *(float) --* The custom line item's fixed charge value in USD. * **Percentage** *(dict) --* A "ListCustomLineItemPercentageChargeDetails" that describes the charge details of a percentage custom line item. * **PercentageValue** *(float) --* The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value. * **Type** *(string) --* The type of the custom line item that indicates whether the charge is a "fee" or "credit". * **LineItemFilters** *(list) --* A representation of the line item filter. * *(dict) --* A representation of the line item filter for your custom line item. You can use line item filters to include or exclude specific resource values from the billing group's total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plan discounts, you can update "LineItemFilter" to exclude it. * **Attribute** *(string) --* The attribute of the line item filter. This specifies what attribute that you can filter on. * **MatchOption** *(string) --* The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost. * **Values** *(list) --* The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts. * *(string) --* * **CurrencyCode** *(string) --* The charge value currency of the custom line item. * **Description** *(string) --* The description of the custom line item. * **ProductCode** *(string) --* The product code that’s associated with the custom line item. * **BillingGroupArn** *(string) --* The Amazon Resource Name (ARN) of the billing group that the custom line item applies to. * **CreationTime** *(integer) --* The time when the custom line item version was created. * **LastModifiedTime** *(integer) --* The most recent time that the custom line item version was modified. * **AssociationSize** *(integer) --* The number of resources that are associated with the custom line item. * **StartBillingPeriod** *(string) --* The start billing period of the custom line item version. * **EndBillingPeriod** *(string) --* The end billing period of the custom line item version. * **Arn** *(string) --* A list of custom line item Amazon Resource Names (ARNs) to retrieve information. * **StartTime** *(integer) --* The inclusive start time. * **AccountId** *(string) --* The Amazon Web Services account in which this custom line item will be applied to. BillingConductor / Paginator / ListPricingPlans ListPricingPlans **************** class BillingConductor.Paginator.ListPricingPlans paginator = client.get_paginator('list_pricing_plans') paginate(**kwargs) Creates an iterator that will paginate through responses from "BillingConductor.Client.list_pricing_plans()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BillingPeriod='string', Filters={ 'Arns': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BillingPeriod** (*string*) -- The preferred billing period to get pricing plan. * **Filters** (*dict*) -- A "ListPricingPlansFilter" that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information. * **Arns** *(list) --* A list of pricing plan Amazon Resource Names (ARNs) to retrieve information. * *(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. * **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** { 'BillingPeriod': 'string', 'PricingPlans': [ { 'Name': 'string', 'Arn': 'string', 'Description': 'string', 'Size': 123, 'CreationTime': 123, 'LastModifiedTime': 123 }, ], } **Response Structure** * *(dict) --* * **BillingPeriod** *(string) --* The billing period for which the described pricing plans are applicable. * **PricingPlans** *(list) --* A list of "PricingPlanListElement" retrieved. * *(dict) --* A representation of a pricing plan. * **Name** *(string) --* The name of a pricing plan. * **Arn** *(string) --* The pricing plan Amazon Resource Names (ARN). This can be used to uniquely identify a pricing plan. * **Description** *(string) --* The pricing plan description. * **Size** *(integer) --* The pricing rules count that's currently associated with this pricing plan list element. * **CreationTime** *(integer) --* The time when the pricing plan was created. * **LastModifiedTime** *(integer) --* The most recent time when the pricing plan was modified. BillingConductor / Paginator / ListPricingRules ListPricingRules **************** class BillingConductor.Paginator.ListPricingRules paginator = client.get_paginator('list_pricing_rules') paginate(**kwargs) Creates an iterator that will paginate through responses from "BillingConductor.Client.list_pricing_rules()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BillingPeriod='string', Filters={ 'Arns': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BillingPeriod** (*string*) -- The preferred billing period to get the pricing plan. * **Filters** (*dict*) -- A "DescribePricingRuleFilter" that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information. * **Arns** *(list) --* A list containing the pricing rule Amazon Resource Names (ARNs) to include in the API response. * *(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. * **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** { 'BillingPeriod': 'string', 'PricingRules': [ { 'Name': 'string', 'Arn': 'string', 'Description': 'string', 'Scope': 'GLOBAL'|'SERVICE'|'BILLING_ENTITY'|'SKU', 'Type': 'MARKUP'|'DISCOUNT'|'TIERING', 'ModifierPercentage': 123.0, 'Service': 'string', 'AssociatedPricingPlanCount': 123, 'CreationTime': 123, 'LastModifiedTime': 123, 'BillingEntity': 'string', 'Tiering': { 'FreeTier': { 'Activated': True|False } }, 'UsageType': 'string', 'Operation': 'string' }, ], } **Response Structure** * *(dict) --* * **BillingPeriod** *(string) --* The billing period for which the described pricing rules are applicable. * **PricingRules** *(list) --* A list containing the described pricing rules. * *(dict) --* A representation of a pricing rule. * **Name** *(string) --* The name of a pricing rule. * **Arn** *(string) --* The Amazon Resource Name (ARN) used to uniquely identify a pricing rule. * **Description** *(string) --* The pricing rule description. * **Scope** *(string) --* The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific. * **Type** *(string) --* The type of pricing rule. * **ModifierPercentage** *(float) --* A percentage modifier applied on the public pricing rates. * **Service** *(string) --* If the "Scope" attribute is "SERVICE", this attribute indicates which service the "PricingRule" is applicable for. * **AssociatedPricingPlanCount** *(integer) --* The pricing plans count that this pricing rule is associated with. * **CreationTime** *(integer) --* The time when the pricing rule was created. * **LastModifiedTime** *(integer) --* The most recent time when the pricing rule was modified. * **BillingEntity** *(string) --* The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace. * **Tiering** *(dict) --* The set of tiering configurations for the pricing rule. * **FreeTier** *(dict) --* The possible Amazon Web Services Free Tier configurations. * **Activated** *(boolean) --* Activate or deactivate Amazon Web Services Free Tier application. * **UsageType** *(string) --* Usage type is the unit that each service uses to measure the usage of a specific type of resource. If the "Scope" attribute is set to "SKU", this attribute indicates which usage type the "PricingRule" is modifying. For example, "USW2-BoxUsage:m2.2xlarge" describes an `` M2 High Memory Double Extra Large`` instance in the US West (Oregon) Region. "

" * **Operation** *(string) --* Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item. If the "Scope" attribute is set to "SKU", this attribute indicates which operation the "PricingRule" is modifying. For example, a value of "RunInstances:0202" indicates the operation of running an Amazon EC2 instance. BillingConductor / Paginator / ListPricingPlansAssociatedWithPricingRule ListPricingPlansAssociatedWithPricingRule ***************************************** class BillingConductor.Paginator.ListPricingPlansAssociatedWithPricingRule paginator = client.get_paginator('list_pricing_plans_associated_with_pricing_rule') paginate(**kwargs) Creates an iterator that will paginate through responses from " BillingConductor.Client.list_pricing_plans_associated_with_pric ing_rule()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BillingPeriod='string', PricingRuleArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BillingPeriod** (*string*) -- The pricing plan billing period for which associations will be listed. * **PricingRuleArn** (*string*) -- **[REQUIRED]** The pricing rule Amazon Resource Name (ARN) for which associations will be listed. * **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** { 'BillingPeriod': 'string', 'PricingRuleArn': 'string', 'PricingPlanArns': [ 'string', ], } **Response Structure** * *(dict) --* * **BillingPeriod** *(string) --* The pricing plan billing period for which associations will be listed. * **PricingRuleArn** *(string) --* The pricing rule Amazon Resource Name (ARN) for which associations will be listed. * **PricingPlanArns** *(list) --* The list containing pricing plans that are associated with the requested pricing rule. * *(string) --* BillingConductor / Paginator / ListResourcesAssociatedToCustomLineItem ListResourcesAssociatedToCustomLineItem *************************************** class BillingConductor.Paginator.ListResourcesAssociatedToCustomLineItem paginator = client.get_paginator('list_resources_associated_to_custom_line_item') paginate(**kwargs) Creates an iterator that will paginate through responses from " BillingConductor.Client.list_resources_associated_to_custom_lin e_item()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BillingPeriod='string', Arn='string', Filters={ 'Relationship': 'PARENT'|'CHILD' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BillingPeriod** (*string*) -- The billing period for which the resource associations will be listed. * **Arn** (*string*) -- **[REQUIRED]** The ARN of the custom line item for which the resource associations will be listed. * **Filters** (*dict*) -- (Optional) A "ListResourcesAssociatedToCustomLineItemFilter" that can specify the types of resources that should be retrieved. * **Relationship** *(string) --* The type of relationship between the custom line item and the associated resource. * **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** { 'Arn': 'string', 'AssociatedResources': [ { 'Arn': 'string', 'Relationship': 'PARENT'|'CHILD', 'EndBillingPeriod': 'string' }, ], } **Response Structure** * *(dict) --* * **Arn** *(string) --* The custom line item ARN for which the resource associations are listed. * **AssociatedResources** *(list) --* A list of "ListResourcesAssociatedToCustomLineItemResponseElement" for each resource association retrieved. * *(dict) --* A representation of a resource association for a custom line item. * **Arn** *(string) --* The ARN of the associated resource. * **Relationship** *(string) --* The type of relationship between the custom line item and the associated resource. * **EndBillingPeriod** *(string) --* The end billing period of the associated resource. BillingConductor / Paginator / ListBillingGroupCostReports ListBillingGroupCostReports *************************** class BillingConductor.Paginator.ListBillingGroupCostReports paginator = client.get_paginator('list_billing_group_cost_reports') paginate(**kwargs) Creates an iterator that will paginate through responses from "BillingConductor.Client.list_billing_group_cost_reports()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BillingPeriod='string', Filters={ 'BillingGroupArns': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BillingPeriod** (*string*) -- The preferred billing period for your report. * **Filters** (*dict*) -- A "ListBillingGroupCostReportsFilter" to specify billing groups to retrieve reports from. * **BillingGroupArns** *(list) --* The list of Amazon Resource Names (ARNs) used to filter billing groups to retrieve reports. * *(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. * **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** { 'BillingGroupCostReports': [ { 'Arn': 'string', 'AWSCost': 'string', 'ProformaCost': 'string', 'Margin': 'string', 'MarginPercentage': 'string', 'Currency': 'string' }, ], } **Response Structure** * *(dict) --* * **BillingGroupCostReports** *(list) --* A list of "BillingGroupCostReportElement" retrieved. * *(dict) --* A summary report of actual Amazon Web Services charges and calculated Amazon Web Services charges, based on the associated pricing plan of a billing group. * **Arn** *(string) --* The Amazon Resource Name (ARN) of a billing group. * **AWSCost** *(string) --* The actual Amazon Web Services charges for the billing group. * **ProformaCost** *(string) --* The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group. * **Margin** *(string) --* The billing group margin. * **MarginPercentage** *(string) --* The percentage of billing group margin. * **Currency** *(string) --* The displayed currency. BillingConductor / Paginator / ListBillingGroups ListBillingGroups ***************** class BillingConductor.Paginator.ListBillingGroups paginator = client.get_paginator('list_billing_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "BillingConductor.Client.list_billing_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BillingPeriod='string', Filters={ 'Arns': [ 'string', ], 'PricingPlan': 'string', 'Statuses': [ 'ACTIVE'|'PRIMARY_ACCOUNT_MISSING', ], 'AutoAssociate': True|False }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BillingPeriod** (*string*) -- The preferred billing period to get billing groups. * **Filters** (*dict*) -- A "ListBillingGroupsFilter" that specifies the billing group and pricing plan to retrieve billing group information. * **Arns** *(list) --* The list of billing group Amazon Resource Names (ARNs) to retrieve information. * *(string) --* * **PricingPlan** *(string) --* The pricing plan Amazon Resource Names (ARNs) to retrieve information. * **Statuses** *(list) --* A list of billing groups to retrieve their current status for a specific time range * *(string) --* * **AutoAssociate** *(boolean) --* Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family. * **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** { 'BillingGroups': [ { 'Name': 'string', 'Arn': 'string', 'Description': 'string', 'PrimaryAccountId': 'string', 'ComputationPreference': { 'PricingPlanArn': 'string' }, 'Size': 123, 'CreationTime': 123, 'LastModifiedTime': 123, 'Status': 'ACTIVE'|'PRIMARY_ACCOUNT_MISSING', 'StatusReason': 'string', 'AccountGrouping': { 'AutoAssociate': True|False } }, ], } **Response Structure** * *(dict) --* * **BillingGroups** *(list) --* A list of "BillingGroupListElement" retrieved. * *(dict) --* A representation of a billing group. * **Name** *(string) --* The name of the billing group. * **Arn** *(string) --* The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group. * **Description** *(string) --* The description of the billing group. * **PrimaryAccountId** *(string) --* The account ID that serves as the main account in a billing group. * **ComputationPreference** *(dict) --* The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group. * **PricingPlanArn** *(string) --* The Amazon Resource Name (ARN) of the pricing plan that's used to compute the Amazon Web Services charges for a billing group. * **Size** *(integer) --* The number of accounts in the particular billing group. * **CreationTime** *(integer) --* The time when the billing group was created. * **LastModifiedTime** *(integer) --* The most recent time when the billing group was modified. * **Status** *(string) --* The billing group status. 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. 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. BillingConductor / Client / associate_accounts associate_accounts ****************** BillingConductor.Client.associate_accounts(**kwargs) Connects an array of account IDs in a consolidated billing family to a predefined billing group. The account IDs must be a part of the consolidated billing family during the current month, and not already associated with another billing group. The maximum number of accounts that can be associated in one call is 30. See also: AWS API Documentation **Request Syntax** response = client.associate_accounts( Arn='string', AccountIds=[ 'string', ] ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs. * **AccountIds** (*list*) -- **[REQUIRED]** The associating array of account IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.ConflictException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.ServiceLimitExceededExceptio n" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / get_paginator get_paginator ************* BillingConductor.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. BillingConductor / Client / batch_disassociate_resources_from_custom_line_item batch_disassociate_resources_from_custom_line_item ************************************************** BillingConductor.Client.batch_disassociate_resources_from_custom_line_item(**kwargs) Disassociates a batch of resources from a percentage custom line item. See also: AWS API Documentation **Request Syntax** response = client.batch_disassociate_resources_from_custom_line_item( TargetArn='string', ResourceArns=[ 'string', ], BillingPeriodRange={ 'InclusiveStartBillingPeriod': 'string', 'ExclusiveEndBillingPeriod': 'string' } ) Parameters: * **TargetArn** (*string*) -- **[REQUIRED]** A percentage custom line item ARN to disassociate the resources from. * **ResourceArns** (*list*) -- **[REQUIRED]** A list containing the ARNs of resources to be disassociated. * *(string) --* * **BillingPeriodRange** (*dict*) -- The billing period range in which the custom line item request will be applied. * **InclusiveStartBillingPeriod** *(string) --* **[REQUIRED]** The inclusive start billing period that defines a billing period range where a custom line is applied. * **ExclusiveEndBillingPeriod** *(string) --* The inclusive end billing period that defines a billing period range where a custom line is applied. Return type: dict Returns: **Response Syntax** { 'SuccessfullyDisassociatedResources': [ { 'Arn': 'string', 'Error': { 'Message': 'string', 'Reason': 'INVALID_ARN'|'SERVICE_LIMIT_EXCEEDED'|'ILLEGAL_CUSTOMLINEITEM'|'INTERNAL_SERVER_EXCEPTION'|'INVALID_BILLING_PERIOD_RANGE' } }, ], 'FailedDisassociatedResources': [ { 'Arn': 'string', 'Error': { 'Message': 'string', 'Reason': 'INVALID_ARN'|'SERVICE_LIMIT_EXCEEDED'|'ILLEGAL_CUSTOMLINEITEM'|'INTERNAL_SERVER_EXCEPTION'|'INVALID_BILLING_PERIOD_RANGE' } }, ] } **Response Structure** * *(dict) --* * **SuccessfullyDisassociatedResources** *(list) --* A list of "DisassociateResourceResponseElement" for each resource that's been disassociated from a percentage custom line item successfully. * *(dict) --* A resource disassociation result for a percentage custom line item. * **Arn** *(string) --* The resource ARN that was disassociated from the custom line item. * **Error** *(dict) --* An "AssociateResourceError" that's shown if the resource disassociation fails. * **Message** *(string) --* The reason why the resource association failed. * **Reason** *(string) --* A static error code that's used to classify the type of failure. * **FailedDisassociatedResources** *(list) --* A list of "DisassociateResourceResponseElement" for each resource that failed disassociation from a percentage custom line item. * *(dict) --* A resource disassociation result for a percentage custom line item. * **Arn** *(string) --* The resource ARN that was disassociated from the custom line item. * **Error** *(dict) --* An "AssociateResourceError" that's shown if the resource disassociation fails. * **Message** *(string) --* The reason why the resource association failed. * **Reason** *(string) --* A static error code that's used to classify the type of failure. **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" BillingConductor / Client / list_pricing_rules list_pricing_rules ****************** BillingConductor.Client.list_pricing_rules(**kwargs) Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans. See also: AWS API Documentation **Request Syntax** response = client.list_pricing_rules( BillingPeriod='string', Filters={ 'Arns': [ 'string', ] }, MaxResults=123, NextToken='string' ) Parameters: * **BillingPeriod** (*string*) -- The preferred billing period to get the pricing plan. * **Filters** (*dict*) -- A "DescribePricingRuleFilter" that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information. * **Arns** *(list) --* A list containing the pricing rule Amazon Resource Names (ARNs) to include in the API response. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of pricing rules to retrieve. * **NextToken** (*string*) -- The pagination token that's used on subsequent call to get pricing rules. Return type: dict Returns: **Response Syntax** { 'BillingPeriod': 'string', 'PricingRules': [ { 'Name': 'string', 'Arn': 'string', 'Description': 'string', 'Scope': 'GLOBAL'|'SERVICE'|'BILLING_ENTITY'|'SKU', 'Type': 'MARKUP'|'DISCOUNT'|'TIERING', 'ModifierPercentage': 123.0, 'Service': 'string', 'AssociatedPricingPlanCount': 123, 'CreationTime': 123, 'LastModifiedTime': 123, 'BillingEntity': 'string', 'Tiering': { 'FreeTier': { 'Activated': True|False } }, 'UsageType': 'string', 'Operation': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BillingPeriod** *(string) --* The billing period for which the described pricing rules are applicable. * **PricingRules** *(list) --* A list containing the described pricing rules. * *(dict) --* A representation of a pricing rule. * **Name** *(string) --* The name of a pricing rule. * **Arn** *(string) --* The Amazon Resource Name (ARN) used to uniquely identify a pricing rule. * **Description** *(string) --* The pricing rule description. * **Scope** *(string) --* The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific. * **Type** *(string) --* The type of pricing rule. * **ModifierPercentage** *(float) --* A percentage modifier applied on the public pricing rates. * **Service** *(string) --* If the "Scope" attribute is "SERVICE", this attribute indicates which service the "PricingRule" is applicable for. * **AssociatedPricingPlanCount** *(integer) --* The pricing plans count that this pricing rule is associated with. * **CreationTime** *(integer) --* The time when the pricing rule was created. * **LastModifiedTime** *(integer) --* The most recent time when the pricing rule was modified. * **BillingEntity** *(string) --* The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace. * **Tiering** *(dict) --* The set of tiering configurations for the pricing rule. * **FreeTier** *(dict) --* The possible Amazon Web Services Free Tier configurations. * **Activated** *(boolean) --* Activate or deactivate Amazon Web Services Free Tier application. * **UsageType** *(string) --* Usage type is the unit that each service uses to measure the usage of a specific type of resource. If the "Scope" attribute is set to "SKU", this attribute indicates which usage type the "PricingRule" is modifying. For example, "USW2-BoxUsage:m2.2xlarge" describes an `` M2 High Memory Double Extra Large`` instance in the US West (Oregon) Region. "

" * **Operation** *(string) --* Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item. If the "Scope" attribute is set to "SKU", this attribute indicates which operation the "PricingRule" is modifying. For example, a value of "RunInstances:0202" indicates the operation of running an Amazon EC2 instance. * **NextToken** *(string) --* The pagination token that's used on subsequent calls to get pricing rules. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" BillingConductor / Client / get_billing_group_cost_report get_billing_group_cost_report ***************************** BillingConductor.Client.get_billing_group_cost_report(**kwargs) Retrieves the margin summary report, which includes the Amazon Web Services cost and charged amount (pro forma cost) by Amazon Web Service for a specific billing group. See also: AWS API Documentation **Request Syntax** response = client.get_billing_group_cost_report( Arn='string', BillingPeriodRange={ 'InclusiveStartBillingPeriod': 'string', 'ExclusiveEndBillingPeriod': 'string' }, GroupBy=[ 'PRODUCT_NAME'|'BILLING_PERIOD', ], MaxResults=123, NextToken='string' ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Number (ARN) that uniquely identifies the billing group. * **BillingPeriodRange** (*dict*) -- A time range for which the margin summary is effective. You can specify up to 12 months. * **InclusiveStartBillingPeriod** *(string) --* **[REQUIRED]** The inclusive start billing period that defines a billing period range for the margin summary. * **ExclusiveEndBillingPeriod** *(string) --* **[REQUIRED]** The exclusive end billing period that defines a billing period range for the margin summary. For example, if you choose a billing period that starts in October 2023 and ends in December 2023, the margin summary will only include data from October 2023 and November 2023. * **GroupBy** (*list*) -- A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group. For example, you can view your costs by the Amazon Web Service name or the billing period. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of margin summary reports to retrieve. * **NextToken** (*string*) -- The pagination token used on subsequent calls to get reports. Return type: dict Returns: **Response Syntax** { 'BillingGroupCostReportResults': [ { 'Arn': 'string', 'AWSCost': 'string', 'ProformaCost': 'string', 'Margin': 'string', 'MarginPercentage': 'string', 'Currency': 'string', 'Attributes': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BillingGroupCostReportResults** *(list) --* The list of margin summary reports. * *(dict) --* A paginated call to retrieve a list of summary reports of actual Amazon Web Services charges and the calculated Amazon Web Services charges, broken down by attributes. * **Arn** *(string) --* The Amazon Resource Number (ARN) that uniquely identifies the billing group. * **AWSCost** *(string) --* The actual Amazon Web Services charges for the billing group. * **ProformaCost** *(string) --* The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group. * **Margin** *(string) --* The billing group margin. * **MarginPercentage** *(string) --* The percentage of the billing group margin. * **Currency** *(string) --* The displayed currency. * **Attributes** *(list) --* The list of key-value pairs that represent the attributes by which the "BillingGroupCostReportResults" are grouped. For example, if you want the Amazon S3 service-level breakdown of a billing group for November 2023, the attributes list will contain a key-value pair of ""PRODUCT_NAME"" and ""S3"" and a key-value pair of ""BILLING_PERIOD"" and ""Nov 2023"". * *(dict) --* The key-value pair that represents the attribute by which the "BillingGroupCostReportResults" are grouped. For example, if you want a service-level breakdown for Amazon Simple Storage Service (Amazon S3) of the billing group, the attribute will be a key-value pair of ""PRODUCT_NAME"" and ""S3"". * **Key** *(string) --* The key in a key-value pair that describes the margin summary. * **Value** *(string) --* The value in a key-value pair that describes the margin summary. * **NextToken** *(string) --* The pagination token used on subsequent calls to get reports. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / update_pricing_plan update_pricing_plan ******************* BillingConductor.Client.update_pricing_plan(**kwargs) This updates an existing pricing plan. See also: AWS API Documentation **Request Syntax** response = client.update_pricing_plan( Arn='string', Name='string', Description='string' ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the pricing plan that you're updating. * **Name** (*string*) -- The name of the pricing plan. The name must be unique to each pricing plan. * **Description** (*string*) -- The description of the pricing plan. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Name': 'string', 'Description': 'string', 'Size': 123, 'LastModifiedTime': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the updated pricing plan. * **Name** *(string) --* The name of the pricing plan. The name must be unique to each pricing plan. * **Description** *(string) --* The new description for the pricing rule. * **Size** *(integer) --* The pricing rules count that's currently associated with this pricing plan list. * **LastModifiedTime** *(integer) --* The most recent time when the pricing plan was modified. **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" BillingConductor / Client / batch_associate_resources_to_custom_line_item batch_associate_resources_to_custom_line_item ********************************************* BillingConductor.Client.batch_associate_resources_to_custom_line_item(**kwargs) Associates a batch of resources to a percentage custom line item. See also: AWS API Documentation **Request Syntax** response = client.batch_associate_resources_to_custom_line_item( TargetArn='string', ResourceArns=[ 'string', ], BillingPeriodRange={ 'InclusiveStartBillingPeriod': 'string', 'ExclusiveEndBillingPeriod': 'string' } ) Parameters: * **TargetArn** (*string*) -- **[REQUIRED]** A percentage custom line item ARN to associate the resources to. * **ResourceArns** (*list*) -- **[REQUIRED]** A list containing the ARNs of the resources to be associated. * *(string) --* * **BillingPeriodRange** (*dict*) -- The billing period range in which the custom line item request will be applied. * **InclusiveStartBillingPeriod** *(string) --* **[REQUIRED]** The inclusive start billing period that defines a billing period range where a custom line is applied. * **ExclusiveEndBillingPeriod** *(string) --* The inclusive end billing period that defines a billing period range where a custom line is applied. Return type: dict Returns: **Response Syntax** { 'SuccessfullyAssociatedResources': [ { 'Arn': 'string', 'Error': { 'Message': 'string', 'Reason': 'INVALID_ARN'|'SERVICE_LIMIT_EXCEEDED'|'ILLEGAL_CUSTOMLINEITEM'|'INTERNAL_SERVER_EXCEPTION'|'INVALID_BILLING_PERIOD_RANGE' } }, ], 'FailedAssociatedResources': [ { 'Arn': 'string', 'Error': { 'Message': 'string', 'Reason': 'INVALID_ARN'|'SERVICE_LIMIT_EXCEEDED'|'ILLEGAL_CUSTOMLINEITEM'|'INTERNAL_SERVER_EXCEPTION'|'INVALID_BILLING_PERIOD_RANGE' } }, ] } **Response Structure** * *(dict) --* * **SuccessfullyAssociatedResources** *(list) --* A list of "AssociateResourceResponseElement" for each resource that's been associated to a percentage custom line item successfully. * *(dict) --* A resource association result for a percentage custom line item. * **Arn** *(string) --* The resource ARN that was associated to the custom line item. * **Error** *(dict) --* An "AssociateResourceError" that will populate if the resource association fails. * **Message** *(string) --* The reason why the resource association failed. * **Reason** *(string) --* A static error code that's used to classify the type of failure. * **FailedAssociatedResources** *(list) --* A list of "AssociateResourceResponseElement" for each resource that failed association to a percentage custom line item. * *(dict) --* A resource association result for a percentage custom line item. * **Arn** *(string) --* The resource ARN that was associated to the custom line item. * **Error** *(dict) --* An "AssociateResourceError" that will populate if the resource association fails. * **Message** *(string) --* The reason why the resource association failed. * **Reason** *(string) --* A static error code that's used to classify the type of failure. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.ConflictException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.ServiceLimitExceededExceptio n" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / update_custom_line_item update_custom_line_item *********************** BillingConductor.Client.update_custom_line_item(**kwargs) Update an existing custom line item in the current or previous billing period. See also: AWS API Documentation **Request Syntax** response = client.update_custom_line_item( Arn='string', Name='string', Description='string', ChargeDetails={ 'Flat': { 'ChargeValue': 123.0 }, 'Percentage': { 'PercentageValue': 123.0 }, 'LineItemFilters': [ { 'Attribute': 'LINE_ITEM_TYPE', 'MatchOption': 'NOT_EQUAL', 'Values': [ 'SAVINGS_PLAN_NEGATION', ] }, ] }, BillingPeriodRange={ 'InclusiveStartBillingPeriod': 'string', 'ExclusiveEndBillingPeriod': 'string' } ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The ARN of the custom line item to be updated. * **Name** (*string*) -- The new name for the custom line item. * **Description** (*string*) -- The new line item description of the custom line item. * **ChargeDetails** (*dict*) -- A "ListCustomLineItemChargeDetails" containing the new charge details for the custom line item. * **Flat** *(dict) --* An "UpdateCustomLineItemFlatChargeDetails" that describes the new charge details of a flat custom line item. * **ChargeValue** *(float) --* **[REQUIRED]** The custom line item's new fixed charge value in USD. * **Percentage** *(dict) --* An "UpdateCustomLineItemPercentageChargeDetails" that describes the new charge details of a percentage custom line item. * **PercentageValue** *(float) --* **[REQUIRED]** The custom line item's new percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value. * **LineItemFilters** *(list) --* A representation of the line item filter. * *(dict) --* A representation of the line item filter for your custom line item. You can use line item filters to include or exclude specific resource values from the billing group's total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plan discounts, you can update "LineItemFilter" to exclude it. * **Attribute** *(string) --* **[REQUIRED]** The attribute of the line item filter. This specifies what attribute that you can filter on. * **MatchOption** *(string) --* **[REQUIRED]** The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost. * **Values** *(list) --* **[REQUIRED]** The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts. * *(string) --* * **BillingPeriodRange** (*dict*) -- The billing period range in which the custom line item request will be applied. * **InclusiveStartBillingPeriod** *(string) --* **[REQUIRED]** The inclusive start billing period that defines a billing period range where a custom line is applied. * **ExclusiveEndBillingPeriod** *(string) --* The inclusive end billing period that defines a billing period range where a custom line is applied. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'BillingGroupArn': 'string', 'Name': 'string', 'Description': 'string', 'ChargeDetails': { 'Flat': { 'ChargeValue': 123.0 }, 'Percentage': { 'PercentageValue': 123.0 }, 'Type': 'CREDIT'|'FEE', 'LineItemFilters': [ { 'Attribute': 'LINE_ITEM_TYPE', 'MatchOption': 'NOT_EQUAL', 'Values': [ 'SAVINGS_PLAN_NEGATION', ] }, ] }, 'LastModifiedTime': 123, 'AssociationSize': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN of the successfully updated custom line item. * **BillingGroupArn** *(string) --* The ARN of the billing group that the custom line item is applied to. * **Name** *(string) --* The name of the successfully updated custom line item. * **Description** *(string) --* The description of the successfully updated custom line item. * **ChargeDetails** *(dict) --* A "ListCustomLineItemChargeDetails" containing the charge details of the successfully updated custom line item. * **Flat** *(dict) --* A "ListCustomLineItemFlatChargeDetails" that describes the charge details of a flat custom line item. * **ChargeValue** *(float) --* The custom line item's fixed charge value in USD. * **Percentage** *(dict) --* A "ListCustomLineItemPercentageChargeDetails" that describes the charge details of a percentage custom line item. * **PercentageValue** *(float) --* The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value. * **Type** *(string) --* The type of the custom line item that indicates whether the charge is a "fee" or "credit". * **LineItemFilters** *(list) --* A representation of the line item filter. * *(dict) --* A representation of the line item filter for your custom line item. You can use line item filters to include or exclude specific resource values from the billing group's total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plan discounts, you can update "LineItemFilter" to exclude it. * **Attribute** *(string) --* The attribute of the line item filter. This specifies what attribute that you can filter on. * **MatchOption** *(string) --* The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost. * **Values** *(list) --* The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts. * *(string) --* * **LastModifiedTime** *(integer) --* The most recent time when the custom line item was modified. * **AssociationSize** *(integer) --* The number of resources that are associated to the custom line item. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / create_custom_line_item create_custom_line_item *********************** BillingConductor.Client.create_custom_line_item(**kwargs) Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount. See also: AWS API Documentation **Request Syntax** response = client.create_custom_line_item( ClientToken='string', Name='string', Description='string', BillingGroupArn='string', BillingPeriodRange={ 'InclusiveStartBillingPeriod': 'string', 'ExclusiveEndBillingPeriod': 'string' }, Tags={ 'string': 'string' }, ChargeDetails={ 'Flat': { 'ChargeValue': 123.0 }, 'Percentage': { 'PercentageValue': 123.0, 'AssociatedValues': [ 'string', ] }, 'Type': 'CREDIT'|'FEE', 'LineItemFilters': [ { 'Attribute': 'LINE_ITEM_TYPE', 'MatchOption': 'NOT_EQUAL', 'Values': [ 'SAVINGS_PLAN_NEGATION', ] }, ] }, AccountId='string' ) Parameters: * **ClientToken** (*string*) -- The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. This field is autopopulated if not provided. * **Name** (*string*) -- **[REQUIRED]** The name of the custom line item. * **Description** (*string*) -- **[REQUIRED]** The description of the custom line item. This is shown on the Bills page in association with the charge value. * **BillingGroupArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. * **BillingPeriodRange** (*dict*) -- A time range for which the custom line item is effective. * **InclusiveStartBillingPeriod** *(string) --* **[REQUIRED]** The inclusive start billing period that defines a billing period range where a custom line is applied. * **ExclusiveEndBillingPeriod** *(string) --* The inclusive end billing period that defines a billing period range where a custom line is applied. * **Tags** (*dict*) -- A map that contains tag keys and tag values that are attached to a custom line item. * *(string) --* * *(string) --* * **ChargeDetails** (*dict*) -- **[REQUIRED]** A "CustomLineItemChargeDetails" that describes the charge details for a custom line item. * **Flat** *(dict) --* A "CustomLineItemFlatChargeDetails" that describes the charge details of a flat custom line item. * **ChargeValue** *(float) --* **[REQUIRED]** The custom line item's fixed charge value in USD. * **Percentage** *(dict) --* A "CustomLineItemPercentageChargeDetails" that describes the charge details of a percentage custom line item. * **PercentageValue** *(float) --* **[REQUIRED]** The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value. * **AssociatedValues** *(list) --* A list of resource ARNs to associate to the percentage custom line item. * *(string) --* * **Type** *(string) --* **[REQUIRED]** The type of the custom line item that indicates whether the charge is a fee or credit. * **LineItemFilters** *(list) --* A representation of the line item filter. * *(dict) --* A representation of the line item filter for your custom line item. You can use line item filters to include or exclude specific resource values from the billing group's total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plan discounts, you can update "LineItemFilter" to exclude it. * **Attribute** *(string) --* **[REQUIRED]** The attribute of the line item filter. This specifies what attribute that you can filter on. * **MatchOption** *(string) --* **[REQUIRED]** The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost. * **Values** *(list) --* **[REQUIRED]** The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts. * *(string) --* * **AccountId** (*string*) -- The Amazon Web Services account in which this custom line item will be applied to. Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the created custom line item. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.ConflictException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.ServiceLimitExceededExceptio n" * "BillingConductor.Client.exceptions.InternalServerException" BillingConductor / Client / can_paginate can_paginate ************ BillingConductor.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. BillingConductor / Client / list_pricing_plans list_pricing_plans ****************** BillingConductor.Client.list_pricing_plans(**kwargs) A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used. See also: AWS API Documentation **Request Syntax** response = client.list_pricing_plans( BillingPeriod='string', Filters={ 'Arns': [ 'string', ] }, MaxResults=123, NextToken='string' ) Parameters: * **BillingPeriod** (*string*) -- The preferred billing period to get pricing plan. * **Filters** (*dict*) -- A "ListPricingPlansFilter" that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information. * **Arns** *(list) --* A list of pricing plan Amazon Resource Names (ARNs) to retrieve information. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of pricing plans to retrieve. * **NextToken** (*string*) -- The pagination token that's used on subsequent call to get pricing plans. Return type: dict Returns: **Response Syntax** { 'BillingPeriod': 'string', 'PricingPlans': [ { 'Name': 'string', 'Arn': 'string', 'Description': 'string', 'Size': 123, 'CreationTime': 123, 'LastModifiedTime': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BillingPeriod** *(string) --* The billing period for which the described pricing plans are applicable. * **PricingPlans** *(list) --* A list of "PricingPlanListElement" retrieved. * *(dict) --* A representation of a pricing plan. * **Name** *(string) --* The name of a pricing plan. * **Arn** *(string) --* The pricing plan Amazon Resource Names (ARN). This can be used to uniquely identify a pricing plan. * **Description** *(string) --* The pricing plan description. * **Size** *(integer) --* The pricing rules count that's currently associated with this pricing plan list element. * **CreationTime** *(integer) --* The time when the pricing plan was created. * **LastModifiedTime** *(integer) --* The most recent time when the pricing plan was modified. * **NextToken** *(string) --* The pagination token that's used on subsequent calls to get pricing plans. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" BillingConductor / Client / disassociate_accounts disassociate_accounts ********************* BillingConductor.Client.disassociate_accounts(**kwargs) Removes the specified list of account IDs from the given billing group. See also: AWS API Documentation **Request Syntax** response = client.disassociate_accounts( Arn='string', AccountIds=[ 'string', ] ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the billing group that the array of account IDs will disassociate from. * **AccountIds** (*list*) -- **[REQUIRED]** The array of account IDs to disassociate. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the billing group that the array of account IDs is disassociated from. **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" BillingConductor / Client / list_custom_line_items list_custom_line_items ********************** BillingConductor.Client.list_custom_line_items(**kwargs) A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don't provide a billing period, the current billing period is used. See also: AWS API Documentation **Request Syntax** response = client.list_custom_line_items( BillingPeriod='string', MaxResults=123, NextToken='string', Filters={ 'Names': [ 'string', ], 'BillingGroups': [ 'string', ], 'Arns': [ 'string', ], 'AccountIds': [ 'string', ] } ) Parameters: * **BillingPeriod** (*string*) -- The preferred billing period to get custom line items (FFLIs). * **MaxResults** (*integer*) -- The maximum number of billing groups to retrieve. * **NextToken** (*string*) -- The pagination token that's used on subsequent calls to get custom line items (FFLIs). * **Filters** (*dict*) -- A "ListCustomLineItemsFilter" that specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information. * **Names** *(list) --* A list of custom line items to retrieve information. * *(string) --* * **BillingGroups** *(list) --* The billing group Amazon Resource Names (ARNs) to retrieve information. * *(string) --* * **Arns** *(list) --* A list of custom line item ARNs to retrieve information. * *(string) --* * **AccountIds** *(list) --* The Amazon Web Services accounts in which this custom line item will be applied to. * *(string) --* Return type: dict Returns: **Response Syntax** { 'CustomLineItems': [ { 'Arn': 'string', 'Name': 'string', 'ChargeDetails': { 'Flat': { 'ChargeValue': 123.0 }, 'Percentage': { 'PercentageValue': 123.0 }, 'Type': 'CREDIT'|'FEE', 'LineItemFilters': [ { 'Attribute': 'LINE_ITEM_TYPE', 'MatchOption': 'NOT_EQUAL', 'Values': [ 'SAVINGS_PLAN_NEGATION', ] }, ] }, 'CurrencyCode': 'USD'|'CNY', 'Description': 'string', 'ProductCode': 'string', 'BillingGroupArn': 'string', 'CreationTime': 123, 'LastModifiedTime': 123, 'AssociationSize': 123, 'AccountId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CustomLineItems** *(list) --* A list of "FreeFormLineItemListElements" received. * *(dict) --* A representation of a custom line item. * **Arn** *(string) --* The Amazon Resource Names (ARNs) for custom line items. * **Name** *(string) --* The custom line item's name. * **ChargeDetails** *(dict) --* A "ListCustomLineItemChargeDetails" that describes the charge details of a custom line item. * **Flat** *(dict) --* A "ListCustomLineItemFlatChargeDetails" that describes the charge details of a flat custom line item. * **ChargeValue** *(float) --* The custom line item's fixed charge value in USD. * **Percentage** *(dict) --* A "ListCustomLineItemPercentageChargeDetails" that describes the charge details of a percentage custom line item. * **PercentageValue** *(float) --* The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value. * **Type** *(string) --* The type of the custom line item that indicates whether the charge is a "fee" or "credit". * **LineItemFilters** *(list) --* A representation of the line item filter. * *(dict) --* A representation of the line item filter for your custom line item. You can use line item filters to include or exclude specific resource values from the billing group's total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plan discounts, you can update "LineItemFilter" to exclude it. * **Attribute** *(string) --* The attribute of the line item filter. This specifies what attribute that you can filter on. * **MatchOption** *(string) --* The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost. * **Values** *(list) --* The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts. * *(string) --* * **CurrencyCode** *(string) --* The custom line item's charge value currency. Only one of the valid values can be used. * **Description** *(string) --* The custom line item's description. This is shown on the Bills page in association with the charge value. * **ProductCode** *(string) --* The product code that's associated with the custom line item. * **BillingGroupArn** *(string) --* The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. * **CreationTime** *(integer) --* The time created. * **LastModifiedTime** *(integer) --* The most recent time when the custom line item was modified. * **AssociationSize** *(integer) --* The number of resources that are associated to the custom line item. * **AccountId** *(string) --* The Amazon Web Services account in which this custom line item will be applied to. * **NextToken** *(string) --* The pagination token that's used on subsequent calls to get custom line items (FFLIs). **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / associate_pricing_rules associate_pricing_rules *********************** BillingConductor.Client.associate_pricing_rules(**kwargs) Connects an array of "PricingRuleArns" to a defined "PricingPlan". The maximum number "PricingRuleArn" that can be associated in one call is 30. See also: AWS API Documentation **Request Syntax** response = client.associate_pricing_rules( Arn='string', PricingRuleArns=[ 'string', ] ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The "PricingPlanArn" that the "PricingRuleArns" are associated with. * **PricingRuleArns** (*list*) -- **[REQUIRED]** The "PricingRuleArns" that are associated with the Pricing Plan. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The "PricingPlanArn" that the "PricingRuleArns" are associated with. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.ConflictException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.ServiceLimitExceededExceptio n" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / delete_pricing_rule delete_pricing_rule ******************* BillingConductor.Client.delete_pricing_rule(**kwargs) Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN). See also: AWS API Documentation **Request Syntax** response = client.delete_pricing_rule( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the pricing rule that you are deleting. Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the deleted pricing rule. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.ConflictException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" BillingConductor / Client / disassociate_pricing_rules disassociate_pricing_rules ************************** BillingConductor.Client.disassociate_pricing_rules(**kwargs) Disassociates a list of pricing rules from a pricing plan. See also: AWS API Documentation **Request Syntax** response = client.disassociate_pricing_rules( Arn='string', PricingRuleArns=[ 'string', ] ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from. * **PricingRuleArns** (*list*) -- **[REQUIRED]** A list containing the Amazon Resource Name (ARN) of the pricing rules that will be disassociated. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the pricing plan that the pricing rules successfully disassociated from. **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" BillingConductor / Client / create_pricing_plan create_pricing_plan ******************* BillingConductor.Client.create_pricing_plan(**kwargs) Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups. See also: AWS API Documentation **Request Syntax** response = client.create_pricing_plan( ClientToken='string', Name='string', Description='string', PricingRuleArns=[ 'string', ], Tags={ 'string': 'string' } ) Parameters: * **ClientToken** (*string*) -- The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. This field is autopopulated if not provided. * **Name** (*string*) -- **[REQUIRED]** The name of the pricing plan. The names must be unique to each pricing plan. * **Description** (*string*) -- The description of the pricing plan. * **PricingRuleArns** (*list*) -- A list of Amazon Resource Names (ARNs) that define the pricing plan parameters. * *(string) --* * **Tags** (*dict*) -- A map that contains tag keys and tag values that are attached to a pricing plan. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the created pricing plan. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.ConflictException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.ServiceLimitExceededExceptio n" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / list_tags_for_resource list_tags_for_resource ********************** BillingConductor.Client.list_tags_for_resource(**kwargs) A list 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) that identifies the resource to list the tags. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Tags** *(dict) --* The tags for the resource. * *(string) --* * *(string) --* **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / list_custom_line_item_versions list_custom_line_item_versions ****************************** BillingConductor.Client.list_custom_line_item_versions(**kwargs) A paginated call to get a list of all custom line item versions. See also: AWS API Documentation **Request Syntax** response = client.list_custom_line_item_versions( Arn='string', MaxResults=123, NextToken='string', Filters={ 'BillingPeriodRange': { 'StartBillingPeriod': 'string', 'EndBillingPeriod': 'string' } } ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) for the custom line item. * **MaxResults** (*integer*) -- The maximum number of custom line item versions to retrieve. * **NextToken** (*string*) -- The pagination token that's used on subsequent calls to retrieve custom line item versions. * **Filters** (*dict*) -- A "ListCustomLineItemVersionsFilter" that specifies the billing period range in which the custom line item versions are applied. * **BillingPeriodRange** *(dict) --* The billing period range in which the custom line item version is applied. * **StartBillingPeriod** *(string) --* The inclusive start billing period that defines a billing period range where a custom line item version is applied. * **EndBillingPeriod** *(string) --* The exclusive end billing period that defines a billing period range where a custom line item version is applied. Return type: dict Returns: **Response Syntax** { 'CustomLineItemVersions': [ { 'Name': 'string', 'ChargeDetails': { 'Flat': { 'ChargeValue': 123.0 }, 'Percentage': { 'PercentageValue': 123.0 }, 'Type': 'CREDIT'|'FEE', 'LineItemFilters': [ { 'Attribute': 'LINE_ITEM_TYPE', 'MatchOption': 'NOT_EQUAL', 'Values': [ 'SAVINGS_PLAN_NEGATION', ] }, ] }, 'CurrencyCode': 'USD'|'CNY', 'Description': 'string', 'ProductCode': 'string', 'BillingGroupArn': 'string', 'CreationTime': 123, 'LastModifiedTime': 123, 'AssociationSize': 123, 'StartBillingPeriod': 'string', 'EndBillingPeriod': 'string', 'Arn': 'string', 'StartTime': 123, 'AccountId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CustomLineItemVersions** *(list) --* A list of "CustomLineItemVersionListElements" that are received. * *(dict) --* A representation of a custom line item version. * **Name** *(string) --* The name of the custom line item. * **ChargeDetails** *(dict) --* A representation of the charge details of a custom line item. * **Flat** *(dict) --* A "ListCustomLineItemFlatChargeDetails" that describes the charge details of a flat custom line item. * **ChargeValue** *(float) --* The custom line item's fixed charge value in USD. * **Percentage** *(dict) --* A "ListCustomLineItemPercentageChargeDetails" that describes the charge details of a percentage custom line item. * **PercentageValue** *(float) --* The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value. * **Type** *(string) --* The type of the custom line item that indicates whether the charge is a "fee" or "credit". * **LineItemFilters** *(list) --* A representation of the line item filter. * *(dict) --* A representation of the line item filter for your custom line item. You can use line item filters to include or exclude specific resource values from the billing group's total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plan discounts, you can update "LineItemFilter" to exclude it. * **Attribute** *(string) --* The attribute of the line item filter. This specifies what attribute that you can filter on. * **MatchOption** *(string) --* The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost. * **Values** *(list) --* The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts. * *(string) --* * **CurrencyCode** *(string) --* The charge value currency of the custom line item. * **Description** *(string) --* The description of the custom line item. * **ProductCode** *(string) --* The product code that’s associated with the custom line item. * **BillingGroupArn** *(string) --* The Amazon Resource Name (ARN) of the billing group that the custom line item applies to. * **CreationTime** *(integer) --* The time when the custom line item version was created. * **LastModifiedTime** *(integer) --* The most recent time that the custom line item version was modified. * **AssociationSize** *(integer) --* The number of resources that are associated with the custom line item. * **StartBillingPeriod** *(string) --* The start billing period of the custom line item version. * **EndBillingPeriod** *(string) --* The end billing period of the custom line item version. * **Arn** *(string) --* A list of custom line item Amazon Resource Names (ARNs) to retrieve information. * **StartTime** *(integer) --* The inclusive start time. * **AccountId** *(string) --* The Amazon Web Services account in which this custom line item will be applied to. * **NextToken** *(string) --* The pagination token that's used on subsequent calls to retrieve custom line item versions. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" BillingConductor / Client / list_pricing_plans_associated_with_pricing_rule list_pricing_plans_associated_with_pricing_rule *********************************************** BillingConductor.Client.list_pricing_plans_associated_with_pricing_rule(**kwargs) A list of the pricing plans that are associated with a pricing rule. See also: AWS API Documentation **Request Syntax** response = client.list_pricing_plans_associated_with_pricing_rule( BillingPeriod='string', PricingRuleArn='string', MaxResults=123, NextToken='string' ) Parameters: * **BillingPeriod** (*string*) -- The pricing plan billing period for which associations will be listed. * **PricingRuleArn** (*string*) -- **[REQUIRED]** The pricing rule Amazon Resource Name (ARN) for which associations will be listed. * **MaxResults** (*integer*) -- The optional maximum number of pricing rule associations to retrieve. * **NextToken** (*string*) -- The optional pagination token returned by a previous call. Return type: dict Returns: **Response Syntax** { 'BillingPeriod': 'string', 'PricingRuleArn': 'string', 'PricingPlanArns': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BillingPeriod** *(string) --* The pricing plan billing period for which associations will be listed. * **PricingRuleArn** *(string) --* The pricing rule Amazon Resource Name (ARN) for which associations will be listed. * **PricingPlanArns** *(list) --* The list containing pricing plans that are associated with the requested pricing rule. * *(string) --* * **NextToken** *(string) --* The pagination token to be used on subsequent calls. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / untag_resource untag_resource ************** BillingConductor.Client.untag_resource(**kwargs) Deletes specified tags from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to which to delete tags. * **TagKeys** (*list*) -- **[REQUIRED]** The tags to delete from the resource as a list of key-value pairs. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / get_waiter get_waiter ********** BillingConductor.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" BillingConductor / Client / delete_custom_line_item delete_custom_line_item *********************** BillingConductor.Client.delete_custom_line_item(**kwargs) Deletes the custom line item identified by the given ARN in the current, or previous billing period. See also: AWS API Documentation **Request Syntax** response = client.delete_custom_line_item( Arn='string', BillingPeriodRange={ 'InclusiveStartBillingPeriod': 'string', 'ExclusiveEndBillingPeriod': 'string' } ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The ARN of the custom line item to be deleted. * **BillingPeriodRange** (*dict*) -- The billing period range in which the custom line item request will be applied. * **InclusiveStartBillingPeriod** *(string) --* **[REQUIRED]** The inclusive start billing period that defines a billing period range where a custom line is applied. * **ExclusiveEndBillingPeriod** *(string) --* The inclusive end billing period that defines a billing period range where a custom line is applied. Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN of the deleted custom line item. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.ConflictException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" BillingConductor / Client / create_billing_group create_billing_group ******************** BillingConductor.Client.create_billing_group(**kwargs) Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation. See also: AWS API Documentation **Request Syntax** response = client.create_billing_group( ClientToken='string', Name='string', AccountGrouping={ 'LinkedAccountIds': [ 'string', ], 'AutoAssociate': True|False }, ComputationPreference={ 'PricingPlanArn': 'string' }, PrimaryAccountId='string', Description='string', Tags={ 'string': 'string' } ) Parameters: * **ClientToken** (*string*) -- The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. This field is autopopulated if not provided. * **Name** (*string*) -- **[REQUIRED]** The billing group name. The names must be unique. * **AccountGrouping** (*dict*) -- **[REQUIRED]** The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated billing family. * **LinkedAccountIds** *(list) --* **[REQUIRED]** The account IDs that make up the billing group. Account IDs must be a part of the consolidated billing family, and not associated with another billing group. * *(string) --* * **AutoAssociate** *(boolean) --* Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family. * **ComputationPreference** (*dict*) -- **[REQUIRED]** 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. * **PrimaryAccountId** (*string*) -- The account ID that serves as the main account in a billing group. * **Description** (*string*) -- The description of the billing group. * **Tags** (*dict*) -- A map that contains tag keys and tag values that are attached to a billing group. This feature isn't available during the beta. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the created billing group. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.ConflictException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.ServiceLimitExceededExceptio n" * "BillingConductor.Client.exceptions.InternalServerException" BillingConductor / Client / list_pricing_rules_associated_to_pricing_plan list_pricing_rules_associated_to_pricing_plan ********************************************* BillingConductor.Client.list_pricing_rules_associated_to_pricing_plan(**kwargs) Lists the pricing rules that are associated with a pricing plan. See also: AWS API Documentation **Request Syntax** response = client.list_pricing_rules_associated_to_pricing_plan( BillingPeriod='string', PricingPlanArn='string', MaxResults=123, NextToken='string' ) Parameters: * **BillingPeriod** (*string*) -- The billing period for which the pricing rule associations are to be listed. * **PricingPlanArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the pricing plan for which associations are to be listed. * **MaxResults** (*integer*) -- The optional maximum number of pricing rule associations to retrieve. * **NextToken** (*string*) -- The optional pagination token returned by a previous call. Return type: dict Returns: **Response Syntax** { 'BillingPeriod': 'string', 'PricingPlanArn': 'string', 'PricingRuleArns': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BillingPeriod** *(string) --* The billing period for which the pricing rule associations are listed. * **PricingPlanArn** *(string) --* The Amazon Resource Name (ARN) of the pricing plan for which associations are listed. * **PricingRuleArns** *(list) --* A list containing pricing rules that are associated with the requested pricing plan. * *(string) --* * **NextToken** *(string) --* The pagination token to be used on subsequent calls. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / list_billing_group_cost_reports list_billing_group_cost_reports ******************************* BillingConductor.Client.list_billing_group_cost_reports(**kwargs) A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group. See also: AWS API Documentation **Request Syntax** response = client.list_billing_group_cost_reports( BillingPeriod='string', MaxResults=123, NextToken='string', Filters={ 'BillingGroupArns': [ 'string', ] } ) Parameters: * **BillingPeriod** (*string*) -- The preferred billing period for your report. * **MaxResults** (*integer*) -- The maximum number of reports to retrieve. * **NextToken** (*string*) -- The pagination token that's used on subsequent calls to get reports. * **Filters** (*dict*) -- A "ListBillingGroupCostReportsFilter" to specify billing groups to retrieve reports from. * **BillingGroupArns** *(list) --* The list of Amazon Resource Names (ARNs) used to filter billing groups to retrieve reports. * *(string) --* Return type: dict Returns: **Response Syntax** { 'BillingGroupCostReports': [ { 'Arn': 'string', 'AWSCost': 'string', 'ProformaCost': 'string', 'Margin': 'string', 'MarginPercentage': 'string', 'Currency': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BillingGroupCostReports** *(list) --* A list of "BillingGroupCostReportElement" retrieved. * *(dict) --* A summary report of actual Amazon Web Services charges and calculated Amazon Web Services charges, based on the associated pricing plan of a billing group. * **Arn** *(string) --* The Amazon Resource Name (ARN) of a billing group. * **AWSCost** *(string) --* The actual Amazon Web Services charges for the billing group. * **ProformaCost** *(string) --* The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group. * **Margin** *(string) --* The billing group margin. * **MarginPercentage** *(string) --* The percentage of billing group margin. * **Currency** *(string) --* The displayed currency. * **NextToken** *(string) --* The pagination token that's used on subsequent calls to get reports. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / create_pricing_rule create_pricing_rule ******************* BillingConductor.Client.create_pricing_rule(**kwargs) Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans. See also: AWS API Documentation **Request Syntax** response = client.create_pricing_rule( ClientToken='string', Name='string', Description='string', Scope='GLOBAL'|'SERVICE'|'BILLING_ENTITY'|'SKU', Type='MARKUP'|'DISCOUNT'|'TIERING', ModifierPercentage=123.0, Service='string', Tags={ 'string': 'string' }, BillingEntity='string', Tiering={ 'FreeTier': { 'Activated': True|False } }, UsageType='string', Operation='string' ) Parameters: * **ClientToken** (*string*) -- The token that's needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. This field is autopopulated if not provided. * **Name** (*string*) -- **[REQUIRED]** The pricing rule name. The names must be unique to each pricing rule. * **Description** (*string*) -- The pricing rule description. * **Scope** (*string*) -- **[REQUIRED]** The scope of pricing rule that indicates if it's globally applicable, or it's service-specific. * **Type** (*string*) -- **[REQUIRED]** The type of pricing rule. * **ModifierPercentage** (*float*) -- A percentage modifier that's applied on the public pricing rates. * **Service** (*string*) -- If the "Scope" attribute is set to "SERVICE" or "SKU", the attribute indicates which service the "PricingRule" is applicable for. * **Tags** (*dict*) -- A map that contains tag keys and tag values that are attached to a pricing rule. * *(string) --* * *(string) --* * **BillingEntity** (*string*) -- The seller of services provided by Amazon Web Services, their affiliates, or third- party providers selling services via Amazon Web Services Marketplace. * **Tiering** (*dict*) -- The set of tiering configurations for the pricing rule. * **FreeTier** *(dict) --* **[REQUIRED]** The possible Amazon Web Services Free Tier configurations. * **Activated** *(boolean) --* **[REQUIRED]** Activate or deactivate Amazon Web Services Free Tier. * **UsageType** (*string*) -- Usage type is the unit that each service uses to measure the usage of a specific type of resource. If the "Scope" attribute is set to "SKU", this attribute indicates which usage type the "PricingRule" is modifying. For example, "USW2-BoxUsage:m2.2xlarge" describes an `` M2 High Memory Double Extra Large`` instance in the US West (Oregon) Region. "

" * **Operation** (*string*) -- Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item. If the "Scope" attribute is set to "SKU", this attribute indicates which operation the "PricingRule" is modifying. For example, a value of "RunInstances:0202" indicates the operation of running an Amazon EC2 instance. Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the created pricing rule. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.ConflictException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.ServiceLimitExceededExceptio n" * "BillingConductor.Client.exceptions.InternalServerException" BillingConductor / Client / delete_pricing_plan delete_pricing_plan ******************* BillingConductor.Client.delete_pricing_plan(**kwargs) Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully. See also: AWS API Documentation **Request Syntax** response = client.delete_pricing_plan( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the pricing plan that you're deleting. Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the deleted pricing plan. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.ConflictException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" BillingConductor / Client / list_resources_associated_to_custom_line_item list_resources_associated_to_custom_line_item ********************************************* BillingConductor.Client.list_resources_associated_to_custom_line_item(**kwargs) List the resources that are associated to a custom line item. See also: AWS API Documentation **Request Syntax** response = client.list_resources_associated_to_custom_line_item( BillingPeriod='string', Arn='string', MaxResults=123, NextToken='string', Filters={ 'Relationship': 'PARENT'|'CHILD' } ) Parameters: * **BillingPeriod** (*string*) -- The billing period for which the resource associations will be listed. * **Arn** (*string*) -- **[REQUIRED]** The ARN of the custom line item for which the resource associations will be listed. * **MaxResults** (*integer*) -- (Optional) The maximum number of resource associations to be retrieved. * **NextToken** (*string*) -- (Optional) The pagination token that's returned by a previous request. * **Filters** (*dict*) -- (Optional) A "ListResourcesAssociatedToCustomLineItemFilter" that can specify the types of resources that should be retrieved. * **Relationship** *(string) --* The type of relationship between the custom line item and the associated resource. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'AssociatedResources': [ { 'Arn': 'string', 'Relationship': 'PARENT'|'CHILD', 'EndBillingPeriod': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The custom line item ARN for which the resource associations are listed. * **AssociatedResources** *(list) --* A list of "ListResourcesAssociatedToCustomLineItemResponseElement" for each resource association retrieved. * *(dict) --* A representation of a resource association for a custom line item. * **Arn** *(string) --* The ARN of the associated resource. * **Relationship** *(string) --* The type of relationship between the custom line item and the associated resource. * **EndBillingPeriod** *(string) --* The end billing period of the associated resource. * **NextToken** *(string) --* The pagination token to be used in subsequent requests to retrieve additional results. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / close close ***** BillingConductor.Client.close() Closes underlying endpoint connections. BillingConductor / Client / update_pricing_rule update_pricing_rule ******************* BillingConductor.Client.update_pricing_rule(**kwargs) Updates an existing pricing rule. See also: AWS API Documentation **Request Syntax** response = client.update_pricing_rule( Arn='string', Name='string', Description='string', Type='MARKUP'|'DISCOUNT'|'TIERING', ModifierPercentage=123.0, Tiering={ 'FreeTier': { 'Activated': True|False } } ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the pricing rule to update. * **Name** (*string*) -- The new name of the pricing rule. The name must be unique to each pricing rule. * **Description** (*string*) -- The new description for the pricing rule. * **Type** (*string*) -- The new pricing rule type. * **ModifierPercentage** (*float*) -- The new modifier to show pricing plan rates as a percentage. * **Tiering** (*dict*) -- The set of tiering configurations for the pricing rule. * **FreeTier** *(dict) --* **[REQUIRED]** The possible Amazon Web Services Free Tier configurations. * **Activated** *(boolean) --* **[REQUIRED]** Activate or deactivate application of Amazon Web Services Free Tier. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Name': 'string', 'Description': 'string', 'Scope': 'GLOBAL'|'SERVICE'|'BILLING_ENTITY'|'SKU', 'Type': 'MARKUP'|'DISCOUNT'|'TIERING', 'ModifierPercentage': 123.0, 'Service': 'string', 'AssociatedPricingPlanCount': 123, 'LastModifiedTime': 123, 'BillingEntity': 'string', 'Tiering': { 'FreeTier': { 'Activated': True|False } }, 'UsageType': 'string', 'Operation': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the successfully updated pricing rule. * **Name** *(string) --* The new name of the pricing rule. The name must be unique to each pricing rule. * **Description** *(string) --* The new description for the pricing rule. * **Scope** *(string) --* The scope of pricing rule that indicates if it's globally applicable, or it's service-specific. * **Type** *(string) --* The new pricing rule type. * **ModifierPercentage** *(float) --* The new modifier to show pricing plan rates as a percentage. * **Service** *(string) --* If the "Scope" attribute is set to "SERVICE", the attribute indicates which service the "PricingRule" is applicable for. * **AssociatedPricingPlanCount** *(integer) --* The pricing plans count that this pricing rule is associated with. * **LastModifiedTime** *(integer) --* The most recent time the pricing rule was modified. * **BillingEntity** *(string) --* The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace. * **Tiering** *(dict) --* The set of tiering configurations for the pricing rule. * **FreeTier** *(dict) --* The possible Amazon Web Services Free Tier configurations. * **Activated** *(boolean) --* Activate or deactivate application of Amazon Web Services Free Tier. * **UsageType** *(string) --* Usage type is the unit that each service uses to measure the usage of a specific type of resource. If the "Scope" attribute is set to "SKU", this attribute indicates which usage type the "PricingRule" is modifying. For example, "USW2-BoxUsage:m2.2xlarge" describes an "M2 High Memory Double Extra Large" instance in the US West (Oregon) Region. * **Operation** *(string) --* Operation refers to the specific Amazon Web Services covered by this line item. This describes the specific usage of the line item. If the "Scope" attribute is set to "SKU", this attribute indicates which operation the "PricingRule" is modifying. For example, a value of "RunInstances:0202" indicates the operation of running an Amazon EC2 instance. **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" BillingConductor / Client / delete_billing_group delete_billing_group ******************** BillingConductor.Client.delete_billing_group(**kwargs) Deletes a billing group. See also: AWS API Documentation **Request Syntax** response = client.delete_billing_group( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the billing group that you're deleting. Return type: dict Returns: **Response Syntax** { 'Arn': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the deleted billing group. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" BillingConductor / Client / tag_resource tag_resource ************ BillingConductor.Client.tag_resource(**kwargs) Associates the specified tags to a resource with the specified "resourceArn". If existing tags on a resource are not specified in the request parameters, they are not changed. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to which to add tags. * **Tags** (*dict*) -- **[REQUIRED]** The tags to add to the resource as a list of key-value pairs. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" 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" 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** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException" BillingConductor / Client / list_billing_groups list_billing_groups ******************* BillingConductor.Client.list_billing_groups(**kwargs) A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used. See also: AWS API Documentation **Request Syntax** response = client.list_billing_groups( BillingPeriod='string', MaxResults=123, NextToken='string', Filters={ 'Arns': [ 'string', ], 'PricingPlan': 'string', 'Statuses': [ 'ACTIVE'|'PRIMARY_ACCOUNT_MISSING', ], 'AutoAssociate': True|False } ) Parameters: * **BillingPeriod** (*string*) -- The preferred billing period to get billing groups. * **MaxResults** (*integer*) -- The maximum number of billing groups to retrieve. * **NextToken** (*string*) -- The pagination token that's used on subsequent calls to get billing groups. * **Filters** (*dict*) -- A "ListBillingGroupsFilter" that specifies the billing group and pricing plan to retrieve billing group information. * **Arns** *(list) --* The list of billing group Amazon Resource Names (ARNs) to retrieve information. * *(string) --* * **PricingPlan** *(string) --* The pricing plan Amazon Resource Names (ARNs) to retrieve information. * **Statuses** *(list) --* A list of billing groups to retrieve their current status for a specific time range * *(string) --* * **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** { 'BillingGroups': [ { 'Name': 'string', 'Arn': 'string', 'Description': 'string', 'PrimaryAccountId': 'string', 'ComputationPreference': { 'PricingPlanArn': 'string' }, 'Size': 123, 'CreationTime': 123, 'LastModifiedTime': 123, 'Status': 'ACTIVE'|'PRIMARY_ACCOUNT_MISSING', 'StatusReason': 'string', 'AccountGrouping': { 'AutoAssociate': True|False } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BillingGroups** *(list) --* A list of "BillingGroupListElement" retrieved. * *(dict) --* A representation of a billing group. * **Name** *(string) --* The name of the billing group. * **Arn** *(string) --* The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group. * **Description** *(string) --* The description of the billing group. * **PrimaryAccountId** *(string) --* The account ID that serves as the main account in a billing group. * **ComputationPreference** *(dict) --* The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group. * **PricingPlanArn** *(string) --* The Amazon Resource Name (ARN) of the pricing plan that's used to compute the Amazon Web Services charges for a billing group. * **Size** *(integer) --* The number of accounts in the particular billing group. * **CreationTime** *(integer) --* The time when the billing group was created. * **LastModifiedTime** *(integer) --* The most recent time when the billing group was modified. * **Status** *(string) --* The billing group status. 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. * **NextToken** *(string) --* The pagination token that's used on subsequent calls to get billing groups. **Exceptions** * "BillingConductor.Client.exceptions.ThrottlingException" * "BillingConductor.Client.exceptions.AccessDeniedException" * "BillingConductor.Client.exceptions.ValidationException" * "BillingConductor.Client.exceptions.InternalServerException" * "BillingConductor.Client.exceptions.ResourceNotFoundException"