bill_estimates

Creates, updates, deletes, gets or lists a bill_estimates resource.

Overview

Name	bill_estimates
Type	Resource
Id	aws.bcm_pricing_calculator.bill_estimates

Fields

The following fields are returned by SELECT queries:

get_bill_estimate

Name	Datatype	Description
id	string	The unique identifier of the retrieved bill estimate. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
name	string	The name of the retrieved bill estimate. (pattern: <code>[a-zA-Z0-9-]+</code>)
bill_interval	object	The time period covered by the bill estimate.
cost_category_group_sharing_preference_arn	string	The arn of the cost category used in the reserved and prioritized group sharing. (pattern: <code>arn:aws[-a-z0-9]*:ce::[0-9]{12}:costcategory/[a-f0-9-]{36}</code>)
cost_category_group_sharing_preference_effective_date	string (date-time)	Timestamp of the effective date of the cost category used in the group sharing settings.
cost_summary	object	A summary of the estimated costs.
created_at	string (date-time)	The timestamp when the bill estimate was created.
expires_at	string (date-time)	The timestamp when the bill estimate will expire.
failure_message	string	An error message if the bill estimate retrieval failed.
group_sharing_preference	string	The setting for the reserved instance and savings plan group sharing used in this estimate. (OPEN, PRIORITIZED, RESTRICTED)
status	string	The current status of the bill estimate. (IN_PROGRESS, COMPLETE, FAILED)

list_bill_estimates

Name	Datatype	Description
id	string	The unique identifier of the bill estimate. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
name	string	The name of the bill estimate. (pattern: <code>[a-zA-Z0-9-]+</code>)
bill_interval	object	The time period covered by the bill estimate.
created_at	string (date-time)	The timestamp when the bill estimate was created.
expires_at	string (date-time)	The timestamp when the bill estimate will expire.
status	string	The current status of the bill estimate. (IN_PROGRESS, COMPLETE, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bill_estimate	select	region		Retrieves details of a specific bill estimate.
list_bill_estimates	select	region		Lists all bill estimates for the account.
create_bill_estimate	insert	region, billScenarioId, name		Create a Bill estimate from a Bill scenario. In the Bill scenario you can model usage addition, usage changes, and usage removal. You can also model commitment addition and commitment removal. After all changes in a Bill scenario is made satisfactorily, you can call this API with a Bill scenario ID to generate the Bill estimate. Bill estimate calculates the pre-tax cost for your consolidated billing family, incorporating all modeled usage and commitments alongside existing usage and commitments from your most recent completed anniversary bill, with any applicable discounts applied.
update_bill_estimate	update	region, identifier		Updates an existing bill estimate.
delete_bill_estimate	delete	region		Deletes an existing bill estimate.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_bill_estimate

Retrieves details of a specific bill estimate.

SELECT
id,
name,
bill_interval,
cost_category_group_sharing_preference_arn,
cost_category_group_sharing_preference_effective_date,
cost_summary,
created_at,
expires_at,
failure_message,
group_sharing_preference,
status
FROM aws.bcm_pricing_calculator.bill_estimates
WHERE region = '{{ region }}' -- required
;

list_bill_estimates

Lists all bill estimates for the account.

SELECT
id,
name,
bill_interval,
created_at,
expires_at,
status
FROM aws.bcm_pricing_calculator.bill_estimates
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_bill_estimate

Create a Bill estimate from a Bill scenario. In the Bill scenario you can model usage addition, usage changes, and usage removal. You can also model commitment addition and commitment removal. After all changes in a Bill scenario is made satisfactorily, you can call this API with a Bill scenario ID to generate the Bill estimate. Bill estimate calculates the pre-tax cost for your consolidated billing family, incorporating all modeled usage and commitments alongside existing usage and commitments from your most recent completed anniversary bill, with any applicable discounts applied.

INSERT INTO aws.bcm_pricing_calculator.bill_estimates (
billScenarioId,
name,
clientToken,
tags,
region
)
SELECT 
'{{ billScenarioId }}' /* required */,
'{{ name }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
bill_interval,
cost_category_group_sharing_preference_arn,
cost_category_group_sharing_preference_effective_date,
cost_summary,
created_at,
expires_at,
failure_message,
group_sharing_preference,
status
;

Manifest

# Description fields are for documentation purposes
- name: bill_estimates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the bill_estimates resource.
  - name: billScenarioId
    value: "{{ billScenarioId }}"
    description: |
      The ID of the Bill Scenario for which you want to create a Bill estimate.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the Bill estimate that will be created. Names must be unique for an account.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - name: tags
    value: "{{ tags }}"
    description: |
      An optional list of tags to associate with the specified BillEstimate. You can use resource tags to control access to your BillEstimate using IAM policies. Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags: Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services. The maximum length of a key is 128 characters. The maximum length of a value is 256 characters. Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-. Keys and values are case sensitive. Keys and values are trimmed for any leading or trailing whitespaces. Don't use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services.

UPDATE examples

update_bill_estimate

Updates an existing bill estimate.

UPDATE aws.bcm_pricing_calculator.bill_estimates
SET 
identifier = '{{ identifier }}',
name = '{{ name }}',
expiresAt = '{{ expiresAt }}'
WHERE 
region = '{{ region }}' --required
AND identifier = '{{ identifier }}' --required
RETURNING
id,
name,
bill_interval,
cost_category_group_sharing_preference_arn,
cost_category_group_sharing_preference_effective_date,
cost_summary,
created_at,
expires_at,
failure_message,
group_sharing_preference,
status;

DELETE examples

delete_bill_estimate

Deletes an existing bill estimate.

DELETE FROM aws.bcm_pricing_calculator.bill_estimates
WHERE region = '{{ region }}' --required
;