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 pro forma 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.

client = session.create_client('billingconductor')

These are the available methods:

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

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

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

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

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.
close()

Closes underlying endpoint connections.

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',
        ]
    },
    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 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) --
  • 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

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'
    }
)
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.

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

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

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',
    Type='MARKUP'|'DISCOUNT'|'TIERING',
    ModifierPercentage=123.0,
    Service='string',
    Tags={
        'string': 'string'
    },
    BillingEntity='string',
    Tiering={
        'FreeTier': {
            'Activated': True|False
        }
    }
)
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 , 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.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the created pricing rule.

Exceptions

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

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) --

      Then ARN of the deleted custom line item.

Exceptions

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

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

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

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

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
L{botocore.paginate.Paginator}
Returns
A paginator object.
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
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'
    },
    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.

  • 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

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

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'
    }
)
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.

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'
        },
    ],
    '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.

    • NextToken (string) --

      The pagination token that's used on subsequent calls to get billing groups.

Exceptions

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'
            },
            'CurrencyCode': 'USD'|'CNY',
            'Description': 'string',
            'ProductCode': 'string',
            'BillingGroupArn': 'string',
            'CreationTime': 123,
            'LastModifiedTime': 123,
            'AssociationSize': 123,
            'StartBillingPeriod': 'string',
            'EndBillingPeriod': '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 .

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

    • NextToken (string) --

      The pagination token that's used on subsequent calls to retrieve custom line item versions.

Exceptions

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',
        ]
    }
)
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) --
Return type

dict

Returns

Response Syntax

{
    'CustomLineItems': [
        {
            'Arn': 'string',
            'Name': 'string',
            'ChargeDetails': {
                'Flat': {
                    'ChargeValue': 123.0
                },
                'Percentage': {
                    'PercentageValue': 123.0
                },
                'Type': 'CREDIT'|'FEE'
            },
            'CurrencyCode': 'USD'|'CNY',
            'Description': 'string',
            'ProductCode': 'string',
            'BillingGroupArn': 'string',
            'CreationTime': 123,
            'LastModifiedTime': 123,
            'AssociationSize': 123
        },
    ],
    '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 .

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

    • NextToken (string) --

      The pagination token that's used on subsequent calls to get custom line items (FFLIs).

Exceptions

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

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

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',
            'Type': 'MARKUP'|'DISCOUNT'|'TIERING',
            'ModifierPercentage': 123.0,
            'Service': 'string',
            'AssociatedPricingPlanCount': 123,
            'CreationTime': 123,
            'LastModifiedTime': 123,
            'BillingEntity': 'string',
            'Tiering': {
                'FreeTier': {
                    'Activated': True|False
                }
            }
        },
    ],
    '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.

    • NextToken (string) --

      The pagination token that's used on subsequent calls to get pricing rules.

Exceptions

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

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

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

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

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

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'
)
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.
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'
}

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.

Exceptions

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
        }
    },
    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.

  • 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'
    },
    '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 .

    • 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

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

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',
    'Type': 'MARKUP'|'DISCOUNT'|'TIERING',
    'ModifierPercentage': 123.0,
    'Service': 'string',
    'AssociatedPricingPlanCount': 123,
    'LastModifiedTime': 123,
    'BillingEntity': 'string',
    'Tiering': {
        'FreeTier': {
            'Activated': True|False
        }
    }
}

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.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class BillingConductor.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class BillingConductor.Client.exceptions.ConflictException

You can cause an inconsistent state by updating or deleting a resource.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'Reason': 'RESOURCE_NAME_CONFLICT'|'PRICING_RULE_IN_PRICING_PLAN_CONFLICT'|'PRICING_PLAN_ATTACHED_TO_BILLING_GROUP_DELETE_CONFLICT'|'PRICING_RULE_ATTACHED_TO_PRICING_PLAN_DELETE_CONFLICT'|'WRITE_CONFLICT_RETRY',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You can cause an inconsistent state by updating or deleting a resource.

    • Message (string) --

    • ResourceId (string) --

      Identifier of the resource in use.

    • ResourceType (string) --

      Type of the resource in use.

    • Reason (string) --

      Reason for the inconsistent state.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class BillingConductor.Client.exceptions.InternalServerException

An unexpected error occurred while processing a request.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'RetryAfterSeconds': 123,
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An unexpected error occurred while processing a request.

    • Message (string) --

    • RetryAfterSeconds (integer) --

      Number of seconds you can retry after the call.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class BillingConductor.Client.exceptions.ResourceNotFoundException

The request references a resource that doesn't exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request references a resource that doesn't exist.

    • Message (string) --

    • ResourceId (string) --

      Resource identifier that was not found.

    • ResourceType (string) --

      Resource type that was not found.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class BillingConductor.Client.exceptions.ServiceLimitExceededException

The request would cause a service limit to exceed.

Example

try:
  ...
except client.exceptions.ServiceLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'LimitCode': 'string',
    'ServiceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request would cause a service limit to exceed.

    • Message (string) --

    • ResourceId (string) --

      Identifier of the resource affected.

    • ResourceType (string) --

      Type of the resource affected.

    • LimitCode (string) --

      The unique code identifier of the service limit that is being exceeded.

    • ServiceCode (string) --

      The unique code for the service of the limit that is being exceeded.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class BillingConductor.Client.exceptions.ThrottlingException

