Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Billing and Cost Management Pricing Calculator

Client for invoking operations on AWS Billing and Cost Management Pricing Calculator. Each operation on AWS Billing and Cost Management Pricing Calculator is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_bcmpricingcalculator::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_bcmpricingcalculator::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the BatchCreateBillScenarioCommitmentModification operation has a Client::batch_create_bill_scenario_commitment_modification, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.batch_create_bill_scenario_commitment_modification()
    .bill_scenario_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_create_bill_scenario_commitment_modification( &self, ) -> BatchCreateBillScenarioCommitmentModificationFluentBuilder

Constructs a fluent builder for the BatchCreateBillScenarioCommitmentModification operation.

• The fluent builder is configurable:
  • bill_scenario_id(impl Into<String>) / set_bill_scenario_id(Option<String>):
    required: true
    

    The ID of the Bill Scenario for which you want to create the modeled commitment.

    
    
  • commitment_modifications(BatchCreateBillScenarioCommitmentModificationEntry) / set_commitment_modifications(Option<Vec::<BatchCreateBillScenarioCommitmentModificationEntry>>):
    required: true
    

    List of commitments that you want to model in the Bill Scenario.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with BatchCreateBillScenarioCommitmentModificationOutput with field(s):
  • items(Option<Vec::<BatchCreateBillScenarioCommitmentModificationItem>>):

    Returns the list of successful commitment line items that were created for the Bill Scenario.

  • errors(Option<Vec::<BatchCreateBillScenarioCommitmentModificationError>>):

    Returns the list of errors reason and the commitment item keys that cannot be created in the Bill Scenario.

• On failure, responds with SdkError<BatchCreateBillScenarioCommitmentModificationError>

impl Client

pub fn batch_create_bill_scenario_usage_modification( &self, ) -> BatchCreateBillScenarioUsageModificationFluentBuilder

Constructs a fluent builder for the BatchCreateBillScenarioUsageModification operation.

• The fluent builder is configurable:
  • bill_scenario_id(impl Into<String>) / set_bill_scenario_id(Option<String>):
    required: true
    

    The ID of the Bill Scenario for which you want to create the modeled usage.

    
    
  • usage_modifications(BatchCreateBillScenarioUsageModificationEntry) / set_usage_modifications(Option<Vec::<BatchCreateBillScenarioUsageModificationEntry>>):
    required: true
    

    List of usage that you want to model in the Bill Scenario.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with BatchCreateBillScenarioUsageModificationOutput with field(s):
  • items(Option<Vec::<BatchCreateBillScenarioUsageModificationItem>>):

    Returns the list of successful usage line items that were created for the Bill Scenario.

  • errors(Option<Vec::<BatchCreateBillScenarioUsageModificationError>>):

    Returns the list of errors reason and the usage item keys that cannot be created in the Bill Scenario.

• On failure, responds with SdkError<BatchCreateBillScenarioUsageModificationError>

impl Client

pub fn batch_create_workload_estimate_usage( &self, ) -> BatchCreateWorkloadEstimateUsageFluentBuilder

Constructs a fluent builder for the BatchCreateWorkloadEstimateUsage operation.

• The fluent builder is configurable:
  • workload_estimate_id(impl Into<String>) / set_workload_estimate_id(Option<String>):
    required: true
    

    The ID of the Workload estimate for which you want to create the modeled usage.

    
    
  • usage(BatchCreateWorkloadEstimateUsageEntry) / set_usage(Option<Vec::<BatchCreateWorkloadEstimateUsageEntry>>):
    required: true
    

    List of usage that you want to model in the Workload estimate.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with BatchCreateWorkloadEstimateUsageOutput with field(s):
  • items(Option<Vec::<BatchCreateWorkloadEstimateUsageItem>>):

    Returns the list of successful usage line items that were created for the Workload estimate.

  • errors(Option<Vec::<BatchCreateWorkloadEstimateUsageError>>):

    Returns the list of errors reason and the usage item keys that cannot be created in the Workload estimate.

• On failure, responds with SdkError<BatchCreateWorkloadEstimateUsageError>

impl Client

pub fn batch_delete_bill_scenario_commitment_modification( &self, ) -> BatchDeleteBillScenarioCommitmentModificationFluentBuilder

Constructs a fluent builder for the BatchDeleteBillScenarioCommitmentModification operation.

