Billing / Client / get_billing_view

get_billing_view¶

Billing.Client.get_billing_view(**kwargs)¶

Returns the metadata associated to the specified billing view ARN.

Request Syntax

response = client.get_billing_view(
    arn='string'
)

Parameters:

arn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'billingView': {
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'billingViewType': 'PRIMARY'|'BILLING_GROUP'|'CUSTOM',
        '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) –

Exceptions

Billing.Client.exceptions.ThrottlingException
Billing.Client.exceptions.ResourceNotFoundException
Billing.Client.exceptions.AccessDeniedException
Billing.Client.exceptions.ValidationException
Billing.Client.exceptions.InternalServerException