You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data.
The Billing API provides the following endpoint:
https://billing.us-east-1.api.aws
Associates one or more source billing views with an existing billing view. This allows creating aggregate billing views that combine data from multiple sources.
", "CreateBillingView": "Creates a billing view with the specified billing view attributes.
", "DeleteBillingView": "Deletes the specified billing view.
", "DisassociateSourceViews": "Removes the association between one or more source billing views and an existing billing view. This allows modifying the composition of aggregate billing views.
", "GetBillingView": "Returns the metadata associated to the specified billing view ARN.
", "GetResourcePolicy": "Returns the resource-based policy document attached to the resource in JSON format.
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.
Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
", "ListTagsForResource": "Lists tags associated with the billing view resource.
", "TagResource": "An API operation for adding one or more tags (key-value pairs) to a resource.
", "UntagResource": "Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
", "UpdateBillingView": "An API to update the attributes of the billing view.
" }, "shapes": { "AccessDeniedException": { "base": "You don't have sufficient access to perform this action.
", "refs": {} }, "AccountId": { "base": null, "refs": { "BillingViewElement$ownerAccountId": "The account owner of the billing view.
", "BillingViewElement$sourceAccountId": "The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.
", "BillingViewListElement$ownerAccountId": "The list of owners of the Billing view.
", "BillingViewListElement$sourceAccountId": "The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.
", "ListBillingViewsRequest$ownerAccountId": "The list of owners of the billing view.
", "ListBillingViewsRequest$sourceAccountId": "Filters the results to include only billing views that use the specified account as a source.
" } }, "ActiveTimeRange": { "base": "A time range with a start and end time.
", "refs": { "ListBillingViewsRequest$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.
The Amazon Resource Name (ARN) of the billing view to associate source views with.
", "AssociateSourceViewsResponse$arn": "The ARN of the billing view that the source views were associated with.
", "BillingViewArnList$member": null, "BillingViewElement$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "BillingViewListElement$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "BillingViewSourceViewsList$member": null, "CreateBillingViewResponse$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "DeleteBillingViewRequest$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "DeleteBillingViewResponse$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "DisassociateSourceViewsRequest$arn": "The Amazon Resource Name (ARN) of the billing view to disassociate source views from.
", "DisassociateSourceViewsResponse$arn": "The ARN of the billing view that the source views were disassociated from.
", "GetBillingViewRequest$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "ListSourceViewsForBillingViewRequest$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "UpdateBillingViewRequest$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "UpdateBillingViewResponse$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
" } }, "BillingViewArnList": { "base": null, "refs": { "ListBillingViewsRequest$arns": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
" } }, "BillingViewDescription": { "base": null, "refs": { "BillingViewElement$description": "The description of the billing view.
", "BillingViewListElement$description": "The description of the billing view.
", "CreateBillingViewRequest$description": "The description of the billing view.
", "UpdateBillingViewRequest$description": "The description of the billing view.
" } }, "BillingViewElement": { "base": "The metadata associated to the billing view.
", "refs": { "GetBillingViewResponse$billingView": "The billing view element associated with the specified ARN.
" } }, "BillingViewHealthStatus": { "base": "Represents the health status of a billing view, including a status code and optional reasons for the status.
", "refs": { "BillingViewElement$healthStatus": "The current health status of the billing view.
", "BillingViewListElement$healthStatus": "The current health status of the billing view.
" } }, "BillingViewHealthStatusException": { "base": " Exception thrown when a billing view's health status prevents an operation from being performed. This may occur if the billing view is in a state other than HEALTHY.
A list of BillingViewListElement retrieved.
A representation of a billing view.
", "refs": { "BillingViewList$member": null } }, "BillingViewName": { "base": null, "refs": { "BillingViewElement$name": "The account name of the billing view.
", "BillingViewListElement$name": "A list of names of the Billing view.
", "CreateBillingViewRequest$name": "The name of the billing view.
", "UpdateBillingViewRequest$name": "The name of the billing view.
" } }, "BillingViewSourceViewsList": { "base": null, "refs": { "AssociateSourceViewsRequest$sourceViews": "A list of ARNs of the source billing views to associate.
", "CreateBillingViewRequest$sourceViews": "A list of billing views used as the data source for the custom billing view.
", "DisassociateSourceViewsRequest$sourceViews": "A list of ARNs of the source billing views to disassociate.
", "ListSourceViewsForBillingViewResponse$sourceViews": "A list of billing views used as the data source for the custom billing view.
" } }, "BillingViewStatus": { "base": null, "refs": { "BillingViewHealthStatus$statusCode": "The current health status code of the billing view.
" } }, "BillingViewStatusReason": { "base": null, "refs": { "BillingViewStatusReasons$member": null } }, "BillingViewStatusReasons": { "base": null, "refs": { "BillingViewHealthStatus$statusReasons": "A list of reasons explaining the current health status, if applicable.
" } }, "BillingViewType": { "base": null, "refs": { "BillingViewElement$billingViewType": "The type of billing group.
", "BillingViewListElement$billingViewType": "The type of billing view.
", "BillingViewTypeList$member": null } }, "BillingViewTypeList": { "base": null, "refs": { "ListBillingViewsRequest$billingViewTypes": "The type of billing view.
" } }, "BillingViewsMaxResults": { "base": null, "refs": { "ListBillingViewsRequest$maxResults": "The maximum number of billing views to retrieve. Default is 100.
", "ListSourceViewsForBillingViewRequest$maxResults": "The number of entries a paginated response contains.
" } }, "Boolean": { "base": null, "refs": { "DeleteBillingViewRequest$force": "If set to true, forces deletion of the billing view even if it has derived resources (e.g. other billing views or budgets). Use with caution as this may break dependent resources.
" } }, "ClientToken": { "base": null, "refs": { "CreateBillingViewRequest$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.
" } }, "ConflictException": { "base": "The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
", "refs": {} }, "CostCategoryName": { "base": null, "refs": { "CostCategoryValues$key": "The unique name of the Cost Category.
" } }, "CostCategoryValues": { "base": "The Cost Categories values used for filtering the costs.
", "refs": { "Expression$costCategories": " The filter that's based on CostCategory values.
The names of the metadata types that you can use to filter and group your results.
" } }, "DimensionValues": { "base": "The metadata that you can use to filter and group your results.
", "refs": { "Expression$dimensions": " The specific Dimension to use for Expression.
The message describing why the field failed validation.
" } }, "Expression": { "base": " See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
The name of the field.
" } }, "GetBillingViewRequest": { "base": null, "refs": {} }, "GetBillingViewResponse": { "base": null, "refs": {} }, "GetResourcePolicyRequest": { "base": null, "refs": {} }, "GetResourcePolicyResponse": { "base": null, "refs": {} }, "Integer": { "base": null, "refs": { "BillingViewElement$derivedViewCount": "The number of billing views that use this billing view as a source.
", "BillingViewElement$sourceViewCount": "The number of source views associated with this billing view.
" } }, "InternalServerException": { "base": "The request processing failed because of an unknown error, exception, or failure.
", "refs": {} }, "ListBillingViewsRequest": { "base": null, "refs": {} }, "ListBillingViewsResponse": { "base": null, "refs": {} }, "ListSourceViewsForBillingViewRequest": { "base": null, "refs": {} }, "ListSourceViewsForBillingViewResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "PageToken": { "base": null, "refs": { "ListBillingViewsRequest$nextToken": "The pagination token that is used on subsequent calls to list billing views.
", "ListBillingViewsResponse$nextToken": "The pagination token to use on subsequent calls to list billing views.
", "ListSourceViewsForBillingViewRequest$nextToken": "The pagination token that is used on subsequent calls to list billing views.
", "ListSourceViewsForBillingViewResponse$nextToken": "The pagination token that is used on subsequent calls to list billing views.
" } }, "PolicyDocument": { "base": null, "refs": { "GetResourcePolicyResponse$policy": "The resource-based policy document attached to the resource in JSON format.
The container for the quotaCode.
The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.
", "GetResourcePolicyResponse$resourceArn": "The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.
", "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
" } }, "ResourceId": { "base": null, "refs": { "ConflictException$resourceId": "The identifier for the service resource associated with the request.
", "ResourceNotFoundException$resourceId": "Value is a list of resource IDs that were not found.
", "ServiceQuotaExceededException$resourceId": "The ID of the resource.
" } }, "ResourceNotFoundException": { "base": "The specified ARN in the request doesn't exist.
", "refs": {} }, "ResourceTag": { "base": "The tag structure that contains a tag key and value.
", "refs": { "ResourceTagList$member": null } }, "ResourceTagKey": { "base": null, "refs": { "ResourceTag$key": "The key that's associated with the tag.
", "ResourceTagKeyList$member": null } }, "ResourceTagKeyList": { "base": null, "refs": { "UntagResourceRequest$resourceTagKeys": "A list of tag key value pairs that are associated with the resource.
" } }, "ResourceTagList": { "base": null, "refs": { "CreateBillingViewRequest$resourceTags": "A list of key value map specifying tags associated to the billing view being created.
", "ListTagsForResourceResponse$resourceTags": "A list of tag key value pairs that are associated with the resource.
", "TagResourceRequest$resourceTags": "A list of tag key value pairs that are associated with the resource.
" } }, "ResourceTagValue": { "base": null, "refs": { "ResourceTag$value": "The value that's associated with the tag.
" } }, "ResourceType": { "base": null, "refs": { "ConflictException$resourceType": "The type of resource associated with the request.
", "ResourceNotFoundException$resourceType": "Value is the type of resource that was not found.
", "ServiceQuotaExceededException$resourceType": "The type of Amazon Web Services resource.
" } }, "SearchOption": { "base": null, "refs": { "StringSearch$searchOption": "The type of search operation to perform on the string value. Determines how the search value is matched against the target field.
" } }, "SearchValue": { "base": null, "refs": { "StringSearch$searchValue": "The string value to use in the search operation. This value is compared against the target field using the specified search option.
" } }, "ServiceCode": { "base": null, "refs": { "ServiceQuotaExceededException$serviceCode": " The container for the serviceCode.
You've reached the limit of resources you can create, or exceeded the size of an individual resource.
", "refs": {} }, "StringSearch": { "base": "A structure that defines how to search for string values. You can specify a search option and the value to search for.
", "refs": { "StringSearches$member": null } }, "StringSearches": { "base": null, "refs": { "ListBillingViewsRequest$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.
" } }, "TagKey": { "base": null, "refs": { "TagValues$key": "The key for the tag.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValues": { "base": "The values that are available for a tag.
", "refs": { "Expression$tags": " The specific Tag to use for Expression.
The request was denied due to request throttling.
", "refs": {} }, "TimeRange": { "base": "Specifies a time range with inclusive begin and end dates.
", "refs": { "Expression$timeRange": "Specifies a time range filter for the billing view data.
" } }, "Timestamp": { "base": null, "refs": { "ActiveTimeRange$activeAfterInclusive": "The inclusive time range start date.
", "ActiveTimeRange$activeBeforeInclusive": "The inclusive time range end date.
", "BillingViewElement$createdAt": "The time when the billing view was created.
", "BillingViewElement$updatedAt": "The time when the billing view was last updated.
", "BillingViewElement$viewDefinitionLastUpdatedAt": "The timestamp of when the billing view definition was last updated.
", "CreateBillingViewResponse$createdAt": "The time when the billing view was created.
", "TimeRange$beginDateInclusive": "The inclusive start date of the time range.
", "TimeRange$endDateInclusive": "The inclusive end date of the time range.
", "UpdateBillingViewResponse$updatedAt": "The time when the billing view was last updated.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateBillingViewRequest": { "base": null, "refs": {} }, "UpdateBillingViewResponse": { "base": null, "refs": {} }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "refs": {} }, "ValidationExceptionField": { "base": "The field's information of a request that resulted in an exception.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } }, "Value": { "base": null, "refs": { "Values$member": null } }, "Values": { "base": null, "refs": { "CostCategoryValues$values": "The specific value of the Cost Category.
", "DimensionValues$values": "The metadata values that you can use to filter and group your results.
", "TagValues$values": "The specific value of the tag.
" } } } }