• The fluent builder is configurable:
  • bill_scenario_id(impl Into<String>) / set_bill_scenario_id(Option<String>):
    required: true
    

    The ID of the Bill Scenario for which you want to delete the modeled commitment.

    
    
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: true
    

    List of commitments that you want to delete from the Bill Scenario.

    
    
• On success, responds with BatchDeleteBillScenarioCommitmentModificationOutput with field(s):
  • errors(Option<Vec::<BatchDeleteBillScenarioCommitmentModificationError>>):

    Returns the list of errors reason and the commitment item keys that cannot be deleted from the Bill Scenario.

• On failure, responds with SdkError<BatchDeleteBillScenarioCommitmentModificationError>

impl Client

pub fn batch_delete_bill_scenario_usage_modification( &self, ) -> BatchDeleteBillScenarioUsageModificationFluentBuilder

Constructs a fluent builder for the BatchDeleteBillScenarioUsageModification operation.

• The fluent builder is configurable:
  • bill_scenario_id(impl Into<String>) / set_bill_scenario_id(Option<String>):
    required: true
    

    The ID of the Bill Scenario for which you want to delete the modeled usage.

    
    
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: true
    

    List of usage that you want to delete from the Bill Scenario.

    
    
• On success, responds with BatchDeleteBillScenarioUsageModificationOutput with field(s):
  • errors(Option<Vec::<BatchDeleteBillScenarioUsageModificationError>>):

    Returns the list of errors reason and the usage item keys that cannot be deleted from the Bill Scenario.

• On failure, responds with SdkError<BatchDeleteBillScenarioUsageModificationError>

impl Client

pub fn batch_delete_workload_estimate_usage( &self, ) -> BatchDeleteWorkloadEstimateUsageFluentBuilder

Constructs a fluent builder for the BatchDeleteWorkloadEstimateUsage operation.

• The fluent builder is configurable:
  • workload_estimate_id(impl Into<String>) / set_workload_estimate_id(Option<String>):
    required: true
    

    The ID of the Workload estimate for which you want to delete the modeled usage.

    
    
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: true
    

    List of usage that you want to delete from the Workload estimate.

    
    
• On success, responds with BatchDeleteWorkloadEstimateUsageOutput with field(s):
  • errors(Option<Vec::<BatchDeleteWorkloadEstimateUsageError>>):

    Returns the list of errors reason and the usage item keys that cannot be deleted from the Workload estimate.

• On failure, responds with SdkError<BatchDeleteWorkloadEstimateUsageError>

impl Client

pub fn batch_update_bill_scenario_commitment_modification( &self, ) -> BatchUpdateBillScenarioCommitmentModificationFluentBuilder

Constructs a fluent builder for the BatchUpdateBillScenarioCommitmentModification operation.

• The fluent builder is configurable:
  • bill_scenario_id(impl Into<String>) / set_bill_scenario_id(Option<String>):
    required: true
    

    The ID of the Bill Scenario for which you want to modify the commitment group of a modeled commitment.

    
    
  • commitment_modifications(BatchUpdateBillScenarioCommitmentModificationEntry) / set_commitment_modifications(Option<Vec::<BatchUpdateBillScenarioCommitmentModificationEntry>>):
    required: true
    

    List of commitments that you want to update in a Bill Scenario.

    
    
• On success, responds with BatchUpdateBillScenarioCommitmentModificationOutput with field(s):
  • items(Option<Vec::<BillScenarioCommitmentModificationItem>>):

    Returns the list of successful commitment line items that were updated for a Bill Scenario.

  • errors(Option<Vec::<BatchUpdateBillScenarioCommitmentModificationError>>):

    Returns the list of error reasons and commitment line item IDs that could not be updated for the Bill Scenario.

• On failure, responds with SdkError<BatchUpdateBillScenarioCommitmentModificationError>

impl Client

pub fn batch_update_bill_scenario_usage_modification( &self, ) -> BatchUpdateBillScenarioUsageModificationFluentBuilder

Constructs a fluent builder for the BatchUpdateBillScenarioUsageModification operation.

• The fluent builder is configurable:
  • bill_scenario_id(impl Into<String>) / set_bill_scenario_id(Option<String>):
    required: true
    

    The ID of the Bill Scenario for which you want to modify the usage lines.

    
    
  • usage_modifications(BatchUpdateBillScenarioUsageModificationEntry) / set_usage_modifications(Option<Vec::<BatchUpdateBillScenarioUsageModificationEntry>>):
    required: true
    

    List of usage lines that you want to update in a Bill Scenario identified by the usage ID.

    
    
