BcmPricingCalculator class
You can use the Pricing Calculator API to programmatically create estimates for your planned cloud use. You can model usage and commitments such as Savings Plans and Reserved Instances, and generate estimated costs using your discounts and benefit sharing preferences.
The Pricing Calculator API provides the following endpoint:
-
https://bcm-pricing-calculator.us-east-1.api.aws
Constructors
- BcmPricingCalculator({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
batchCreateBillScenarioCommitmentModification(
{required String billScenarioId, required List< BatchCreateBillScenarioCommitmentModificationEntry> commitmentModifications, String? clientToken}) → Future<BatchCreateBillScenarioCommitmentModificationResponse> - Create Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario.
-
batchCreateBillScenarioUsageModification(
{required String billScenarioId, required List< BatchCreateBillScenarioUsageModificationEntry> usageModifications, String? clientToken}) → Future<BatchCreateBillScenarioUsageModificationResponse> - Create Amazon Web Services service usage that you want to model in a Bill Scenario.
-
batchCreateWorkloadEstimateUsage(
{required List< BatchCreateWorkloadEstimateUsageEntry> usage, required String workloadEstimateId, String? clientToken}) → Future<BatchCreateWorkloadEstimateUsageResponse> - Create Amazon Web Services service usage that you want to model in a Workload Estimate.
-
batchDeleteBillScenarioCommitmentModification(
{required String billScenarioId, required List< String> ids}) → Future<BatchDeleteBillScenarioCommitmentModificationResponse> - Delete commitment that you have created in a Bill Scenario. You can only delete a commitment that you had added and cannot model deletion (or removal) of a existing commitment. If you want model deletion of an existing commitment, see the negate BillScenarioCommitmentModificationAction of BatchCreateBillScenarioCommitmentModification operation.
-
batchDeleteBillScenarioUsageModification(
{required String billScenarioId, required List< String> ids}) → Future<BatchDeleteBillScenarioUsageModificationResponse> - Delete usage that you have created in a Bill Scenario. You can only delete usage that you had added and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see BatchUpdateBillScenarioUsageModification.
-
batchDeleteWorkloadEstimateUsage(
{required List< String> ids, required String workloadEstimateId}) → Future<BatchDeleteWorkloadEstimateUsageResponse> - Delete usage that you have created in a Workload estimate. You can only delete usage that you had added and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see BatchUpdateWorkloadEstimateUsage.
-
batchUpdateBillScenarioCommitmentModification(
{required String billScenarioId, required List< BatchUpdateBillScenarioCommitmentModificationEntry> commitmentModifications}) → Future<BatchUpdateBillScenarioCommitmentModificationResponse> - Update a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID.
-
batchUpdateBillScenarioUsageModification(
{required String billScenarioId, required List< BatchUpdateBillScenarioUsageModificationEntry> usageModifications}) → Future<BatchUpdateBillScenarioUsageModificationResponse> - Update a newly added or existing usage lines. You can update the usage amounts, usage hour, and usage group based on a usage ID and a Bill scenario ID.
-
batchUpdateWorkloadEstimateUsage(
{required List< BatchUpdateWorkloadEstimateUsageEntry> usage, required String workloadEstimateId}) → Future<BatchUpdateWorkloadEstimateUsageResponse> - Update a newly added or existing usage lines. You can update the usage amounts and usage group based on a usage ID and a Workload estimate ID.
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createBillEstimate(
{required String billScenarioId, required String name, String? clientToken, Map< String, String> ? tags}) → Future<CreateBillEstimateResponse> - 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.
-
createBillScenario(
{required String name, String? clientToken, String? costCategoryGroupSharingPreferenceArn, GroupSharingPreferenceEnum? groupSharingPreference, Map< String, String> ? tags}) → Future<CreateBillScenarioResponse> - Creates a new bill scenario to model potential changes to Amazon Web Services usage and costs.
-
createWorkloadEstimate(
{required String name, String? clientToken, WorkloadEstimateRateType? rateType, Map< String, String> ? tags}) → Future<CreateWorkloadEstimateResponse> - Creates a new workload estimate to model costs for a specific workload.
-
deleteBillEstimate(
{required String identifier}) → Future< void> - Deletes an existing bill estimate.
-
deleteBillScenario(
{required String identifier}) → Future< void> - Deletes an existing bill scenario.
-
deleteWorkloadEstimate(
{required String identifier}) → Future< void> - Deletes an existing workload estimate.
-
getBillEstimate(
{required String identifier}) → Future< GetBillEstimateResponse> - Retrieves details of a specific bill estimate.
-
getBillScenario(
{required String identifier}) → Future< GetBillScenarioResponse> - Retrieves details of a specific bill scenario.
-
getPreferences(
) → Future< GetPreferencesResponse> - Retrieves the current preferences for Pricing Calculator.
-
getWorkloadEstimate(
{required String identifier}) → Future< GetWorkloadEstimateResponse> - Retrieves details of a specific workload estimate.
-
listBillEstimateCommitments(
{required String billEstimateId, int? maxResults, String? nextToken}) → Future< ListBillEstimateCommitmentsResponse> - Lists the commitments associated with a bill estimate.
-
listBillEstimateInputCommitmentModifications(
{required String billEstimateId, int? maxResults, String? nextToken}) → Future< ListBillEstimateInputCommitmentModificationsResponse> - Lists the input commitment modifications associated with a bill estimate.
-
listBillEstimateInputUsageModifications(
{required String billEstimateId, List< ListUsageFilter> ? filters, int? maxResults, String? nextToken}) → Future<ListBillEstimateInputUsageModificationsResponse> - Lists the input usage modifications associated with a bill estimate.
-
listBillEstimateLineItems(
{required String billEstimateId, List< ListBillEstimateLineItemsFilter> ? filters, int? maxResults, String? nextToken}) → Future<ListBillEstimateLineItemsResponse> - Lists the line items associated with a bill estimate.
-
listBillEstimates(
{FilterTimestamp? createdAtFilter, FilterTimestamp? expiresAtFilter, List< ListBillEstimatesFilter> ? filters, int? maxResults, String? nextToken}) → Future<ListBillEstimatesResponse> - Lists all bill estimates for the account.
-
listBillScenarioCommitmentModifications(
{required String billScenarioId, int? maxResults, String? nextToken}) → Future< ListBillScenarioCommitmentModificationsResponse> - Lists the commitment modifications associated with a bill scenario.
-
listBillScenarios(
{FilterTimestamp? createdAtFilter, FilterTimestamp? expiresAtFilter, List< ListBillScenariosFilter> ? filters, int? maxResults, String? nextToken}) → Future<ListBillScenariosResponse> - Lists all bill scenarios for the account.
-
listBillScenarioUsageModifications(
{required String billScenarioId, List< ListUsageFilter> ? filters, int? maxResults, String? nextToken}) → Future<ListBillScenarioUsageModificationsResponse> - Lists the usage modifications associated with a bill scenario.
-
listTagsForResource(
{required String arn}) → Future< ListTagsForResourceResponse> - Lists all tags associated with a specified resource.
-
listWorkloadEstimates(
{FilterTimestamp? createdAtFilter, FilterTimestamp? expiresAtFilter, List< ListWorkloadEstimatesFilter> ? filters, int? maxResults, String? nextToken}) → Future<ListWorkloadEstimatesResponse> - Lists all workload estimates for the account.
-
listWorkloadEstimateUsage(
{required String workloadEstimateId, List< ListUsageFilter> ? filters, int? maxResults, String? nextToken}) → Future<ListWorkloadEstimateUsageResponse> - Lists the usage associated with a workload estimate.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
tagResource(
{required String arn, required Map< String, String> tags}) → Future<void> - Adds one or more tags to a specified resource.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String arn, required List< String> tagKeys}) → Future<void> - Removes one or more tags from a specified resource.
-
updateBillEstimate(
{required String identifier, DateTime? expiresAt, String? name}) → Future< UpdateBillEstimateResponse> - Updates an existing bill estimate.
-
updateBillScenario(
{required String identifier, String? costCategoryGroupSharingPreferenceArn, DateTime? expiresAt, GroupSharingPreferenceEnum? groupSharingPreference, String? name}) → Future< UpdateBillScenarioResponse> - Updates an existing bill scenario.
-
updatePreferences(
{List< RateType> ? managementAccountRateTypeSelections, List<RateType> ? memberAccountRateTypeSelections, List<RateType> ? standaloneAccountRateTypeSelections}) → Future<UpdatePreferencesResponse> - Updates the preferences for Pricing Calculator.
-
updateWorkloadEstimate(
{required String identifier, DateTime? expiresAt, String? name}) → Future< UpdateWorkloadEstimateResponse> - Updates an existing workload estimate.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited