AWS Billing

2025/11/19 - AWS Billing - 2 updated api methods

Changes  Added name filtering support to ListBillingViews API through the new names parameter to efficiently filter billing views by name.

GetBillingView (updated) Link ¶
Changes (response)
{'billingView': {'billingViewType': {'BILLING_TRANSFER',
                                     'BILLING_TRANSFER_SHOWBACK'}}}

Returns the metadata associated to the specified billing view ARN.

See also: AWS API Documentation

Request Syntax

client.get_billing_view(
    arn='string'
)
type arn:

string

param arn:

[REQUIRED]

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

rtype:

dict

returns:

Response Syntax

{
    'billingView': {
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'billingViewType': 'PRIMARY'|'BILLING_GROUP'|'CUSTOM'|'BILLING_TRANSFER'|'BILLING_TRANSFER_SHOWBACK',
        'ownerAccountId': 'string',
        'sourceAccountId': 'string',
        'dataFilterExpression': {
            'dimensions': {
                'key': 'LINKED_ACCOUNT',
                'values': [
                    'string',
                ]
            },
            'tags': {
                'key': 'string',
                'values': [
                    'string',
                ]
            },
            'timeRange': {
                'beginDateInclusive': datetime(2015, 1, 1),
                'endDateInclusive': datetime(2015, 1, 1)
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'derivedViewCount': 123,
        'sourceViewCount': 123,
        'viewDefinitionLastUpdatedAt': datetime(2015, 1, 1),
        'healthStatus': {
            'statusCode': 'HEALTHY'|'UNHEALTHY'|'CREATING'|'UPDATING',
            'statusReasons': [
                'SOURCE_VIEW_UNHEALTHY'|'SOURCE_VIEW_UPDATING'|'SOURCE_VIEW_ACCESS_DENIED'|'SOURCE_VIEW_NOT_FOUND'|'CYCLIC_DEPENDENCY'|'SOURCE_VIEW_DEPTH_EXCEEDED'|'AGGREGATE_SOURCE'|'VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT',
            ]
        }
    }
}

Response Structure

  • (dict) --

    • billingView (dict) --

      The billing view element associated with the specified ARN.

      • arn (string) --

        The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

      • name (string) --

        The account name of the billing view.

      • description (string) --

        The description of the billing view.

      • billingViewType (string) --

        The type of billing group.

      • ownerAccountId (string) --

        The account owner of the billing view.

      • sourceAccountId (string) --

        The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.

      • dataFilterExpression (dict) --

        See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

        • dimensions (dict) --

          The specific Dimension to use for Expression.

          • key (string) --

            The names of the metadata types that you can use to filter and group your results.

          • values (list) --

            The metadata values that you can use to filter and group your results.

            • (string) --

        • tags (dict) --

          The specific Tag to use for Expression.

          • key (string) --

            The key for the tag.

          • values (list) --

            The specific value of the tag.

            • (string) --

        • timeRange (dict) --

          Specifies a time range filter for the billing view data.

          • beginDateInclusive (datetime) --

            The inclusive start date of the time range.

          • endDateInclusive (datetime) --

            The inclusive end date of the time range.

      • createdAt (datetime) --

        The time when the billing view was created.

      • updatedAt (datetime) --

        The time when the billing view was last updated.

      • derivedViewCount (integer) --

        The number of billing views that use this billing view as a source.

      • sourceViewCount (integer) --

        The number of source views associated with this billing view.

      • viewDefinitionLastUpdatedAt (datetime) --

        The timestamp of when the billing view definition was last updated.

      • healthStatus (dict) --

        The current health status of the billing view.

        • statusCode (string) --

          The current health status code of the billing view.

        • statusReasons (list) --

          A list of reasons explaining the current health status, if applicable.

          • (string) --

ListBillingViews (updated) Link ¶
Changes (request, response)
Request
{'billingViewTypes': {'BILLING_TRANSFER_SHOWBACK', 'BILLING_TRANSFER'},
 'names': [{'searchOption': 'STARTS_WITH', 'searchValue': 'string'}]}
Response
{'billingViews': {'billingViewType': {'BILLING_TRANSFER',
                                      'BILLING_TRANSFER_SHOWBACK'}}}

Lists the billing views available for a given time period.

Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.

See also: AWS API Documentation

Request Syntax

client.list_billing_views(
    activeTimeRange={
        'activeAfterInclusive': datetime(2015, 1, 1),
        'activeBeforeInclusive': datetime(2015, 1, 1)
    },
    arns=[
        'string',
    ],
    billingViewTypes=[
        'PRIMARY'|'BILLING_GROUP'|'CUSTOM'|'BILLING_TRANSFER'|'BILLING_TRANSFER_SHOWBACK',
    ],
    names=[
        {
            'searchOption': 'STARTS_WITH',
            'searchValue': 'string'
        },
    ],
    ownerAccountId='string',
    sourceAccountId='string',
    maxResults=123,
    nextToken='string'
)
type activeTimeRange:

dict

param activeTimeRange:

The time range for the billing views listed. PRIMARY billing view is always listed. BILLING_GROUP billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.

  • activeAfterInclusive (datetime) -- [REQUIRED]

    The inclusive time range start date.

  • activeBeforeInclusive (datetime) -- [REQUIRED]

    The inclusive time range end date.

type arns:

list

param arns:

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

  • (string) --

type billingViewTypes:

list

param billingViewTypes:

The type of billing view.

  • (string) --

type names:

list

param names:

Filters the list of billing views by name. You can specify search criteria to match billing view names based on the search option provided.

  • (dict) --

    A structure that defines how to search for string values. You can specify a search option and the value to search for.

    • searchOption (string) -- [REQUIRED]

      The type of search operation to perform on the string value. Determines how the search value is matched against the target field.

    • searchValue (string) -- [REQUIRED]

      The string value to use in the search operation. This value is compared against the target field using the specified search option.

type ownerAccountId:

string

param ownerAccountId:

The list of owners of the billing view.

type sourceAccountId:

string

param sourceAccountId:

Filters the results to include only billing views that use the specified account as a source.

type maxResults:

integer

param maxResults:

The maximum number of billing views to retrieve. Default is 100.

type nextToken:

string

param nextToken:

The pagination token that is used on subsequent calls to list billing views.

rtype:

dict

returns:

Response Syntax

{
    'billingViews': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'ownerAccountId': 'string',
            'sourceAccountId': 'string',
            'billingViewType': 'PRIMARY'|'BILLING_GROUP'|'CUSTOM'|'BILLING_TRANSFER'|'BILLING_TRANSFER_SHOWBACK',
            'healthStatus': {
                'statusCode': 'HEALTHY'|'UNHEALTHY'|'CREATING'|'UPDATING',
                'statusReasons': [
                    'SOURCE_VIEW_UNHEALTHY'|'SOURCE_VIEW_UPDATING'|'SOURCE_VIEW_ACCESS_DENIED'|'SOURCE_VIEW_NOT_FOUND'|'CYCLIC_DEPENDENCY'|'SOURCE_VIEW_DEPTH_EXCEEDED'|'AGGREGATE_SOURCE'|'VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT',
                ]
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • billingViews (list) --

      A list of BillingViewListElement retrieved.

      • (dict) --

        A representation of a billing view.

        • arn (string) --

          The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

        • name (string) --

          A list of names of the Billing view.

        • description (string) --

          The description of the billing view.

        • ownerAccountId (string) --

          The list of owners of the Billing view.

        • sourceAccountId (string) --

          The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.

        • billingViewType (string) --

          The type of billing view.

        • healthStatus (dict) --

          The current health status of the billing view.

          • statusCode (string) --

            The current health status code of the billing view.

          • statusReasons (list) --

            A list of reasons explaining the current health status, if applicable.

            • (string) --

    • nextToken (string) --

      The pagination token to use on subsequent calls to list billing views.