• On success, responds with BatchUpdateBillScenarioUsageModificationOutput with field(s):
  • items(Option<Vec::<BillScenarioUsageModificationItem>>):

    Returns the list of successful usage line items that were updated for a Bill Scenario.

  • errors(Option<Vec::<BatchUpdateBillScenarioUsageModificationError>>):

    Returns the list of error reasons and usage line item IDs that could not be updated for the Bill Scenario.

• On failure, responds with SdkError<BatchUpdateBillScenarioUsageModificationError>

impl Client

pub fn batch_update_workload_estimate_usage( &self, ) -> BatchUpdateWorkloadEstimateUsageFluentBuilder

Constructs a fluent builder for the BatchUpdateWorkloadEstimateUsage operation.

• The fluent builder is configurable:
  • workload_estimate_id(impl Into<String>) / set_workload_estimate_id(Option<String>):
    required: true
    

    The ID of the Workload estimate for which you want to modify the usage lines.

    
    
  • usage(BatchUpdateWorkloadEstimateUsageEntry) / set_usage(Option<Vec::<BatchUpdateWorkloadEstimateUsageEntry>>):
    required: true
    

    List of usage line amounts and usage group that you want to update in a Workload estimate identified by the usage ID.

    
    
• On success, responds with BatchUpdateWorkloadEstimateUsageOutput with field(s):
  • items(Option<Vec::<WorkloadEstimateUsageItem>>):

    Returns the list of successful usage line items that were updated for a Workload estimate.

  • errors(Option<Vec::<BatchUpdateWorkloadEstimateUsageError>>):

    Returns the list of error reasons and usage line item IDs that could not be updated for the Workload estimate.

• On failure, responds with SdkError<BatchUpdateWorkloadEstimateUsageError>

impl Client

pub fn create_bill_estimate(&self) -> CreateBillEstimateFluentBuilder

Constructs a fluent builder for the CreateBillEstimate operation.

• The fluent builder is configurable:
  • bill_scenario_id(impl Into<String>) / set_bill_scenario_id(Option<String>):
    required: true
    

    The ID of the Bill Scenario for which you want to create a Bill estimate.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Bill estimate that will be created. Names must be unique for an account.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
• On success, responds with CreateBillEstimateOutput with field(s):
  • id(String):

    The unique identifier of your newly created Bill estimate.

  • name(Option<String>):

    The name of your newly created Bill estimate.

  • status(Option<BillEstimateStatus>):

    The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

  • failure_message(Option<String>):

    This attribute provides the reason if a Bill estimate result generation fails.

  • bill_interval(Option<BillInterval>):

    The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.

  • cost_summary(Option<BillEstimateCostSummary>):

    Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.

  • created_at(Option<DateTime>):

    The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).

  • expires_at(Option<DateTime>):

    The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.

  • group_sharing_preference(Option<GroupSharingPreferenceEnum>):

    The setting for the reserved instance and savings plan group sharing used in this estimate.

  • cost_category_group_sharing_preference_arn(Option<String>):

    The arn of the cost category used in the reserved and prioritized group sharing.

  • cost_category_group_sharing_preference_effective_date(Option<DateTime>):

    Timestamp of the effective date of the cost category used in the group sharing settings.

• On failure, responds with SdkError<CreateBillEstimateError>

impl Client

pub fn create_bill_scenario(&self) -> CreateBillScenarioFluentBuilder

Constructs a fluent builder for the CreateBillScenario operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A descriptive name for the bill scenario.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to apply to the bill scenario.

    
    
  • group_sharing_preference(GroupSharingPreferenceEnum) / set_group_sharing_preference(Option<GroupSharingPreferenceEnum>):
    required: false
    

    The setting for the reserved instance and savings plan group sharing used in this estimate.

    
    
  • cost_category_group_sharing_preference_arn(impl Into<String>) / set_cost_category_group_sharing_preference_arn(Option<String>):
    required: false
    

    The arn of the cost category used in the reserved and prioritized group sharing.

    
    
