AWS API Changes

2024/12/20 - AWS Billing - 9 new1 updated api methods

Changes Added new API's for defining and fetching Billing Views.

ListSourceViewsForBillingView (new)

Link ¶

Lists the source views (managed Amazon Web Services billing views) associated with the billing view.

Request Syntax

client.list_source_views_for_billing_view(
    arn='string',
    maxResults=123,
    nextToken='string'
)

type arn:

string

param arn:

[REQUIRED]

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

type maxResults:

integer

param maxResults:

The number of entries a paginated response contains.

type nextToken:

string

param nextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'sourceViews': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- sourceViews (list) --
  
  A list of billing views used as the data source for the custom billing view.
  - (string) --
- nextToken (string) --
  
  The pagination token that is used on subsequent calls to list billing views.

GetResourcePolicy (new)

Link ¶

Returns the resource-based policy document attached to the resource in JSON format.

See also: AWS API Documentation

Request Syntax

client.get_resource_policy(
    resourceArn='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.

rtype:

dict

returns:

Response Syntax

{
    'resourceArn': 'string',
    'policy': 'string'
}

Response Structure

(dict) --
- resourceArn (string) --
  
  The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.
- policy (string) --
  
  The resource-based policy document attached to the resource in JSON format.

TagResource (new)

Link ¶

An API operation for adding one or more tags (key-value pairs) to a resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    resourceTags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type resourceTags:

list

param resourceTags:

[REQUIRED]

A list of tag key value pairs that are associated with the resource.

(dict) --

The tag structure that contains a tag key and value.
- key (string) -- [REQUIRED]
  
  The key that's associated with the tag.
- value (string) --
  
  The value that's associated with the tag.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetBillingView (new)

Link ¶

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',
        'ownerAccountId': 'string',
        'dataFilterExpression': {
            'dimensions': {
                'key': 'LINKED_ACCOUNT',
                'values': [
                    'string',
                ]
            },
            'tags': {
                'key': 'string',
                'values': [
                    'string',
                ]
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

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) --
    
    A list of names of the billing view.
  - description (string) --
    
    The description of the billing view.
  - billingViewType (string) --
    
    The type of billing group.
  - ownerAccountId (string) --
    
    The list of owners of the 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) --
  - createdAt (datetime) --
    
    The time when the billing view was created.
  - updatedAt (datetime) --
    
    The time when the billing view was last updated.

ListTagsForResource (new)

Link ¶

Lists tags associated with the billing view resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

rtype:

dict

returns:

Response Syntax

{
    'resourceTags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ]
}

Response Structure

(dict) --
- resourceTags (list) --
  
  A list of tag key value pairs that are associated with the resource.
  - (dict) --
    
    The tag structure that contains a tag key and value.
    - key (string) --
      
      The key that's associated with the tag.
    - value (string) --
      
      The value that's associated with the tag.

UpdateBillingView (new)

Link ¶

An API to update the attributes of the billing view.

See also: AWS API Documentation

Request Syntax

client.update_billing_view(
    arn='string',
    name='string',
    description='string',
    dataFilterExpression={
        'dimensions': {
            'key': 'LINKED_ACCOUNT',
            'values': [
                'string',
            ]
        },
        'tags': {
            'key': 'string',
            'values': [
                'string',
            ]
        }
    }
)

type arn:

string

param arn:

[REQUIRED]

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

type name:

string

param name:

The name of the billing view.

type description:

string

param description:

The description of the billing view.

type dataFilterExpression:

dict

param dataFilterExpression:

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

dimensions (dict) --

The specific Dimension to use for Expression.
- key (string) -- [REQUIRED]
  
  The names of the metadata types that you can use to filter and group your results.
- values (list) -- [REQUIRED]
  
  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) -- [REQUIRED]
  
  The key for the tag.
- values (list) -- [REQUIRED]
  
  The specific value of the tag.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- arn (string) --
  
  The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
- updatedAt (datetime) --
  
  The time when the billing view was last updated.

UntagResource (new)

Link ¶

Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    resourceTagKeys=[
        'string',
    ]
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type resourceTagKeys:

list

param resourceTagKeys:

[REQUIRED]

A list of tag key value pairs that are associated with the resource.

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateBillingView (new)

Link ¶

Creates a billing view with the specified billing view attributes.

See also: AWS API Documentation

Request Syntax

client.create_billing_view(
    name='string',
    description='string',
    sourceViews=[
        'string',
    ],
    dataFilterExpression={
        'dimensions': {
            'key': 'LINKED_ACCOUNT',
            'values': [
                'string',
            ]
        },
        'tags': {
            'key': 'string',
            'values': [
                'string',
            ]
        }
    },
    clientToken='string',
    resourceTags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type name:

string

param name:

[REQUIRED]

The name of the billing view.

type description:

string

param description:

The description of the billing view.

type sourceViews:

list

param sourceViews:

[REQUIRED]

A list of billing views used as the data source for the custom billing view.

(string) --

type dataFilterExpression:

dict

param dataFilterExpression:

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

dimensions (dict) --

The specific Dimension to use for Expression.
- key (string) -- [REQUIRED]
  
  The names of the metadata types that you can use to filter and group your results.
- values (list) -- [REQUIRED]
  
  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) -- [REQUIRED]
  
  The key for the tag.
- values (list) -- [REQUIRED]
  
  The specific value of the tag.
  - (string) --

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. If the original request completes successfully, any subsequent retries complete successfully without performing any further actions with an idempotent request.

This field is autopopulated if not provided.

type resourceTags:

list

param resourceTags:

A list of key value map specifying tags associated to the billing view being created.

(dict) --

The tag structure that contains a tag key and value.
- key (string) -- [REQUIRED]
  
  The key that's associated with the tag.
- value (string) --
  
  The value that's associated with the tag.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- arn (string) --
  
  The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
- createdAt (datetime) --
  
  The time when the billing view was created.

DeleteBillingView (new)

Link ¶

Deletes the specified billing view.

See also: AWS API Documentation

Request Syntax

client.delete_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

{
    'arn': 'string'
}

Response Structure

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

ListBillingViews (updated)

Link ¶
Changes (request, response)
Request

{'arns': ['string'],
 'billingViewTypes': ['PRIMARY | BILLING_GROUP | CUSTOM'],
 'ownerAccountId': 'string'}

Response

{'billingViews': {'billingViewType': {'CUSTOM'}, 'description': 'string'}}

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',
    ],
    ownerAccountId='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 ownerAccountId:

string

param ownerAccountId:

The list of owners of the billing view.

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',
            'billingViewType': 'PRIMARY'|'BILLING_GROUP'|'CUSTOM'
        },
    ],
    '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.
    - billingViewType (string) --
      
      The type of billing view.
- nextToken (string) --
  
  The pagination token to use on subsequent calls to list billing views.