The request was denied due to request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'RetryAfterSeconds': 123,
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied due to request throttling.

    • Message (string) --

    • RetryAfterSeconds (integer) --

      Number of seconds you can safely retry after the call.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class BillingConductor.Client.exceptions.ValidationException

The input doesn't match with the constraints specified by Amazon Web Services services.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Reason': 'UNKNOWN_OPERATION'|'CANNOT_PARSE'|'FIELD_VALIDATION_FAILED'|'OTHER'|'PRIMARY_NOT_ASSOCIATED'|'PRIMARY_CANNOT_DISASSOCIATE'|'ACCOUNTS_NOT_ASSOCIATED'|'ACCOUNTS_ALREADY_ASSOCIATED'|'ILLEGAL_PRIMARY_ACCOUNT'|'ILLEGAL_ACCOUNTS'|'MISMATCHED_BILLINGGROUP_ARN'|'MISSING_BILLINGGROUP'|'MISMATCHED_CUSTOMLINEITEM_ARN'|'ILLEGAL_BILLING_PERIOD'|'ILLEGAL_BILLING_PERIOD_RANGE'|'TOO_MANY_ACCOUNTS_IN_REQUEST'|'DUPLICATE_ACCOUNT'|'INVALID_BILLING_GROUP_STATUS'|'MISMATCHED_PRICINGPLAN_ARN'|'MISSING_PRICINGPLAN'|'MISMATCHED_PRICINGRULE_ARN'|'DUPLICATE_PRICINGRULE_ARNS'|'ILLEGAL_EXPRESSION'|'ILLEGAL_SCOPE'|'ILLEGAL_SERVICE'|'PRICINGRULES_NOT_EXIST'|'PRICINGRULES_ALREADY_ASSOCIATED'|'PRICINGRULES_NOT_ASSOCIATED'|'INVALID_TIME_RANGE'|'INVALID_BILLINGVIEW_ARN'|'MISMATCHED_BILLINGVIEW_ARN'|'ILLEGAL_CUSTOMLINEITEM'|'MISSING_CUSTOMLINEITEM'|'ILLEGAL_CUSTOMLINEITEM_UPDATE'|'TOO_MANY_CUSTOMLINEITEMS_IN_REQUEST'|'ILLEGAL_CHARGE_DETAILS'|'ILLEGAL_UPDATE_CHARGE_DETAILS'|'INVALID_ARN'|'ILLEGAL_RESOURCE_ARNS'|'ILLEGAL_CUSTOMLINEITEM_MODIFICATION'|'MISSING_LINKED_ACCOUNT_IDS'|'MULTIPLE_LINKED_ACCOUNT_IDS'|'MISSING_PRICING_PLAN_ARN'|'MULTIPLE_PRICING_PLAN_ARN'|'ILLEGAL_CHILD_ASSOCIATE_RESOURCE'|'CUSTOM_LINE_ITEM_ASSOCIATION_EXISTS'|'INVALID_BILLING_GROUP'|'INVALID_BILLING_PERIOD_FOR_OPERATION'|'ILLEGAL_BILLING_ENTITY'|'ILLEGAL_MODIFIER_PERCENTAGE'|'ILLEGAL_TYPE'|'ILLEGAL_ENDED_BILLINGGROUP'|'ILLEGAL_TIERING_INPUT',
    'Fields': [
        {
            'Name': 'string',
            'Message': 'string'
        },
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input doesn't match with the constraints specified by Amazon Web Services services.

    • Message (string) --

    • Reason (string) --

      The reason the request's validation failed.

    • Fields (list) --

      The fields that caused the error, if applicable.

      • (dict) --

        The field's information of a request that resulted in an exception.

        • Name (string) --

          The field name.

        • Message (string) --

          The message describing why the field failed validation.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

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'
    },
    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.

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

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.

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'
    },
    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.

  • 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'
        },
    ],

}

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.

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'
            },
            'CurrencyCode': 'USD'|'CNY',
            'Description': 'string',
            'ProductCode': 'string',
            'BillingGroupArn': 'string',
            'CreationTime': 123,
            'LastModifiedTime': 123,
            'AssociationSize': 123,
            'StartBillingPeriod': 'string',
            'EndBillingPeriod': '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 .

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

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',
        ]
    },
    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) --
  • 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'
            },
            'CurrencyCode': 'USD'|'CNY',
            'Description': 'string',
            'ProductCode': 'string',
            'BillingGroupArn': 'string',
            'CreationTime': 123,
            'LastModifiedTime': 123,
            'AssociationSize': 123
        },
    ],

}

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 .

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

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.

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_pricing_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) --

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',
            'Type': 'MARKUP'|'DISCOUNT'|'TIERING',
            'ModifierPercentage': 123.0,
            'Service': 'string',
            'AssociatedPricingPlanCount': 123,
            'CreationTime': 123,
            'LastModifiedTime': 123,
            'BillingEntity': 'string',
            'Tiering': {
                'FreeTier': {
                    'Activated': True|False
                }
            }
        },
    ],

}

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.

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_pricing_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) --

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