• On success, responds with CreateBillScenarioOutput with field(s):
  • id(String):

    The unique identifier for the created bill scenario.

  • name(Option<String>):

    The name of the created bill scenario.

  • bill_interval(Option<BillInterval>):

    The time period covered by the bill scenario.

  • status(Option<BillScenarioStatus>):

    The current status of the bill scenario.

  • created_at(Option<DateTime>):

    The timestamp when the bill scenario was created.

  • expires_at(Option<DateTime>):

    The timestamp when the bill scenario will expire.

  • failure_message(Option<String>):

    An error message if the bill scenario creation failed.

  • group_sharing_preference(Option<GroupSharingPreferenceEnum>):

    The setting for the reserved instance and savings plan group sharing used in this estimate.

  • cost_category_group_sharing_preference_arn(Option<String>):

    The arn of the cost category used in the reserved and prioritized group sharing.

• On failure, responds with SdkError<CreateBillScenarioError>

impl Client

pub fn create_workload_estimate(&self) -> CreateWorkloadEstimateFluentBuilder

Constructs a fluent builder for the CreateWorkloadEstimate operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A descriptive name for the workload estimate.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
  • rate_type(WorkloadEstimateRateType) / set_rate_type(Option<WorkloadEstimateRateType>):
    required: false
    

    The type of pricing rates to use for the estimate.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to apply to the workload estimate.

    
    
• On success, responds with CreateWorkloadEstimateOutput with field(s):
  • id(String):

    The unique identifier for the created workload estimate.

  • name(Option<String>):

    The name of the created workload estimate.

  • created_at(Option<DateTime>):

    The timestamp when the workload estimate was created.

  • expires_at(Option<DateTime>):

    The timestamp when the workload estimate will expire.

  • rate_type(Option<WorkloadEstimateRateType>):

    The type of pricing rates used for the estimate.

  • rate_timestamp(Option<DateTime>):

    The timestamp of the pricing rates used for the estimate.

  • status(Option<WorkloadEstimateStatus>):

    The current status of the workload estimate.

  • total_cost(Option<f64>):

    The total estimated cost for the workload.

  • cost_currency(Option<CurrencyCode>):

    The currency of the estimated cost.

  • failure_message(Option<String>):

    An error message if the workload estimate creation failed.

• On failure, responds with SdkError<CreateWorkloadEstimateError>

impl Client

pub fn delete_bill_estimate(&self) -> DeleteBillEstimateFluentBuilder

Constructs a fluent builder for the DeleteBillEstimate operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the bill estimate to delete.

    
    
• On success, responds with DeleteBillEstimateOutput
• On failure, responds with SdkError<DeleteBillEstimateError>

impl Client

pub fn delete_bill_scenario(&self) -> DeleteBillScenarioFluentBuilder

Constructs a fluent builder for the DeleteBillScenario operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the bill scenario to delete.

    
    
• On success, responds with DeleteBillScenarioOutput
• On failure, responds with SdkError<DeleteBillScenarioError>

impl Client

pub fn delete_workload_estimate(&self) -> DeleteWorkloadEstimateFluentBuilder

Constructs a fluent builder for the DeleteWorkloadEstimate operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the workload estimate to delete.

    
    
• On success, responds with DeleteWorkloadEstimateOutput
• On failure, responds with SdkError<DeleteWorkloadEstimateError>

impl Client

pub fn get_bill_estimate(&self) -> GetBillEstimateFluentBuilder

Constructs a fluent builder for the GetBillEstimate operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the bill estimate to retrieve.

    
    
• On success, responds with GetBillEstimateOutput with field(s):
  • id(String):

    The unique identifier of the retrieved bill estimate.

  • name(Option<String>):

    The name of the retrieved bill estimate.

  • status(Option<BillEstimateStatus>):

    The current status of the bill estimate.

  • failure_message(Option<String>):

    An error message if the bill estimate retrieval failed.

  • bill_interval(Option<BillInterval>):

    The time period covered by the bill estimate.

  • cost_summary(Option<BillEstimateCostSummary>):

    A summary of the estimated costs.

  • created_at(Option<DateTime>):

    The timestamp when the bill estimate was created.

  • expires_at(Option<DateTime>):

    The timestamp when the bill estimate will expire.

  • group_sharing_preference(Option<GroupSharingPreferenceEnum>):

    The setting for the reserved instance and savings plan group sharing used in this estimate.

  • cost_category_group_sharing_preference_arn(Option<String>):

    The arn of the cost category used in the reserved and prioritized group sharing.

  • cost_category_group_sharing_preference_effective_date(Option<DateTime>):

    Timestamp of the effective date of the cost category used in the group sharing settings.

• On failure, responds with SdkError<GetBillEstimateError>

impl Client

pub fn get_bill_scenario(&self) -> GetBillScenarioFluentBuilder

Constructs a fluent builder for the GetBillScenario operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the bill scenario to retrieve.

    
    
• On success, responds with GetBillScenarioOutput with field(s):
  • id(String):

    The unique identifier of the retrieved bill scenario.

  • name(Option<String>):

    The name of the retrieved bill scenario.

  • bill_interval(Option<BillInterval>):

    The time period covered by the bill scenario.

  • status(Option<BillScenarioStatus>):

    The current status of the bill scenario.

  • created_at(Option<DateTime>):

    The timestamp when the bill scenario was created.

  • expires_at(Option<DateTime>):

    The timestamp when the bill scenario will expire.

  • failure_message(Option<String>):

    An error message if the bill scenario retrieval failed.

  • group_sharing_preference(Option<GroupSharingPreferenceEnum>):

    The setting for the reserved instance and savings plan group sharing used in this estimate.

  • cost_category_group_sharing_preference_arn(Option<String>):

    The arn of the cost category used in the reserved and prioritized group sharing.

• On failure, responds with SdkError<GetBillScenarioError>

impl Client

pub fn get_preferences(&self) -> GetPreferencesFluentBuilder

Constructs a fluent builder for the GetPreferences operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetPreferencesOutput with field(s):
  • management_account_rate_type_selections(Option<Vec::<RateType>>):

    The preferred rate types for the management account.

  • member_account_rate_type_selections(Option<Vec::<RateType>>):

    The preferred rate types for member accounts.

  • standalone_account_rate_type_selections(Option<Vec::<RateType>>):

    The preferred rate types for a standalone account.

• On failure, responds with SdkError<GetPreferencesError>

impl Client

pub fn get_workload_estimate(&self) -> GetWorkloadEstimateFluentBuilder

Constructs a fluent builder for the GetWorkloadEstimate operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the workload estimate to retrieve.

    
    
• On success, responds with GetWorkloadEstimateOutput with field(s):
  • id(String):

    The unique identifier of the retrieved workload estimate.

  • name(Option<String>):

    The name of the retrieved workload estimate.

  • created_at(Option<DateTime>):

    The timestamp when the workload estimate was created.

  • expires_at(Option<DateTime>):

    The timestamp when the workload estimate will expire.

  • rate_type(Option<WorkloadEstimateRateType>):

    The type of pricing rates used for the estimate.

  • rate_timestamp(Option<DateTime>):

    The timestamp of the pricing rates used for the estimate.

  • status(Option<WorkloadEstimateStatus>):

    The current status of the workload estimate.

  • total_cost(Option<f64>):

    The total estimated cost for the workload.

  • cost_currency(Option<CurrencyCode>):

    The currency of the estimated cost.

  • failure_message(Option<String>):

    An error message if the workload estimate retrieval failed.

• On failure, responds with SdkError<GetWorkloadEstimateError>

impl Client

pub fn list_bill_estimate_commitments( &self, ) -> ListBillEstimateCommitmentsFluentBuilder

Constructs a fluent builder for the ListBillEstimateCommitments operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bill_estimate_id(impl Into<String>) / set_bill_estimate_id(Option<String>):
    required: true
    

    The unique identifier of the bill estimate to list commitments for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListBillEstimateCommitmentsOutput with field(s):
  • items(Option<Vec::<BillEstimateCommitmentSummary>>):

    The list of commitments associated with the bill estimate.

  • next_token(Option<String>):

    A token to retrieve the next page of results, if any.

• On failure, responds with SdkError<ListBillEstimateCommitmentsError>

impl Client

pub fn list_bill_estimate_input_commitment_modifications( &self, ) -> ListBillEstimateInputCommitmentModificationsFluentBuilder

Constructs a fluent builder for the ListBillEstimateInputCommitmentModifications operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bill_estimate_id(impl Into<String>) / set_bill_estimate_id(Option<String>):
    required: true
    

    The unique identifier of the bill estimate to list input commitment modifications for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListBillEstimateInputCommitmentModificationsOutput with field(s):
  • items(Option<Vec::<BillEstimateInputCommitmentModificationSummary>>):

    The list of input commitment modifications associated with the bill estimate.

  • next_token(Option<String>):

    A token to retrieve the next page of results, if any.

• On failure, responds with SdkError<ListBillEstimateInputCommitmentModificationsError>

impl Client

pub fn list_bill_estimate_input_usage_modifications( &self, ) -> ListBillEstimateInputUsageModificationsFluentBuilder

Constructs a fluent builder for the ListBillEstimateInputUsageModifications operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bill_estimate_id(impl Into<String>) / set_bill_estimate_id(Option<String>):
    required: true
    

    The unique identifier of the bill estimate to list input usage modifications for.

    
    
  • filters(ListUsageFilter) / set_filters(Option<Vec::<ListUsageFilter>>):
    required: false
    

    Filters to apply to the list of input usage modifications.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListBillEstimateInputUsageModificationsOutput with field(s):
  • items(Option<Vec::<BillEstimateInputUsageModificationSummary>>):

    The list of input usage modifications associated with the bill estimate.

  • next_token(Option<String>):

    A token to retrieve the next page of results, if any.

• On failure, responds with SdkError<ListBillEstimateInputUsageModificationsError>

impl Client

pub fn list_bill_estimate_line_items( &self, ) -> ListBillEstimateLineItemsFluentBuilder

Constructs a fluent builder for the ListBillEstimateLineItems operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bill_estimate_id(impl Into<String>) / set_bill_estimate_id(Option<String>):
    required: true
    

    The unique identifier of the bill estimate to list line items for.

    
    
  • filters(ListBillEstimateLineItemsFilter) / set_filters(Option<Vec::<ListBillEstimateLineItemsFilter>>):
    required: false
    

    Filters to apply to the list of line items.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListBillEstimateLineItemsOutput with field(s):
  • items(Option<Vec::<BillEstimateLineItemSummary>>):

    The list of line items associated with the bill estimate.

  • next_token(Option<String>):

    A token to retrieve the next page of results, if any.

• On failure, responds with SdkError<ListBillEstimateLineItemsError>

impl Client

pub fn list_bill_estimates(&self) -> ListBillEstimatesFluentBuilder

Constructs a fluent builder for the ListBillEstimates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(ListBillEstimatesFilter) / set_filters(Option<Vec::<ListBillEstimatesFilter>>):
    required: false
    

    Filters to apply to the list of bill estimates.

    
    
  • created_at_filter(FilterTimestamp) / set_created_at_filter(Option<FilterTimestamp>):
    required: false
    

    Filter bill estimates based on the creation date.

    
    
  • expires_at_filter(FilterTimestamp) / set_expires_at_filter(Option<FilterTimestamp>):
    required: false
    

    Filter bill estimates based on the expiration date.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListBillEstimatesOutput with field(s):
  • items(Option<Vec::<BillEstimateSummary>>):

    The list of bill estimates for the account.

  • next_token(Option<String>):

    A token to retrieve the next page of results, if any.

• On failure, responds with SdkError<ListBillEstimatesError>

impl Client

pub fn list_bill_scenario_commitment_modifications( &self, ) -> ListBillScenarioCommitmentModificationsFluentBuilder

Constructs a fluent builder for the ListBillScenarioCommitmentModifications operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bill_scenario_id(impl Into<String>) / set_bill_scenario_id(Option<String>):
    required: true
    

    The unique identifier of the bill scenario to list commitment modifications for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListBillScenarioCommitmentModificationsOutput with field(s):
  • items(Option<Vec::<BillScenarioCommitmentModificationItem>>):

    The list of commitment modifications associated with the bill scenario.

  • next_token(Option<String>):

    A token to retrieve the next page of results, if any.

• On failure, responds with SdkError<ListBillScenarioCommitmentModificationsError>

impl Client

pub fn list_bill_scenario_usage_modifications( &self, ) -> ListBillScenarioUsageModificationsFluentBuilder

Constructs a fluent builder for the ListBillScenarioUsageModifications operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bill_scenario_id(impl Into<String>) / set_bill_scenario_id(Option<String>):
    required: true
    

    The unique identifier of the bill scenario to list usage modifications for.

    
    
  • filters(ListUsageFilter) / set_filters(Option<Vec::<ListUsageFilter>>):
    required: false
    

    Filters to apply to the list of usage modifications.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListBillScenarioUsageModificationsOutput with field(s):
  • items(Option<Vec::<BillScenarioUsageModificationItem>>):

    The list of usage modifications associated with the bill scenario.

  • next_token(Option<String>):

    A token to retrieve the next page of results, if any.

• On failure, responds with SdkError<ListBillScenarioUsageModificationsError>

impl Client

pub fn list_bill_scenarios(&self) -> ListBillScenariosFluentBuilder

Constructs a fluent builder for the ListBillScenarios operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(ListBillScenariosFilter) / set_filters(Option<Vec::<ListBillScenariosFilter>>):
    required: false
    

    Filters to apply to the list of bill scenarios.

    
    
  • created_at_filter(FilterTimestamp) / set_created_at_filter(Option<FilterTimestamp>):
    required: false
    

    Filter bill scenarios based on the creation date.

    
    
  • expires_at_filter(FilterTimestamp) / set_expires_at_filter(Option<FilterTimestamp>):
    required: false
    

    Filter bill scenarios based on the expiration date.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListBillScenariosOutput with field(s):
  • items(Option<Vec::<BillScenarioSummary>>):

    The list of bill scenarios for the account.

  • next_token(Option<String>):

    A token to retrieve the next page of results, if any.

• On failure, responds with SdkError<ListBillScenariosError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to list tags for.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The list of tags associated with the specified resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_workload_estimate_usage( &self, ) -> ListWorkloadEstimateUsageFluentBuilder

Constructs a fluent builder for the ListWorkloadEstimateUsage operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workload_estimate_id(impl Into<String>) / set_workload_estimate_id(Option<String>):
    required: true
    

    The unique identifier of the workload estimate to list usage for.

    
    
  • filters(ListUsageFilter) / set_filters(Option<Vec::<ListUsageFilter>>):
    required: false
    

    Filters to apply to the list of usage items.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListWorkloadEstimateUsageOutput with field(s):
  • items(Option<Vec::<WorkloadEstimateUsageItem>>):

    The list of usage items associated with the workload estimate.

  • next_token(Option<String>):

    A token to retrieve the next page of results, if any.

• On failure, responds with SdkError<ListWorkloadEstimateUsageError>

impl Client

pub fn list_workload_estimates(&self) -> ListWorkloadEstimatesFluentBuilder

Constructs a fluent builder for the ListWorkloadEstimates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • created_at_filter(FilterTimestamp) / set_created_at_filter(Option<FilterTimestamp>):
    required: false
    

    Filter workload estimates based on the creation date.

    
    
  • expires_at_filter(FilterTimestamp) / set_expires_at_filter(Option<FilterTimestamp>):
    required: false
    

    Filter workload estimates based on the expiration date.

    
    
  • filters(ListWorkloadEstimatesFilter) / set_filters(Option<Vec::<ListWorkloadEstimatesFilter>>):
    required: false
    

    Filters to apply to the list of workload estimates.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListWorkloadEstimatesOutput with field(s):
  • items(Option<Vec::<WorkloadEstimateSummary>>):

    The list of workload estimates for the account.

  • next_token(Option<String>):

    A token to retrieve the next page of results, if any.

• On failure, responds with SdkError<ListWorkloadEstimatesError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to add tags to.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags to add to the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to remove tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_bill_estimate(&self) -> UpdateBillEstimateFluentBuilder

Constructs a fluent builder for the UpdateBillEstimate operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the bill estimate to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The new name for the bill estimate.

    
    
  • expires_at(DateTime) / set_expires_at(Option<DateTime>):
    required: false
    

    The new expiration date for the bill estimate.

    
    
• On success, responds with UpdateBillEstimateOutput with field(s):
  • id(String):

    The unique identifier of the updated bill estimate.

  • name(Option<String>):

    The updated name of the bill estimate.

  • status(Option<BillEstimateStatus>):

    The current status of the updated bill estimate.

  • failure_message(Option<String>):

    An error message if the bill estimate update failed.

  • bill_interval(Option<BillInterval>):

    The time period covered by the updated bill estimate.

  • cost_summary(Option<BillEstimateCostSummary>):

    A summary of the updated estimated costs.

  • created_at(Option<DateTime>):

    The timestamp when the bill estimate was originally created.

  • expires_at(Option<DateTime>):

    The updated expiration timestamp for the bill estimate.

  • group_sharing_preference(Option<GroupSharingPreferenceEnum>):

    The setting for the reserved instance and savings plan group sharing used in this estimate.

  • cost_category_group_sharing_preference_arn(Option<String>):

    The arn of the cost category used in the reserved and prioritized group sharing.

  • cost_category_group_sharing_preference_effective_date(Option<DateTime>):

    Timestamp of the effective date of the cost category used in the group sharing settings.

• On failure, responds with SdkError<UpdateBillEstimateError>

impl Client

pub fn update_bill_scenario(&self) -> UpdateBillScenarioFluentBuilder

Constructs a fluent builder for the UpdateBillScenario operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the bill scenario to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The new name for the bill scenario.

    
    
  • expires_at(DateTime) / set_expires_at(Option<DateTime>):
    required: false
    

    The new expiration date for the bill scenario.

    
    
  • group_sharing_preference(GroupSharingPreferenceEnum) / set_group_sharing_preference(Option<GroupSharingPreferenceEnum>):
    required: false
    

    The setting for the reserved instance and savings plan group sharing used in this estimate.

    
    
  • cost_category_group_sharing_preference_arn(impl Into<String>) / set_cost_category_group_sharing_preference_arn(Option<String>):
    required: false
    

    The arn of the cost category used in the reserved and prioritized group sharing.

    
    
• On success, responds with UpdateBillScenarioOutput with field(s):
  • id(String):

    The unique identifier of the updated bill scenario.

  • name(Option<String>):

    The updated name of the bill scenario.

  • bill_interval(Option<BillInterval>):

    The time period covered by the updated bill scenario.

  • status(Option<BillScenarioStatus>):

    The current status of the updated bill scenario.

  • created_at(Option<DateTime>):

    The timestamp when the bill scenario was originally created.

  • expires_at(Option<DateTime>):

    The updated expiration timestamp for the bill scenario.

  • failure_message(Option<String>):

    An error message if the bill scenario update failed.

  • group_sharing_preference(Option<GroupSharingPreferenceEnum>):

    The setting for the reserved instance and savings plan group sharing used in this estimate.

  • cost_category_group_sharing_preference_arn(Option<String>):

    The arn of the cost category used in the reserved and prioritized group sharing.

• On failure, responds with SdkError<UpdateBillScenarioError>

impl Client

pub fn update_preferences(&self) -> UpdatePreferencesFluentBuilder

Constructs a fluent builder for the UpdatePreferences operation.

• The fluent builder is configurable:
  • management_account_rate_type_selections(RateType) / set_management_account_rate_type_selections(Option<Vec::<RateType>>):
    required: false
    

    The updated preferred rate types for the management account.

    
    
  • member_account_rate_type_selections(RateType) / set_member_account_rate_type_selections(Option<Vec::<RateType>>):
    required: false
    

    The updated preferred rate types for member accounts.

    
    
  • standalone_account_rate_type_selections(RateType) / set_standalone_account_rate_type_selections(Option<Vec::<RateType>>):
    required: false
    

    The updated preferred rate types for a standalone account.

    
    
• On success, responds with UpdatePreferencesOutput with field(s):
  • management_account_rate_type_selections(Option<Vec::<RateType>>):

    The updated preferred rate types for the management account.

  • member_account_rate_type_selections(Option<Vec::<RateType>>):

    The updated preferred rate types for member accounts.

  • standalone_account_rate_type_selections(Option<Vec::<RateType>>):

    The updated preferred rate types for a standalone account.

• On failure, responds with SdkError<UpdatePreferencesError>

impl Client

pub fn update_workload_estimate(&self) -> UpdateWorkloadEstimateFluentBuilder

Constructs a fluent builder for the UpdateWorkloadEstimate operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the workload estimate to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The new name for the workload estimate.

    
    
  • expires_at(DateTime) / set_expires_at(Option<DateTime>):
    required: false
    

    The new expiration date for the workload estimate.

    
    
• On success, responds with UpdateWorkloadEstimateOutput with field(s):
  • id(String):

    The unique identifier of the updated workload estimate.

  • name(Option<String>):

    The updated name of the workload estimate.

  • created_at(Option<DateTime>):

    The timestamp when the workload estimate was originally created.

  • expires_at(Option<DateTime>):

    The updated expiration timestamp for the workload estimate.

  • rate_type(Option<WorkloadEstimateRateType>):

    The type of pricing rates used for the updated estimate.

  • rate_timestamp(Option<DateTime>):

    The timestamp of the pricing rates used for the updated estimate.

  • status(Option<WorkloadEstimateStatus>):

    The current status of the updated workload estimate.

  • total_cost(Option<f64>):

    The updated total estimated cost for the workload.

  • cost_currency(Option<CurrencyCode>):

    The currency of the updated estimated cost.

  • failure_message(Option<String>):

    An error message if the workload estimate update failed.

• On failure, responds with SdkError<UpdateWorkloadEstimateError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.