Class: Aws::BCMPricingCalculator::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::BCMPricingCalculator::Client

Includes:

ClientStubs

Defined in:

lib/aws-sdk-bcmpricingcalculator/client.rb

Overview

An API client for BCMPricingCalculator. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::BCMPricingCalculator::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary

• .identifier ⇒ Object readonly private

API Operations

• #batch_create_bill_scenario_commitment_modification(params = {}) ⇒ Types::BatchCreateBillScenarioCommitmentModificationResponse

  Create Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario.

• #batch_create_bill_scenario_usage_modification(params = {}) ⇒ Types::BatchCreateBillScenarioUsageModificationResponse

  Create Amazon Web Services service usage that you want to model in a Bill Scenario.

• #batch_create_workload_estimate_usage(params = {}) ⇒ Types::BatchCreateWorkloadEstimateUsageResponse

  Create Amazon Web Services service usage that you want to model in a Workload Estimate.

• #batch_delete_bill_scenario_commitment_modification(params = {}) ⇒ Types::BatchDeleteBillScenarioCommitmentModificationResponse

  Delete commitment that you have created in a Bill Scenario.

• #batch_delete_bill_scenario_usage_modification(params = {}) ⇒ Types::BatchDeleteBillScenarioUsageModificationResponse

  Delete usage that you have created in a Bill Scenario.

• #batch_delete_workload_estimate_usage(params = {}) ⇒ Types::BatchDeleteWorkloadEstimateUsageResponse

  Delete usage that you have created in a Workload estimate.

• #batch_update_bill_scenario_commitment_modification(params = {}) ⇒ Types::BatchUpdateBillScenarioCommitmentModificationResponse

  Update a newly added or existing commitment.

• #batch_update_bill_scenario_usage_modification(params = {}) ⇒ Types::BatchUpdateBillScenarioUsageModificationResponse

  Update a newly added or existing usage lines.

• #batch_update_workload_estimate_usage(params = {}) ⇒ Types::BatchUpdateWorkloadEstimateUsageResponse

  Update a newly added or existing usage lines.

• #create_bill_estimate(params = {}) ⇒ Types::CreateBillEstimateResponse

  Create a Bill estimate from a Bill scenario.

• #create_bill_scenario(params = {}) ⇒ Types::CreateBillScenarioResponse

  Creates a new bill scenario to model potential changes to Amazon Web Services usage and costs.

• #create_workload_estimate(params = {}) ⇒ Types::CreateWorkloadEstimateResponse

  Creates a new workload estimate to model costs for a specific workload.

• #delete_bill_estimate(params = {}) ⇒ Struct

  Deletes an existing bill estimate.

• #delete_bill_scenario(params = {}) ⇒ Struct

  Deletes an existing bill scenario.

• #delete_workload_estimate(params = {}) ⇒ Struct

  Deletes an existing workload estimate.

• #get_bill_estimate(params = {}) ⇒ Types::GetBillEstimateResponse

  Retrieves details of a specific bill estimate.

• #get_bill_scenario(params = {}) ⇒ Types::GetBillScenarioResponse

  Retrieves details of a specific bill scenario.

• #get_preferences(params = {}) ⇒ Types::GetPreferencesResponse

  Retrieves the current preferences for Pricing Calculator.

• #get_workload_estimate(params = {}) ⇒ Types::GetWorkloadEstimateResponse

  Retrieves details of a specific workload estimate.

• #list_bill_estimate_commitments(params = {}) ⇒ Types::ListBillEstimateCommitmentsResponse

  Lists the commitments associated with a bill estimate.

• #list_bill_estimate_input_commitment_modifications(params = {}) ⇒ Types::ListBillEstimateInputCommitmentModificationsResponse

  Lists the input commitment modifications associated with a bill estimate.

• #list_bill_estimate_input_usage_modifications(params = {}) ⇒ Types::ListBillEstimateInputUsageModificationsResponse

  Lists the input usage modifications associated with a bill estimate.

• #list_bill_estimate_line_items(params = {}) ⇒ Types::ListBillEstimateLineItemsResponse

  Lists the line items associated with a bill estimate.

• #list_bill_estimates(params = {}) ⇒ Types::ListBillEstimatesResponse

  Lists all bill estimates for the account.

• #list_bill_scenario_commitment_modifications(params = {}) ⇒ Types::ListBillScenarioCommitmentModificationsResponse

  Lists the commitment modifications associated with a bill scenario.

• #list_bill_scenario_usage_modifications(params = {}) ⇒ Types::ListBillScenarioUsageModificationsResponse

  Lists the usage modifications associated with a bill scenario.

• #list_bill_scenarios(params = {}) ⇒ Types::ListBillScenariosResponse

  Lists all bill scenarios for the account.

• #list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

  Lists all tags associated with a specified resource.

• #list_workload_estimate_usage(params = {}) ⇒ Types::ListWorkloadEstimateUsageResponse

  Lists the usage associated with a workload estimate.

• #list_workload_estimates(params = {}) ⇒ Types::ListWorkloadEstimatesResponse

  Lists all workload estimates for the account.

• #tag_resource(params = {}) ⇒ Struct

  Adds one or more tags to a specified resource.

• #untag_resource(params = {}) ⇒ Struct

  Removes one or more tags from a specified resource.

• #update_bill_estimate(params = {}) ⇒ Types::UpdateBillEstimateResponse

  Updates an existing bill estimate.

• #update_bill_scenario(params = {}) ⇒ Types::UpdateBillScenarioResponse

  Updates an existing bill scenario.

• #update_preferences(params = {}) ⇒ Types::UpdatePreferencesResponse

  Updates the preferences for Pricing Calculator.

• #update_workload_estimate(params = {}) ⇒ Types::UpdateWorkloadEstimateResponse

  Updates an existing workload estimate.

Class Method Summary

• .errors_module ⇒ Object private

Instance Method Summary

• #build_request(operation_name, params = {}) ⇒ Object private
• #initialize(options) ⇒ Client constructor

  A new instance of Client.

• #waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

• options (Hash)

Options Hash (options):

• :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

  A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

• :credentials (required, Aws::CredentialProvider) —

  Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

  • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

  • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

  • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

  • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

  • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

  • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

  • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

  • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

  • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

  When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

  • ‘Aws.config`

  • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

  • ‘ENV`, `ENV`, `ENV`, and `ENV`.

  • ‘~/.aws/credentials`

  • ‘~/.aws/config`

  • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

• :region (required, String) —

  The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • ‘Aws.config`

  • ‘ENV`

  • ‘ENV`

  • ‘ENV`

  • ‘~/.aws/credentials`

  • ‘~/.aws/config`

• :access_key_id (String)
• :account_id (String)
• :active_endpoint_cache (Boolean) — default: false —

  When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

• :adaptive_retry_wait_to_fill (Boolean) — default: true —

  Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

• :auth_scheme_preference (Array<String>) —

  A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

• :client_side_monitoring (Boolean) — default: false —

  When ‘true`, client-side metrics will be collected for all API requests from this client.

• :client_side_monitoring_client_id (String) — default: "" —

  Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

• :client_side_monitoring_host (String) — default: "127.0.0.1" —

  Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

• :client_side_monitoring_port (Integer) — default: 31000 —

  Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

• :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

  Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

• :convert_params (Boolean) — default: true —

  When ‘true`, an attempt is made to coerce request parameters into the required types.

• :correct_clock_skew (Boolean) — default: true —

  Used only in ‘standard` and `adaptive` retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

• :defaults_mode (String) — default: "legacy" —

  See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

• :disable_host_prefix_injection (Boolean) — default: false —

  When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

• :disable_request_compression (Boolean) — default: false —

  When set to ‘true’ the request body will not be compressed for supported operations.

• :endpoint (String, URI::HTTPS, URI::HTTP) —

  Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

  'http://example.com'
  'https://example.com'
  'http://example.com:123'
  

• :endpoint_cache_max_entries (Integer) — default: 1000 —

  Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

• :endpoint_cache_max_threads (Integer) — default: 10 —

  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

• :endpoint_cache_poll_interval (Integer) — default: 60 —

  When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

• :endpoint_discovery (Boolean) — default: false —

  When set to ‘true`, endpoint discovery will be enabled for operations when available.

• :ignore_configured_endpoint_urls (Boolean) —

  Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

• :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

  The log formatter.

• :log_level (Symbol) — default: :info —

  The log level to send messages to the ‘:logger` at.

• :logger (Logger) —

  The Logger instance to send log messages to. If this option is not set, logging will be disabled.

• :max_attempts (Integer) — default: 3 —

  An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

• :profile (String) — default: "default" —

  Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

• :request_checksum_calculation (String) — default: "when_supported" —

  Determines when a checksum will be calculated for request payloads. Values are:

  • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

  • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

• :request_min_compression_size_bytes (Integer) — default: 10240 —

  The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

• :response_checksum_validation (String) — default: "when_supported" —

  Determines when checksum validation will be performed on response payloads. Values are:

  • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

  • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

• :retry_backoff (Proc) —

  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

• :retry_base_delay (Float) — default: 0.3 —

  The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

• :retry_jitter (Symbol) — default: :none —

  A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

  @see www.awsarchitectureblog.com/2015/03/backoff.html

• :retry_limit (Integer) — default: 3 —

  The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

• :retry_max_delay (Integer) — default: 0 —

  The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

• :retry_mode (String) — default: "legacy" —

  Specifies which retry algorithm to use. Values are:

  • ‘legacy` - The pre-existing retry behavior. This is the default value if no retry mode is provided.

  • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

  • ‘adaptive` - A retry mode that includes all the functionality of `standard` mode along with automatic client side throttling.

• :sdk_ua_app_id (String) —

  A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

• :secret_access_key (String)
• :session_token (String)
• :sigv4a_signing_region_set (Array) —

  A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • ‘Aws.config`

  • ‘ENV`

  • ‘~/.aws/config`

• :simple_json (Boolean) — default: false —

  Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

• :stub_responses (Boolean) — default: false —

  Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

  ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

• :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

  Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

  • OpenTelemetry (OTel) - To use the OTel provider, install and require the

  ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

• :token_provider (Aws::TokenProvider) —

  Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

  • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

  • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

  When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

• :use_dualstack_endpoint (Boolean) —

  When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

• :use_fips_endpoint (Boolean) —

  When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

• :validate_params (Boolean) — default: true —

  When ‘true`, request parameters are validated before sending the request.

• :endpoint_provider (Aws::BCMPricingCalculator::EndpointProvider) —

  The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::BCMPricingCalculator::EndpointParameters`.

• :http_continue_timeout (Float) — default: 1 —

  The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

• :http_idle_timeout (Float) — default: 5 —

  The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

• :http_open_timeout (Float) — default: 15 —

  The default number of seconds to wait for response data. This value can safely be set per-request on the session.

• :http_proxy (URI::HTTP, String) —

  A proxy to send requests through. Formatted like ‘proxy.com:123’.

• :http_read_timeout (Float) — default: 60 —

  The default number of seconds to wait for response data. This value can safely be set per-request on the session.

• :http_wire_trace (Boolean) — default: false —

  When ‘true`, HTTP debug output will be sent to the `:logger`.

• :on_chunk_received (Proc) —

  When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

• :on_chunk_sent (Proc) —

  When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

• :raise_response_errors (Boolean) — default: true —

  When ‘true`, response errors are raised.

• :ssl_ca_bundle (String) —

  Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

• :ssl_ca_directory (String) —

  Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

• :ssl_ca_store (String) —

  Sets the X509::Store to verify peer certificate.

• :ssl_cert (OpenSSL::X509::Certificate) —

  Sets a client certificate when creating http connections.

• :ssl_key (OpenSSL::PKey) —

  Sets a client key when creating http connections.

• :ssl_timeout (Float) —

  Sets the SSL timeout in seconds

• :ssl_verify_peer (Boolean) — default: true —

  When ‘true`, SSL peer certificates are verified when establishing a connection.

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 478

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2796

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2799

def errors_module
  Errors
end

Instance Method Details

#batch_create_bill_scenario_commitment_modification(params = {}) ⇒ Types::BatchCreateBillScenarioCommitmentModificationResponse

Create Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario.

<note markdown=“1”> The ‘BatchCreateBillScenarioCommitmentModification` operation doesn’t have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission ‘bcm-pricing-calculator:CreateBillScenarioCommitmentModification` in your policies.

</note>

Examples:

Request syntax with placeholder values

resp = client.batch_create_bill_scenario_commitment_modification({
  bill_scenario_id: "ResourceId", # required
  commitment_modifications: [ # required
    {
      key: "Key", # required
      group: "UsageGroup",
      usage_account_id: "AccountId", # required
      commitment_action: { # required
        add_reserved_instance_action: {
          reserved_instances_offering_id: "Uuid",
          instance_count: 1,
        },
        add_savings_plan_action: {
          savings_plan_offering_id: "Uuid",
          commitment: 1.0,
        },
        negate_reserved_instance_action: {
          reserved_instances_id: "Uuid",
        },
        negate_savings_plan_action: {
          savings_plan_id: "Uuid",
        },
      },
    },
  ],
  client_token: "ClientToken",
})

Response structure

resp.items #=> Array
resp.items[0].key #=> String
resp.items[0].id #=> String
resp.items[0].group #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].commitment_action.add_reserved_instance_action.reserved_instances_offering_id #=> String
resp.items[0].commitment_action.add_reserved_instance_action.instance_count #=> Integer
resp.items[0].commitment_action.add_savings_plan_action.savings_plan_offering_id #=> String
resp.items[0].commitment_action.add_savings_plan_action.commitment #=> Float
resp.items[0].commitment_action.negate_reserved_instance_action.reserved_instances_id #=> String
resp.items[0].commitment_action.negate_savings_plan_action.savings_plan_id #=> String
resp.errors #=> Array
resp.errors[0].key #=> String
resp.errors[0].error_message #=> String
resp.errors[0].error_code #=> String, one of "CONFLICT", "INTERNAL_SERVER_ERROR", "INVALID_ACCOUNT"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_scenario_id (required, String) —

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

• :commitment_modifications (required, Array<Types::BatchCreateBillScenarioCommitmentModificationEntry>) —

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

• :client_token (String) —

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

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

• (Types::BatchCreateBillScenarioCommitmentModificationResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BatchCreateBillScenarioCommitmentModificationItem&gt;

  • #errors => Array&lt;Types::BatchCreateBillScenarioCommitmentModificationError&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 567

def batch_create_bill_scenario_commitment_modification(params = {}, options = {})
  req = build_request(:batch_create_bill_scenario_commitment_modification, params)
  req.send_request(options)
end

#batch_create_bill_scenario_usage_modification(params = {}) ⇒ Types::BatchCreateBillScenarioUsageModificationResponse

Create Amazon Web Services service usage that you want to model in a Bill Scenario.

<note markdown=“1”> The ‘BatchCreateBillScenarioUsageModification` operation doesn’t have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission ‘bcm-pricing-calculator:CreateBillScenarioUsageModification` in your policies.

</note>

Examples:

Request syntax with placeholder values

resp = client.batch_create_bill_scenario_usage_modification({
  bill_scenario_id: "ResourceId", # required
  usage_modifications: [ # required
    {
      service_code: "ServiceCode", # required
      usage_type: "UsageType", # required
      operation: "Operation", # required
      availability_zone: "AvailabilityZone",
      key: "Key", # required
      group: "UsageGroup",
      usage_account_id: "AccountId", # required
      amounts: [
        {
          start_hour: Time.now, # required
          amount: 1.0, # required
        },
      ],
      historical_usage: {
        service_code: "ServiceCode", # required
        usage_type: "UsageType", # required
        operation: "Operation", # required
        location: "String",
        usage_account_id: "AccountId", # required
        bill_interval: { # required
          start: Time.now,
          end: Time.now,
        },
        filter_expression: { # required
          and: [
            {
              # recursive Expression
            },
          ],
          or: [
            {
              # recursive Expression
            },
          ],
          not: {
            # recursive Expression
          },
          cost_categories: {
            key: "String",
            match_options: ["String"],
            values: ["String"],
          },
          dimensions: {
            key: "String",
            match_options: ["String"],
            values: ["String"],
          },
          tags: {
            key: "String",
            match_options: ["String"],
            values: ["String"],
          },
        },
      },
    },
  ],
  client_token: "ClientToken",
})

Response structure

resp.items #=> Array
resp.items[0].service_code #=> String
resp.items[0].usage_type #=> String
resp.items[0].operation #=> String
resp.items[0].location #=> String
resp.items[0].availability_zone #=> String
resp.items[0].id #=> String
resp.items[0].group #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].quantities #=> Array
resp.items[0].quantities[0].start_hour #=> Time
resp.items[0].quantities[0].unit #=> String
resp.items[0].quantities[0].amount #=> Float
resp.items[0].historical_usage.service_code #=> String
resp.items[0].historical_usage.usage_type #=> String
resp.items[0].historical_usage.operation #=> String
resp.items[0].historical_usage.location #=> String
resp.items[0].historical_usage.usage_account_id #=> String
resp.items[0].historical_usage.bill_interval.start #=> Time
resp.items[0].historical_usage.bill_interval.end #=> Time
resp.items[0].historical_usage.filter_expression.and #=> Array
resp.items[0].historical_usage.filter_expression.and[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.or #=> Array
resp.items[0].historical_usage.filter_expression.or[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.not #=> Types::Expression
resp.items[0].historical_usage.filter_expression.cost_categories.key #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.match_options #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.values #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.values[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.key #=> String
resp.items[0].historical_usage.filter_expression.dimensions.match_options #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.values #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.values[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.key #=> String
resp.items[0].historical_usage.filter_expression.tags.match_options #=> Array
resp.items[0].historical_usage.filter_expression.tags.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.values #=> Array
resp.items[0].historical_usage.filter_expression.tags.values[0] #=> String
resp.items[0].key #=> String
resp.errors #=> Array
resp.errors[0].key #=> String
resp.errors[0].error_message #=> String
resp.errors[0].error_code #=> String, one of "BAD_REQUEST", "NOT_FOUND", "CONFLICT", "INTERNAL_SERVER_ERROR"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_scenario_id (required, String) —

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

• :usage_modifications (required, Array<Types::BatchCreateBillScenarioUsageModificationEntry>) —

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

• :client_token (String) —

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

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

• (Types::BatchCreateBillScenarioUsageModificationResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BatchCreateBillScenarioUsageModificationItem&gt;

  • #errors => Array&lt;Types::BatchCreateBillScenarioUsageModificationError&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 719

def batch_create_bill_scenario_usage_modification(params = {}, options = {})
  req = build_request(:batch_create_bill_scenario_usage_modification, params)
  req.send_request(options)
end

#batch_create_workload_estimate_usage(params = {}) ⇒ Types::BatchCreateWorkloadEstimateUsageResponse

Create Amazon Web Services service usage that you want to model in a Workload Estimate.

<note markdown=“1”> The ‘BatchCreateWorkloadEstimateUsage` operation doesn’t have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission ‘bcm-pricing-calculator:CreateWorkloadEstimateUsage` in your policies.

</note>

Examples:

Request syntax with placeholder values

resp = client.batch_create_workload_estimate_usage({
  workload_estimate_id: "ResourceId", # required
  usage: [ # required
    {
      service_code: "ServiceCode", # required
      usage_type: "UsageType", # required
      operation: "Operation", # required
      key: "Key", # required
      group: "UsageGroup",
      usage_account_id: "AccountId", # required
      amount: 1.0, # required
      historical_usage: {
        service_code: "ServiceCode", # required
        usage_type: "UsageType", # required
        operation: "Operation", # required
        location: "String",
        usage_account_id: "AccountId", # required
        bill_interval: { # required
          start: Time.now,
          end: Time.now,
        },
        filter_expression: { # required
          and: [
            {
              # recursive Expression
            },
          ],
          or: [
            {
              # recursive Expression
            },
          ],
          not: {
            # recursive Expression
          },
          cost_categories: {
            key: "String",
            match_options: ["String"],
            values: ["String"],
          },
          dimensions: {
            key: "String",
            match_options: ["String"],
            values: ["String"],
          },
          tags: {
            key: "String",
            match_options: ["String"],
            values: ["String"],
          },
        },
      },
    },
  ],
  client_token: "ClientToken",
})

Response structure

resp.items #=> Array
resp.items[0].service_code #=> String
resp.items[0].usage_type #=> String
resp.items[0].operation #=> String
resp.items[0].location #=> String
resp.items[0].id #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].group #=> String
resp.items[0].quantity.unit #=> String
resp.items[0].quantity.amount #=> Float
resp.items[0].cost #=> Float
resp.items[0].currency #=> String, one of "USD"
resp.items[0].status #=> String, one of "VALID", "INVALID", "STALE"
resp.items[0].historical_usage.service_code #=> String
resp.items[0].historical_usage.usage_type #=> String
resp.items[0].historical_usage.operation #=> String
resp.items[0].historical_usage.location #=> String
resp.items[0].historical_usage.usage_account_id #=> String
resp.items[0].historical_usage.bill_interval.start #=> Time
resp.items[0].historical_usage.bill_interval.end #=> Time
resp.items[0].historical_usage.filter_expression.and #=> Array
resp.items[0].historical_usage.filter_expression.and[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.or #=> Array
resp.items[0].historical_usage.filter_expression.or[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.not #=> Types::Expression
resp.items[0].historical_usage.filter_expression.cost_categories.key #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.match_options #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.values #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.values[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.key #=> String
resp.items[0].historical_usage.filter_expression.dimensions.match_options #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.values #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.values[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.key #=> String
resp.items[0].historical_usage.filter_expression.tags.match_options #=> Array
resp.items[0].historical_usage.filter_expression.tags.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.values #=> Array
resp.items[0].historical_usage.filter_expression.tags.values[0] #=> String
resp.items[0].key #=> String
resp.errors #=> Array
resp.errors[0].key #=> String
resp.errors[0].error_code #=> String, one of "BAD_REQUEST", "NOT_FOUND", "CONFLICT", "INTERNAL_SERVER_ERROR"
resp.errors[0].error_message #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :workload_estimate_id (required, String) —

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

• :usage (required, Array<Types::BatchCreateWorkloadEstimateUsageEntry>) —

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

• :client_token (String) —

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

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

• (Types::BatchCreateWorkloadEstimateUsageResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BatchCreateWorkloadEstimateUsageItem&gt;

  • #errors => Array&lt;Types::BatchCreateWorkloadEstimateUsageError&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 864

def batch_create_workload_estimate_usage(params = {}, options = {})
  req = build_request(:batch_create_workload_estimate_usage, params)
  req.send_request(options)
end

#batch_delete_bill_scenario_commitment_modification(params = {}) ⇒ Types::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.

<note markdown=“1”> The ‘BatchDeleteBillScenarioCommitmentModification` operation doesn’t have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission ‘bcm-pricing-calculator:DeleteBillScenarioCommitmentModification` in your policies.

</note>

[1]: docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BillScenarioCommitmentModificationAction.html [2]: docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BatchCreateBillScenarioUsageModification.html

Examples:

Request syntax with placeholder values

resp = client.batch_delete_bill_scenario_commitment_modification({
  bill_scenario_id: "ResourceId", # required
  ids: ["ResourceId"], # required
})

Response structure

resp.errors #=> Array
resp.errors[0].id #=> String
resp.errors[0].error_code #=> String, one of "BAD_REQUEST", "CONFLICT", "INTERNAL_SERVER_ERROR"
resp.errors[0].error_message #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_scenario_id (required, String) —

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

• :ids (required, Array<String>) —

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

Returns:

• (Types::BatchDeleteBillScenarioCommitmentModificationResponse) —

  Returns a response object which responds to the following methods:

  • #errors => Array&lt;Types::BatchDeleteBillScenarioCommitmentModificationError&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 918

def batch_delete_bill_scenario_commitment_modification(params = {}, options = {})
  req = build_request(:batch_delete_bill_scenario_commitment_modification, params)
  req.send_request(options)
end

#batch_delete_bill_scenario_usage_modification(params = {}) ⇒ Types::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].

<note markdown=“1”> The ‘BatchDeleteBillScenarioUsageModification` operation doesn’t have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission ‘bcm-pricing-calculator:DeleteBillScenarioUsageModification` in your policies.

</note>

[1]: docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BatchUpdateBillScenarioUsageModification.html

Examples:

Request syntax with placeholder values

resp = client.batch_delete_bill_scenario_usage_modification({
  bill_scenario_id: "ResourceId", # required
  ids: ["ResourceId"], # required
})

Response structure

resp.errors #=> Array
resp.errors[0].id #=> String
resp.errors[0].error_message #=> String
resp.errors[0].error_code #=> String, one of "BAD_REQUEST", "CONFLICT", "INTERNAL_SERVER_ERROR"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_scenario_id (required, String) —

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

• :ids (required, Array<String>) —

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

Returns:

• (Types::BatchDeleteBillScenarioUsageModificationResponse) —

  Returns a response object which responds to the following methods:

  • #errors => Array&lt;Types::BatchDeleteBillScenarioUsageModificationError&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 969

def batch_delete_bill_scenario_usage_modification(params = {}, options = {})
  req = build_request(:batch_delete_bill_scenario_usage_modification, params)
  req.send_request(options)
end

#batch_delete_workload_estimate_usage(params = {}) ⇒ Types::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].

<note markdown=“1”> The ‘BatchDeleteWorkloadEstimateUsage` operation doesn’t have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission ‘bcm-pricing-calculator:DeleteWorkloadEstimateUsage` in your policies.

</note>

[1]: docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BatchUpdateWorkloadEstimateUsage.html

Examples:

Request syntax with placeholder values

resp = client.batch_delete_workload_estimate_usage({
  workload_estimate_id: "ResourceId", # required
  ids: ["ResourceId"], # required
})

Response structure

resp.errors #=> Array
resp.errors[0].id #=> String
resp.errors[0].error_message #=> String
resp.errors[0].error_code #=> String, one of "BAD_REQUEST", "NOT_FOUND", "CONFLICT", "INTERNAL_SERVER_ERROR"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :workload_estimate_id (required, String) —

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

• :ids (required, Array<String>) —

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

Returns:

• (Types::BatchDeleteWorkloadEstimateUsageResponse) —

  Returns a response object which responds to the following methods:

  • #errors => Array&lt;Types::BatchDeleteWorkloadEstimateUsageError&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1019

def batch_delete_workload_estimate_usage(params = {}, options = {})
  req = build_request(:batch_delete_workload_estimate_usage, params)
  req.send_request(options)
end

#batch_update_bill_scenario_commitment_modification(params = {}) ⇒ Types::BatchUpdateBillScenarioCommitmentModificationResponse

Update a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID.

<note markdown=“1”> The ‘BatchUpdateBillScenarioCommitmentModification` operation doesn’t have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission ‘bcm-pricing-calculator:UpdateBillScenarioCommitmentModification` in your policies.

</note>

Examples:

Request syntax with placeholder values

resp = client.batch_update_bill_scenario_commitment_modification({
  bill_scenario_id: "ResourceId", # required
  commitment_modifications: [ # required
    {
      id: "ResourceId", # required
      group: "UsageGroup",
    },
  ],
})

Response structure

resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].group #=> String
resp.items[0].commitment_action.add_reserved_instance_action.reserved_instances_offering_id #=> String
resp.items[0].commitment_action.add_reserved_instance_action.instance_count #=> Integer
resp.items[0].commitment_action.add_savings_plan_action.savings_plan_offering_id #=> String
resp.items[0].commitment_action.add_savings_plan_action.commitment #=> Float
resp.items[0].commitment_action.negate_reserved_instance_action.reserved_instances_id #=> String
resp.items[0].commitment_action.negate_savings_plan_action.savings_plan_id #=> String
resp.errors #=> Array
resp.errors[0].id #=> String
resp.errors[0].error_code #=> String, one of "BAD_REQUEST", "NOT_FOUND", "CONFLICT", "INTERNAL_SERVER_ERROR"
resp.errors[0].error_message #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_scenario_id (required, String) —

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

• :commitment_modifications (required, Array<Types::BatchUpdateBillScenarioCommitmentModificationEntry>) —

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

Returns:

• (Types::BatchUpdateBillScenarioCommitmentModificationResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BillScenarioCommitmentModificationItem&gt;

  • #errors => Array&lt;Types::BatchUpdateBillScenarioCommitmentModificationError&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1080

def batch_update_bill_scenario_commitment_modification(params = {}, options = {})
  req = build_request(:batch_update_bill_scenario_commitment_modification, params)
  req.send_request(options)
end

#batch_update_bill_scenario_usage_modification(params = {}) ⇒ Types::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.

<note markdown=“1”> The ‘BatchUpdateBillScenarioUsageModification` operation doesn’t have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission ‘bcm-pricing-calculator:UpdateBillScenarioUsageModification` in your policies.

</note>

Examples:

Request syntax with placeholder values

resp = client.batch_update_bill_scenario_usage_modification({
  bill_scenario_id: "ResourceId", # required
  usage_modifications: [ # required
    {
      id: "ResourceId", # required
      group: "UsageGroup",
      amounts: [
        {
          start_hour: Time.now, # required
          amount: 1.0, # required
        },
      ],
    },
  ],
})

Response structure

resp.items #=> Array
resp.items[0].service_code #=> String
resp.items[0].usage_type #=> String
resp.items[0].operation #=> String
resp.items[0].location #=> String
resp.items[0].availability_zone #=> String
resp.items[0].id #=> String
resp.items[0].group #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].quantities #=> Array
resp.items[0].quantities[0].start_hour #=> Time
resp.items[0].quantities[0].unit #=> String
resp.items[0].quantities[0].amount #=> Float
resp.items[0].historical_usage.service_code #=> String
resp.items[0].historical_usage.usage_type #=> String
resp.items[0].historical_usage.operation #=> String
resp.items[0].historical_usage.location #=> String
resp.items[0].historical_usage.usage_account_id #=> String
resp.items[0].historical_usage.bill_interval.start #=> Time
resp.items[0].historical_usage.bill_interval.end #=> Time
resp.items[0].historical_usage.filter_expression.and #=> Array
resp.items[0].historical_usage.filter_expression.and[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.or #=> Array
resp.items[0].historical_usage.filter_expression.or[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.not #=> Types::Expression
resp.items[0].historical_usage.filter_expression.cost_categories.key #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.match_options #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.values #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.values[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.key #=> String
resp.items[0].historical_usage.filter_expression.dimensions.match_options #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.values #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.values[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.key #=> String
resp.items[0].historical_usage.filter_expression.tags.match_options #=> Array
resp.items[0].historical_usage.filter_expression.tags.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.values #=> Array
resp.items[0].historical_usage.filter_expression.tags.values[0] #=> String
resp.errors #=> Array
resp.errors[0].id #=> String
resp.errors[0].error_message #=> String
resp.errors[0].error_code #=> String, one of "BAD_REQUEST", "NOT_FOUND", "CONFLICT", "INTERNAL_SERVER_ERROR"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_scenario_id (required, String) —

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

• :usage_modifications (required, Array<Types::BatchUpdateBillScenarioUsageModificationEntry>) —

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

Returns:

• (Types::BatchUpdateBillScenarioUsageModificationResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BillScenarioUsageModificationItem&gt;

  • #errors => Array&lt;Types::BatchUpdateBillScenarioUsageModificationError&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1179

def batch_update_bill_scenario_usage_modification(params = {}, options = {})
  req = build_request(:batch_update_bill_scenario_usage_modification, params)
  req.send_request(options)
end

#batch_update_workload_estimate_usage(params = {}) ⇒ Types::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.

<note markdown=“1”> The ‘BatchUpdateWorkloadEstimateUsage` operation doesn’t have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission ‘bcm-pricing-calculator:UpdateWorkloadEstimateUsage` in your policies.

</note>

Examples:

Request syntax with placeholder values

resp = client.batch_update_workload_estimate_usage({
  workload_estimate_id: "ResourceId", # required
  usage: [ # required
    {
      id: "ResourceId", # required
      group: "UsageGroup",
      amount: 1.0,
    },
  ],
})

Response structure

resp.items #=> Array
resp.items[0].service_code #=> String
resp.items[0].usage_type #=> String
resp.items[0].operation #=> String
resp.items[0].location #=> String
resp.items[0].id #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].group #=> String
resp.items[0].quantity.unit #=> String
resp.items[0].quantity.amount #=> Float
resp.items[0].cost #=> Float
resp.items[0].currency #=> String, one of "USD"
resp.items[0].status #=> String, one of "VALID", "INVALID", "STALE"
resp.items[0].historical_usage.service_code #=> String
resp.items[0].historical_usage.usage_type #=> String
resp.items[0].historical_usage.operation #=> String
resp.items[0].historical_usage.location #=> String
resp.items[0].historical_usage.usage_account_id #=> String
resp.items[0].historical_usage.bill_interval.start #=> Time
resp.items[0].historical_usage.bill_interval.end #=> Time
resp.items[0].historical_usage.filter_expression.and #=> Array
resp.items[0].historical_usage.filter_expression.and[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.or #=> Array
resp.items[0].historical_usage.filter_expression.or[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.not #=> Types::Expression
resp.items[0].historical_usage.filter_expression.cost_categories.key #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.match_options #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.values #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.values[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.key #=> String
resp.items[0].historical_usage.filter_expression.dimensions.match_options #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.values #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.values[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.key #=> String
resp.items[0].historical_usage.filter_expression.tags.match_options #=> Array
resp.items[0].historical_usage.filter_expression.tags.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.values #=> Array
resp.items[0].historical_usage.filter_expression.tags.values[0] #=> String
resp.errors #=> Array
resp.errors[0].id #=> String
resp.errors[0].error_message #=> String
resp.errors[0].error_code #=> String, one of "BAD_REQUEST", "NOT_FOUND", "CONFLICT", "INTERNAL_SERVER_ERROR"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :workload_estimate_id (required, String) —

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

• :usage (required, Array<Types::BatchUpdateWorkloadEstimateUsageEntry>) —

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

Returns:

• (Types::BatchUpdateWorkloadEstimateUsageResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::WorkloadEstimateUsageItem&gt;

  • #errors => Array&lt;Types::BatchUpdateWorkloadEstimateUsageError&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1272

def batch_update_workload_estimate_usage(params = {}, options = {})
  req = build_request(:batch_update_workload_estimate_usage, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

• params ({}) (defaults to: {})

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2769

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::BCMPricingCalculator')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-bcmpricingcalculator'
  context[:gem_version] = '1.28.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_bill_estimate(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values

resp = client.create_bill_estimate({
  bill_scenario_id: "ResourceId", # required
  name: "BillEstimateName", # required
  client_token: "ClientToken",
  tags: {
    "ResourceTagKey" => "ResourceTagValue",
  },
})

Response structure

resp.id #=> String
resp.name #=> String
resp.status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"
resp.failure_message #=> String
resp.bill_interval.start #=> Time
resp.bill_interval.end #=> Time
resp.cost_summary.total_cost_difference.historical_cost.amount #=> Float
resp.cost_summary.total_cost_difference.historical_cost.currency #=> String, one of "USD"
resp.cost_summary.total_cost_difference.estimated_cost.amount #=> Float
resp.cost_summary.total_cost_difference.estimated_cost.currency #=> String, one of "USD"
resp.cost_summary.service_cost_differences #=> Hash
resp.cost_summary.service_cost_differences["String"].historical_cost.amount #=> Float
resp.cost_summary.service_cost_differences["String"].historical_cost.currency #=> String, one of "USD"
resp.cost_summary.service_cost_differences["String"].estimated_cost.amount #=> Float
resp.cost_summary.service_cost_differences["String"].estimated_cost.currency #=> String, one of "USD"
resp.created_at #=> Time
resp.expires_at #=> Time
resp.group_sharing_preference #=> String, one of "OPEN", "PRIORITIZED", "RESTRICTED"
resp.cost_category_group_sharing_preference_arn #=> String
resp.cost_category_group_sharing_preference_effective_date #=> Time

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_scenario_id (required, String) —

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

• :name (required, String) —

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

• :client_token (String) —

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

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :tags (Hash<String,String>) —

  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.

Returns:

• (Types::CreateBillEstimateResponse) —

  Returns a response object which responds to the following methods:

  • #id => String

  • #name => String

  • #status => String

  • #failure_message => String

  • #bill_interval => Types::BillInterval

  • #cost_summary => Types::BillEstimateCostSummary

  • #created_at => Time

  • #expires_at => Time

  • #group_sharing_preference => String

  • #cost_category_group_sharing_preference_arn => String

  • #cost_category_group_sharing_preference_effective_date => Time

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1379

def create_bill_estimate(params = {}, options = {})
  req = build_request(:create_bill_estimate, params)
  req.send_request(options)
end

#create_bill_scenario(params = {}) ⇒ Types::CreateBillScenarioResponse

Creates a new bill scenario to model potential changes to Amazon Web Services usage and costs.

Examples:

Request syntax with placeholder values

resp = client.create_bill_scenario({
  name: "BillScenarioName", # required
  client_token: "ClientToken",
  tags: {
    "ResourceTagKey" => "ResourceTagValue",
  },
  group_sharing_preference: "OPEN", # accepts OPEN, PRIORITIZED, RESTRICTED
  cost_category_group_sharing_preference_arn: "CostCategoryArn",
})

Response structure

resp.id #=> String
resp.name #=> String
resp.bill_interval.start #=> Time
resp.bill_interval.end #=> Time
resp.status #=> String, one of "READY", "LOCKED", "FAILED", "STALE"
resp.created_at #=> Time
resp.expires_at #=> Time
resp.failure_message #=> String
resp.group_sharing_preference #=> String, one of "OPEN", "PRIORITIZED", "RESTRICTED"
resp.cost_category_group_sharing_preference_arn #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

  A descriptive name for the bill scenario.

• :client_token (String) —

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

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :tags (Hash<String,String>) —

  The tags to apply to the bill scenario.

• :group_sharing_preference (String) —

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

• :cost_category_group_sharing_preference_arn (String) —

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

Returns:

• (Types::CreateBillScenarioResponse) —

  Returns a response object which responds to the following methods:

  • #id => String

  • #name => String

  • #bill_interval => Types::BillInterval

  • #status => String

  • #created_at => Time

  • #expires_at => Time

  • #failure_message => String

  • #group_sharing_preference => String

  • #cost_category_group_sharing_preference_arn => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1449

def create_bill_scenario(params = {}, options = {})
  req = build_request(:create_bill_scenario, params)
  req.send_request(options)
end

#create_workload_estimate(params = {}) ⇒ Types::CreateWorkloadEstimateResponse

Creates a new workload estimate to model costs for a specific workload.

Examples:

Request syntax with placeholder values

resp = client.create_workload_estimate({
  name: "WorkloadEstimateName", # required
  client_token: "ClientToken",
  rate_type: "BEFORE_DISCOUNTS", # accepts BEFORE_DISCOUNTS, AFTER_DISCOUNTS, AFTER_DISCOUNTS_AND_COMMITMENTS
  tags: {
    "ResourceTagKey" => "ResourceTagValue",
  },
})

Response structure

resp.id #=> String
resp.name #=> String
resp.created_at #=> Time
resp.expires_at #=> Time
resp.rate_type #=> String, one of "BEFORE_DISCOUNTS", "AFTER_DISCOUNTS", "AFTER_DISCOUNTS_AND_COMMITMENTS"
resp.rate_timestamp #=> Time
resp.status #=> String, one of "UPDATING", "VALID", "INVALID", "ACTION_NEEDED"
resp.total_cost #=> Float
resp.cost_currency #=> String, one of "USD"
resp.failure_message #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

  A descriptive name for the workload estimate.

• :client_token (String) —

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

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :rate_type (String) —

  The type of pricing rates to use for the estimate.

• :tags (Hash<String,String>) —

  The tags to apply to the workload estimate.

Returns:

• (Types::CreateWorkloadEstimateResponse) —

  Returns a response object which responds to the following methods:

  • #id => String

  • #name => String

  • #created_at => Time

  • #expires_at => Time

  • #rate_type => String

  • #rate_timestamp => Time

  • #status => String

  • #total_cost => Float

  • #cost_currency => String

  • #failure_message => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1514

def create_workload_estimate(params = {}, options = {})
  req = build_request(:create_workload_estimate, params)
  req.send_request(options)
end

#delete_bill_estimate(params = {}) ⇒ Struct

Deletes an existing bill estimate.

Examples:

Request syntax with placeholder values

resp = client.delete_bill_estimate({
  identifier: "ResourceId", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

  The unique identifier of the bill estimate to delete.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1536

def delete_bill_estimate(params = {}, options = {})
  req = build_request(:delete_bill_estimate, params)
  req.send_request(options)
end

#delete_bill_scenario(params = {}) ⇒ Struct

Deletes an existing bill scenario.

Examples:

Request syntax with placeholder values

resp = client.delete_bill_scenario({
  identifier: "ResourceId", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

  The unique identifier of the bill scenario to delete.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1558

def delete_bill_scenario(params = {}, options = {})
  req = build_request(:delete_bill_scenario, params)
  req.send_request(options)
end

#delete_workload_estimate(params = {}) ⇒ Struct

Deletes an existing workload estimate.

Examples:

Request syntax with placeholder values

resp = client.delete_workload_estimate({
  identifier: "ResourceId", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

  The unique identifier of the workload estimate to delete.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1580

def delete_workload_estimate(params = {}, options = {})
  req = build_request(:delete_workload_estimate, params)
  req.send_request(options)
end

#get_bill_estimate(params = {}) ⇒ Types::GetBillEstimateResponse

Retrieves details of a specific bill estimate.

Examples:

Request syntax with placeholder values

resp = client.get_bill_estimate({
  identifier: "ResourceId", # required
})

Response structure

resp.id #=> String
resp.name #=> String
resp.status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"
resp.failure_message #=> String
resp.bill_interval.start #=> Time
resp.bill_interval.end #=> Time
resp.cost_summary.total_cost_difference.historical_cost.amount #=> Float
resp.cost_summary.total_cost_difference.historical_cost.currency #=> String, one of "USD"
resp.cost_summary.total_cost_difference.estimated_cost.amount #=> Float
resp.cost_summary.total_cost_difference.estimated_cost.currency #=> String, one of "USD"
resp.cost_summary.service_cost_differences #=> Hash
resp.cost_summary.service_cost_differences["String"].historical_cost.amount #=> Float
resp.cost_summary.service_cost_differences["String"].historical_cost.currency #=> String, one of "USD"
resp.cost_summary.service_cost_differences["String"].estimated_cost.amount #=> Float
resp.cost_summary.service_cost_differences["String"].estimated_cost.currency #=> String, one of "USD"
resp.created_at #=> Time
resp.expires_at #=> Time
resp.group_sharing_preference #=> String, one of "OPEN", "PRIORITIZED", "RESTRICTED"
resp.cost_category_group_sharing_preference_arn #=> String
resp.cost_category_group_sharing_preference_effective_date #=> Time

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

  The unique identifier of the bill estimate to retrieve.

Returns:

• (Types::GetBillEstimateResponse) —

  Returns a response object which responds to the following methods:

  • #id => String

  • #name => String

  • #status => String

  • #failure_message => String

  • #bill_interval => Types::BillInterval

  • #cost_summary => Types::BillEstimateCostSummary

  • #created_at => Time

  • #expires_at => Time

  • #group_sharing_preference => String

  • #cost_category_group_sharing_preference_arn => String

  • #cost_category_group_sharing_preference_effective_date => Time

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1637

def get_bill_estimate(params = {}, options = {})
  req = build_request(:get_bill_estimate, params)
  req.send_request(options)
end

#get_bill_scenario(params = {}) ⇒ Types::GetBillScenarioResponse

Retrieves details of a specific bill scenario.

Examples:

Request syntax with placeholder values

resp = client.get_bill_scenario({
  identifier: "ResourceId", # required
})

Response structure

resp.id #=> String
resp.name #=> String
resp.bill_interval.start #=> Time
resp.bill_interval.end #=> Time
resp.status #=> String, one of "READY", "LOCKED", "FAILED", "STALE"
resp.created_at #=> Time
resp.expires_at #=> Time
resp.failure_message #=> String
resp.group_sharing_preference #=> String, one of "OPEN", "PRIORITIZED", "RESTRICTED"
resp.cost_category_group_sharing_preference_arn #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

  The unique identifier of the bill scenario to retrieve.

Returns:

• (Types::GetBillScenarioResponse) —

  Returns a response object which responds to the following methods:

  • #id => String

  • #name => String

  • #bill_interval => Types::BillInterval

  • #status => String

  • #created_at => Time

  • #expires_at => Time

  • #failure_message => String

  • #group_sharing_preference => String

  • #cost_category_group_sharing_preference_arn => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1682

def get_bill_scenario(params = {}, options = {})
  req = build_request(:get_bill_scenario, params)
  req.send_request(options)
end

#get_preferences(params = {}) ⇒ Types::GetPreferencesResponse

Retrieves the current preferences for Pricing Calculator.

Examples:

Response structure

resp.management_account_rate_type_selections #=> Array
resp.management_account_rate_type_selections[0] #=> String, one of "BEFORE_DISCOUNTS", "AFTER_DISCOUNTS", "AFTER_DISCOUNTS_AND_COMMITMENTS"
resp.member_account_rate_type_selections #=> Array
resp.member_account_rate_type_selections[0] #=> String, one of "BEFORE_DISCOUNTS", "AFTER_DISCOUNTS", "AFTER_DISCOUNTS_AND_COMMITMENTS"
resp.standalone_account_rate_type_selections #=> Array
resp.standalone_account_rate_type_selections[0] #=> String, one of "BEFORE_DISCOUNTS", "AFTER_DISCOUNTS", "AFTER_DISCOUNTS_AND_COMMITMENTS"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Returns:

• (Types::GetPreferencesResponse) —

  Returns a response object which responds to the following methods:

  • #management_account_rate_type_selections => Array&lt;String&gt;

  • #member_account_rate_type_selections => Array&lt;String&gt;

  • #standalone_account_rate_type_selections => Array&lt;String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1708

def get_preferences(params = {}, options = {})
  req = build_request(:get_preferences, params)
  req.send_request(options)
end

#get_workload_estimate(params = {}) ⇒ Types::GetWorkloadEstimateResponse

Retrieves details of a specific workload estimate.

Examples:

Request syntax with placeholder values

resp = client.get_workload_estimate({
  identifier: "ResourceId", # required
})

Response structure

resp.id #=> String
resp.name #=> String
resp.created_at #=> Time
resp.expires_at #=> Time
resp.rate_type #=> String, one of "BEFORE_DISCOUNTS", "AFTER_DISCOUNTS", "AFTER_DISCOUNTS_AND_COMMITMENTS"
resp.rate_timestamp #=> Time
resp.status #=> String, one of "UPDATING", "VALID", "INVALID", "ACTION_NEEDED"
resp.total_cost #=> Float
resp.cost_currency #=> String, one of "USD"
resp.failure_message #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

  The unique identifier of the workload estimate to retrieve.

Returns:

• (Types::GetWorkloadEstimateResponse) —

  Returns a response object which responds to the following methods:

  • #id => String

  • #name => String

  • #created_at => Time

  • #expires_at => Time

  • #rate_type => String

  • #rate_timestamp => Time

  • #status => String

  • #total_cost => Float

  • #cost_currency => String

  • #failure_message => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1754

def get_workload_estimate(params = {}, options = {})
  req = build_request(:get_workload_estimate, params)
  req.send_request(options)
end

#list_bill_estimate_commitments(params = {}) ⇒ Types::ListBillEstimateCommitmentsResponse

Lists the commitments associated with a bill estimate.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_bill_estimate_commitments({
  bill_estimate_id: "ResourceId", # required
  next_token: "NextPageToken",
  max_results: 1,
})

Response structure

resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].purchase_agreement_type #=> String, one of "SAVINGS_PLANS", "RESERVED_INSTANCE"
resp.items[0].offering_id #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].region #=> String
resp.items[0].term_length #=> String
resp.items[0].payment_option #=> String
resp.items[0].upfront_payment.amount #=> Float
resp.items[0].upfront_payment.currency #=> String, one of "USD"
resp.items[0].monthly_payment.amount #=> Float
resp.items[0].monthly_payment.currency #=> String, one of "USD"
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_estimate_id (required, String) —

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

• :next_token (String) —

  A token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of results to return per page.

Returns:

• (Types::ListBillEstimateCommitmentsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BillEstimateCommitmentSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1805

def list_bill_estimate_commitments(params = {}, options = {})
  req = build_request(:list_bill_estimate_commitments, params)
  req.send_request(options)
end

#list_bill_estimate_input_commitment_modifications(params = {}) ⇒ Types::ListBillEstimateInputCommitmentModificationsResponse

Lists the input commitment modifications associated with a bill estimate.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_bill_estimate_input_commitment_modifications({
  bill_estimate_id: "ResourceId", # required
  next_token: "NextPageToken",
  max_results: 1,
})

Response structure

resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].group #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].commitment_action.add_reserved_instance_action.reserved_instances_offering_id #=> String
resp.items[0].commitment_action.add_reserved_instance_action.instance_count #=> Integer
resp.items[0].commitment_action.add_savings_plan_action.savings_plan_offering_id #=> String
resp.items[0].commitment_action.add_savings_plan_action.commitment #=> Float
resp.items[0].commitment_action.negate_reserved_instance_action.reserved_instances_id #=> String
resp.items[0].commitment_action.negate_savings_plan_action.savings_plan_id #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_estimate_id (required, String) —

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

• :next_token (String) —

  A token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of results to return per page.

Returns:

• (Types::ListBillEstimateInputCommitmentModificationsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BillEstimateInputCommitmentModificationSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1856

def list_bill_estimate_input_commitment_modifications(params = {}, options = {})
  req = build_request(:list_bill_estimate_input_commitment_modifications, params)
  req.send_request(options)
end

#list_bill_estimate_input_usage_modifications(params = {}) ⇒ Types::ListBillEstimateInputUsageModificationsResponse

Lists the input usage modifications associated with a bill estimate.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_bill_estimate_input_usage_modifications({
  bill_estimate_id: "ResourceId", # required
  filters: [
    {
      name: "USAGE_ACCOUNT_ID", # required, accepts USAGE_ACCOUNT_ID, SERVICE_CODE, USAGE_TYPE, OPERATION, LOCATION, USAGE_GROUP, HISTORICAL_USAGE_ACCOUNT_ID, HISTORICAL_SERVICE_CODE, HISTORICAL_USAGE_TYPE, HISTORICAL_OPERATION, HISTORICAL_LOCATION
      values: ["String"], # required
      match_option: "EQUALS", # accepts EQUALS, STARTS_WITH, CONTAINS
    },
  ],
  next_token: "NextPageToken",
  max_results: 1,
})

Response structure

resp.items #=> Array
resp.items[0].service_code #=> String
resp.items[0].usage_type #=> String
resp.items[0].operation #=> String
resp.items[0].location #=> String
resp.items[0].availability_zone #=> String
resp.items[0].id #=> String
resp.items[0].group #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].quantities #=> Array
resp.items[0].quantities[0].start_hour #=> Time
resp.items[0].quantities[0].unit #=> String
resp.items[0].quantities[0].amount #=> Float
resp.items[0].historical_usage.service_code #=> String
resp.items[0].historical_usage.usage_type #=> String
resp.items[0].historical_usage.operation #=> String
resp.items[0].historical_usage.location #=> String
resp.items[0].historical_usage.usage_account_id #=> String
resp.items[0].historical_usage.bill_interval.start #=> Time
resp.items[0].historical_usage.bill_interval.end #=> Time
resp.items[0].historical_usage.filter_expression.and #=> Array
resp.items[0].historical_usage.filter_expression.and[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.or #=> Array
resp.items[0].historical_usage.filter_expression.or[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.not #=> Types::Expression
resp.items[0].historical_usage.filter_expression.cost_categories.key #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.match_options #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.values #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.values[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.key #=> String
resp.items[0].historical_usage.filter_expression.dimensions.match_options #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.values #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.values[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.key #=> String
resp.items[0].historical_usage.filter_expression.tags.match_options #=> Array
resp.items[0].historical_usage.filter_expression.tags.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.values #=> Array
resp.items[0].historical_usage.filter_expression.tags.values[0] #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_estimate_id (required, String) —

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

• :filters (Array<Types::ListUsageFilter>) —

  Filters to apply to the list of input usage modifications.

• :next_token (String) —

  A token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of results to return per page.

Returns:

• (Types::ListBillEstimateInputUsageModificationsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BillEstimateInputUsageModificationSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 1946

def list_bill_estimate_input_usage_modifications(params = {}, options = {})
  req = build_request(:list_bill_estimate_input_usage_modifications, params)
  req.send_request(options)
end

#list_bill_estimate_line_items(params = {}) ⇒ Types::ListBillEstimateLineItemsResponse

Lists the line items associated with a bill estimate.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_bill_estimate_line_items({
  bill_estimate_id: "ResourceId", # required
  filters: [
    {
      name: "USAGE_ACCOUNT_ID", # required, accepts USAGE_ACCOUNT_ID, SERVICE_CODE, USAGE_TYPE, OPERATION, LOCATION, LINE_ITEM_TYPE
      values: ["String"], # required
      match_option: "EQUALS", # accepts EQUALS, STARTS_WITH, CONTAINS
    },
  ],
  next_token: "NextPageToken",
  max_results: 1,
})

Response structure

resp.items #=> Array
resp.items[0].service_code #=> String
resp.items[0].usage_type #=> String
resp.items[0].operation #=> String
resp.items[0].location #=> String
resp.items[0].availability_zone #=> String
resp.items[0].id #=> String
resp.items[0].line_item_id #=> String
resp.items[0].line_item_type #=> String
resp.items[0].payer_account_id #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].estimated_usage_quantity.amount #=> Float
resp.items[0].estimated_usage_quantity.unit #=> String
resp.items[0].estimated_cost.amount #=> Float
resp.items[0].estimated_cost.currency #=> String, one of "USD"
resp.items[0].historical_usage_quantity.amount #=> Float
resp.items[0].historical_usage_quantity.unit #=> String
resp.items[0].historical_cost.amount #=> Float
resp.items[0].historical_cost.currency #=> String, one of "USD"
resp.items[0].savings_plan_arns #=> Array
resp.items[0].savings_plan_arns[0] #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_estimate_id (required, String) —

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

• :filters (Array<Types::ListBillEstimateLineItemsFilter>) —

  Filters to apply to the list of line items.

• :next_token (String) —

  A token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of results to return per page.

Returns:

• (Types::ListBillEstimateLineItemsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BillEstimateLineItemSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2016

def list_bill_estimate_line_items(params = {}, options = {})
  req = build_request(:list_bill_estimate_line_items, params)
  req.send_request(options)
end

#list_bill_estimates(params = {}) ⇒ Types::ListBillEstimatesResponse

Lists all bill estimates for the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_bill_estimates({
  filters: [
    {
      name: "STATUS", # required, accepts STATUS, NAME
      values: ["String"], # required
      match_option: "EQUALS", # accepts EQUALS, STARTS_WITH, CONTAINS
    },
  ],
  created_at_filter: {
    after_timestamp: Time.now,
    before_timestamp: Time.now,
  },
  expires_at_filter: {
    after_timestamp: Time.now,
    before_timestamp: Time.now,
  },
  next_token: "NextPageToken",
  max_results: 1,
})

Response structure

resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"
resp.items[0].bill_interval.start #=> Time
resp.items[0].bill_interval.end #=> Time
resp.items[0].created_at #=> Time
resp.items[0].expires_at #=> Time
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :filters (Array<Types::ListBillEstimatesFilter>) —

  Filters to apply to the list of bill estimates.

• :created_at_filter (Types::FilterTimestamp) —

  Filter bill estimates based on the creation date.

• :expires_at_filter (Types::FilterTimestamp) —

  Filter bill estimates based on the expiration date.

• :next_token (String) —

  A token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of results to return per page.

Returns:

• (Types::ListBillEstimatesResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BillEstimateSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2083

def list_bill_estimates(params = {}, options = {})
  req = build_request(:list_bill_estimates, params)
  req.send_request(options)
end

#list_bill_scenario_commitment_modifications(params = {}) ⇒ Types::ListBillScenarioCommitmentModificationsResponse

Lists the commitment modifications associated with a bill scenario.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_bill_scenario_commitment_modifications({
  bill_scenario_id: "ResourceId", # required
  next_token: "NextPageToken",
  max_results: 1,
})

Response structure

resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].group #=> String
resp.items[0].commitment_action.add_reserved_instance_action.reserved_instances_offering_id #=> String
resp.items[0].commitment_action.add_reserved_instance_action.instance_count #=> Integer
resp.items[0].commitment_action.add_savings_plan_action.savings_plan_offering_id #=> String
resp.items[0].commitment_action.add_savings_plan_action.commitment #=> Float
resp.items[0].commitment_action.negate_reserved_instance_action.reserved_instances_id #=> String
resp.items[0].commitment_action.negate_savings_plan_action.savings_plan_id #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_scenario_id (required, String) —

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

• :next_token (String) —

  A token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of results to return per page.

Returns:

• (Types::ListBillScenarioCommitmentModificationsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BillScenarioCommitmentModificationItem&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2133

def list_bill_scenario_commitment_modifications(params = {}, options = {})
  req = build_request(:list_bill_scenario_commitment_modifications, params)
  req.send_request(options)
end

#list_bill_scenario_usage_modifications(params = {}) ⇒ Types::ListBillScenarioUsageModificationsResponse

Lists the usage modifications associated with a bill scenario.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_bill_scenario_usage_modifications({
  bill_scenario_id: "ResourceId", # required
  filters: [
    {
      name: "USAGE_ACCOUNT_ID", # required, accepts USAGE_ACCOUNT_ID, SERVICE_CODE, USAGE_TYPE, OPERATION, LOCATION, USAGE_GROUP, HISTORICAL_USAGE_ACCOUNT_ID, HISTORICAL_SERVICE_CODE, HISTORICAL_USAGE_TYPE, HISTORICAL_OPERATION, HISTORICAL_LOCATION
      values: ["String"], # required
      match_option: "EQUALS", # accepts EQUALS, STARTS_WITH, CONTAINS
    },
  ],
  next_token: "NextPageToken",
  max_results: 1,
})

Response structure

resp.items #=> Array
resp.items[0].service_code #=> String
resp.items[0].usage_type #=> String
resp.items[0].operation #=> String
resp.items[0].location #=> String
resp.items[0].availability_zone #=> String
resp.items[0].id #=> String
resp.items[0].group #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].quantities #=> Array
resp.items[0].quantities[0].start_hour #=> Time
resp.items[0].quantities[0].unit #=> String
resp.items[0].quantities[0].amount #=> Float
resp.items[0].historical_usage.service_code #=> String
resp.items[0].historical_usage.usage_type #=> String
resp.items[0].historical_usage.operation #=> String
resp.items[0].historical_usage.location #=> String
resp.items[0].historical_usage.usage_account_id #=> String
resp.items[0].historical_usage.bill_interval.start #=> Time
resp.items[0].historical_usage.bill_interval.end #=> Time
resp.items[0].historical_usage.filter_expression.and #=> Array
resp.items[0].historical_usage.filter_expression.and[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.or #=> Array
resp.items[0].historical_usage.filter_expression.or[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.not #=> Types::Expression
resp.items[0].historical_usage.filter_expression.cost_categories.key #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.match_options #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.values #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.values[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.key #=> String
resp.items[0].historical_usage.filter_expression.dimensions.match_options #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.values #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.values[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.key #=> String
resp.items[0].historical_usage.filter_expression.tags.match_options #=> Array
resp.items[0].historical_usage.filter_expression.tags.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.values #=> Array
resp.items[0].historical_usage.filter_expression.tags.values[0] #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :bill_scenario_id (required, String) —

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

• :filters (Array<Types::ListUsageFilter>) —

  Filters to apply to the list of usage modifications.

• :next_token (String) —

  A token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of results to return per page.

Returns:

• (Types::ListBillScenarioUsageModificationsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BillScenarioUsageModificationItem&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2223

def list_bill_scenario_usage_modifications(params = {}, options = {})
  req = build_request(:list_bill_scenario_usage_modifications, params)
  req.send_request(options)
end

#list_bill_scenarios(params = {}) ⇒ Types::ListBillScenariosResponse

Lists all bill scenarios for the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_bill_scenarios({
  filters: [
    {
      name: "STATUS", # required, accepts STATUS, NAME, GROUP_SHARING_PREFERENCE, COST_CATEGORY_ARN
      values: ["String"], # required
      match_option: "EQUALS", # accepts EQUALS, STARTS_WITH, CONTAINS
    },
  ],
  created_at_filter: {
    after_timestamp: Time.now,
    before_timestamp: Time.now,
  },
  expires_at_filter: {
    after_timestamp: Time.now,
    before_timestamp: Time.now,
  },
  next_token: "NextPageToken",
  max_results: 1,
})

Response structure

resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].bill_interval.start #=> Time
resp.items[0].bill_interval.end #=> Time
resp.items[0].status #=> String, one of "READY", "LOCKED", "FAILED", "STALE"
resp.items[0].created_at #=> Time
resp.items[0].expires_at #=> Time
resp.items[0].failure_message #=> String
resp.items[0].group_sharing_preference #=> String, one of "OPEN", "PRIORITIZED", "RESTRICTED"
resp.items[0].cost_category_group_sharing_preference_arn #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :filters (Array<Types::ListBillScenariosFilter>) —

  Filters to apply to the list of bill scenarios.

• :created_at_filter (Types::FilterTimestamp) —

  Filter bill scenarios based on the creation date.

• :expires_at_filter (Types::FilterTimestamp) —

  Filter bill scenarios based on the expiration date.

• :next_token (String) —

  A token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of results to return per page.

Returns:

• (Types::ListBillScenariosResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::BillScenarioSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2293

def list_bill_scenarios(params = {}, options = {})
  req = build_request(:list_bill_scenarios, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags associated with a specified resource.

Examples:

Request syntax with placeholder values

resp = client.list_tags_for_resource({
  arn: "Arn", # required
})

Response structure

resp.tags #=> Hash
resp.tags["ResourceTagKey"] #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :arn (required, String) —

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

Returns:

• (Types::ListTagsForResourceResponse) —

  Returns a response object which responds to the following methods:

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2322

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_workload_estimate_usage(params = {}) ⇒ Types::ListWorkloadEstimateUsageResponse

Lists the usage associated with a workload estimate.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_workload_estimate_usage({
  workload_estimate_id: "ResourceId", # required
  filters: [
    {
      name: "USAGE_ACCOUNT_ID", # required, accepts USAGE_ACCOUNT_ID, SERVICE_CODE, USAGE_TYPE, OPERATION, LOCATION, USAGE_GROUP, HISTORICAL_USAGE_ACCOUNT_ID, HISTORICAL_SERVICE_CODE, HISTORICAL_USAGE_TYPE, HISTORICAL_OPERATION, HISTORICAL_LOCATION
      values: ["String"], # required
      match_option: "EQUALS", # accepts EQUALS, STARTS_WITH, CONTAINS
    },
  ],
  next_token: "NextPageToken",
  max_results: 1,
})

Response structure

resp.items #=> Array
resp.items[0].service_code #=> String
resp.items[0].usage_type #=> String
resp.items[0].operation #=> String
resp.items[0].location #=> String
resp.items[0].id #=> String
resp.items[0].usage_account_id #=> String
resp.items[0].group #=> String
resp.items[0].quantity.unit #=> String
resp.items[0].quantity.amount #=> Float
resp.items[0].cost #=> Float
resp.items[0].currency #=> String, one of "USD"
resp.items[0].status #=> String, one of "VALID", "INVALID", "STALE"
resp.items[0].historical_usage.service_code #=> String
resp.items[0].historical_usage.usage_type #=> String
resp.items[0].historical_usage.operation #=> String
resp.items[0].historical_usage.location #=> String
resp.items[0].historical_usage.usage_account_id #=> String
resp.items[0].historical_usage.bill_interval.start #=> Time
resp.items[0].historical_usage.bill_interval.end #=> Time
resp.items[0].historical_usage.filter_expression.and #=> Array
resp.items[0].historical_usage.filter_expression.and[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.or #=> Array
resp.items[0].historical_usage.filter_expression.or[0] #=> Types::Expression
resp.items[0].historical_usage.filter_expression.not #=> Types::Expression
resp.items[0].historical_usage.filter_expression.cost_categories.key #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.match_options #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.cost_categories.values #=> Array
resp.items[0].historical_usage.filter_expression.cost_categories.values[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.key #=> String
resp.items[0].historical_usage.filter_expression.dimensions.match_options #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.dimensions.values #=> Array
resp.items[0].historical_usage.filter_expression.dimensions.values[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.key #=> String
resp.items[0].historical_usage.filter_expression.tags.match_options #=> Array
resp.items[0].historical_usage.filter_expression.tags.match_options[0] #=> String
resp.items[0].historical_usage.filter_expression.tags.values #=> Array
resp.items[0].historical_usage.filter_expression.tags.values[0] #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :workload_estimate_id (required, String) —

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

• :filters (Array<Types::ListUsageFilter>) —

  Filters to apply to the list of usage items.

• :next_token (String) —

  A token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of results to return per page.

Returns:

• (Types::ListWorkloadEstimateUsageResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::WorkloadEstimateUsageItem&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2411

def list_workload_estimate_usage(params = {}, options = {})
  req = build_request(:list_workload_estimate_usage, params)
  req.send_request(options)
end

#list_workload_estimates(params = {}) ⇒ Types::ListWorkloadEstimatesResponse

Lists all workload estimates for the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_workload_estimates({
  created_at_filter: {
    after_timestamp: Time.now,
    before_timestamp: Time.now,
  },
  expires_at_filter: {
    after_timestamp: Time.now,
    before_timestamp: Time.now,
  },
  filters: [
    {
      name: "STATUS", # required, accepts STATUS, NAME
      values: ["String"], # required
      match_option: "EQUALS", # accepts EQUALS, STARTS_WITH, CONTAINS
    },
  ],
  next_token: "NextPageToken",
  max_results: 1,
})

Response structure

resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].created_at #=> Time
resp.items[0].expires_at #=> Time
resp.items[0].rate_type #=> String, one of "BEFORE_DISCOUNTS", "AFTER_DISCOUNTS", "AFTER_DISCOUNTS_AND_COMMITMENTS"
resp.items[0].rate_timestamp #=> Time
resp.items[0].status #=> String, one of "UPDATING", "VALID", "INVALID", "ACTION_NEEDED"
resp.items[0].total_cost #=> Float
resp.items[0].cost_currency #=> String, one of "USD"
resp.items[0].failure_message #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :created_at_filter (Types::FilterTimestamp) —

  Filter workload estimates based on the creation date.

• :expires_at_filter (Types::FilterTimestamp) —

  Filter workload estimates based on the expiration date.

• :filters (Array<Types::ListWorkloadEstimatesFilter>) —

  Filters to apply to the list of workload estimates.

• :next_token (String) —

  A token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of results to return per page.

Returns:

• (Types::ListWorkloadEstimatesResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::WorkloadEstimateSummary&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2481

def list_workload_estimates(params = {}, options = {})
  req = build_request(:list_workload_estimates, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to a specified resource.

Examples:

Request syntax with placeholder values

resp = client.tag_resource({
  arn: "Arn", # required
  tags: { # required
    "ResourceTagKey" => "ResourceTagValue",
  },
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :arn (required, String) —

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

• :tags (required, Hash<String,String>) —

  The tags to add to the resource.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2509

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from a specified resource.

Examples:

Request syntax with placeholder values

resp = client.untag_resource({
  arn: "Arn", # required
  tag_keys: ["ResourceTagKey"], # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :arn (required, String) —

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

• :tag_keys (required, Array<String>) —

  The keys of the tags to remove from the resource.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2535

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_bill_estimate(params = {}) ⇒ Types::UpdateBillEstimateResponse

Updates an existing bill estimate.

Examples:

Request syntax with placeholder values

resp = client.update_bill_estimate({
  identifier: "ResourceId", # required
  name: "BillEstimateName",
  expires_at: Time.now,
})

Response structure

resp.id #=> String
resp.name #=> String
resp.status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"
resp.failure_message #=> String
resp.bill_interval.start #=> Time
resp.bill_interval.end #=> Time
resp.cost_summary.total_cost_difference.historical_cost.amount #=> Float
resp.cost_summary.total_cost_difference.historical_cost.currency #=> String, one of "USD"
resp.cost_summary.total_cost_difference.estimated_cost.amount #=> Float
resp.cost_summary.total_cost_difference.estimated_cost.currency #=> String, one of "USD"
resp.cost_summary.service_cost_differences #=> Hash
resp.cost_summary.service_cost_differences["String"].historical_cost.amount #=> Float
resp.cost_summary.service_cost_differences["String"].historical_cost.currency #=> String, one of "USD"
resp.cost_summary.service_cost_differences["String"].estimated_cost.amount #=> Float
resp.cost_summary.service_cost_differences["String"].estimated_cost.currency #=> String, one of "USD"
resp.created_at #=> Time
resp.expires_at #=> Time
resp.group_sharing_preference #=> String, one of "OPEN", "PRIORITIZED", "RESTRICTED"
resp.cost_category_group_sharing_preference_arn #=> String
resp.cost_category_group_sharing_preference_effective_date #=> Time

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

  The unique identifier of the bill estimate to update.

• :name (String) —

  The new name for the bill estimate.

• :expires_at (Time, DateTime, Date, Integer, String) —

  The new expiration date for the bill estimate.

Returns:

• (Types::UpdateBillEstimateResponse) —

  Returns a response object which responds to the following methods:

  • #id => String

  • #name => String

  • #status => String

  • #failure_message => String

  • #bill_interval => Types::BillInterval

  • #cost_summary => Types::BillEstimateCostSummary

  • #created_at => Time

  • #expires_at => Time

  • #group_sharing_preference => String

  • #cost_category_group_sharing_preference_arn => String

  • #cost_category_group_sharing_preference_effective_date => Time

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2600

def update_bill_estimate(params = {}, options = {})
  req = build_request(:update_bill_estimate, params)
  req.send_request(options)
end

#update_bill_scenario(params = {}) ⇒ Types::UpdateBillScenarioResponse

Updates an existing bill scenario.

Examples:

Request syntax with placeholder values

resp = client.update_bill_scenario({
  identifier: "ResourceId", # required
  name: "BillScenarioName",
  expires_at: Time.now,
  group_sharing_preference: "OPEN", # accepts OPEN, PRIORITIZED, RESTRICTED
  cost_category_group_sharing_preference_arn: "CostCategoryArn",
})

Response structure

resp.id #=> String
resp.name #=> String
resp.bill_interval.start #=> Time
resp.bill_interval.end #=> Time
resp.status #=> String, one of "READY", "LOCKED", "FAILED", "STALE"
resp.created_at #=> Time
resp.expires_at #=> Time
resp.failure_message #=> String
resp.group_sharing_preference #=> String, one of "OPEN", "PRIORITIZED", "RESTRICTED"
resp.cost_category_group_sharing_preference_arn #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

  The unique identifier of the bill scenario to update.

• :name (String) —

  The new name for the bill scenario.

• :expires_at (Time, DateTime, Date, Integer, String) —

  The new expiration date for the bill scenario.

• :group_sharing_preference (String) —

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

• :cost_category_group_sharing_preference_arn (String) —

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

Returns:

• (Types::UpdateBillScenarioResponse) —

  Returns a response object which responds to the following methods:

  • #id => String

  • #name => String

  • #bill_interval => Types::BillInterval

  • #status => String

  • #created_at => Time

  • #expires_at => Time

  • #failure_message => String

  • #group_sharing_preference => String

  • #cost_category_group_sharing_preference_arn => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2663

def update_bill_scenario(params = {}, options = {})
  req = build_request(:update_bill_scenario, params)
  req.send_request(options)
end

#update_preferences(params = {}) ⇒ Types::UpdatePreferencesResponse

Updates the preferences for Pricing Calculator.

Examples:

Request syntax with placeholder values

resp = client.update_preferences({
  management_account_rate_type_selections: ["BEFORE_DISCOUNTS"], # accepts BEFORE_DISCOUNTS, AFTER_DISCOUNTS, AFTER_DISCOUNTS_AND_COMMITMENTS
  member_account_rate_type_selections: ["BEFORE_DISCOUNTS"], # accepts BEFORE_DISCOUNTS, AFTER_DISCOUNTS, AFTER_DISCOUNTS_AND_COMMITMENTS
  standalone_account_rate_type_selections: ["BEFORE_DISCOUNTS"], # accepts BEFORE_DISCOUNTS, AFTER_DISCOUNTS, AFTER_DISCOUNTS_AND_COMMITMENTS
})

Response structure

resp.management_account_rate_type_selections #=> Array
resp.management_account_rate_type_selections[0] #=> String, one of "BEFORE_DISCOUNTS", "AFTER_DISCOUNTS", "AFTER_DISCOUNTS_AND_COMMITMENTS"
resp.member_account_rate_type_selections #=> Array
resp.member_account_rate_type_selections[0] #=> String, one of "BEFORE_DISCOUNTS", "AFTER_DISCOUNTS", "AFTER_DISCOUNTS_AND_COMMITMENTS"
resp.standalone_account_rate_type_selections #=> Array
resp.standalone_account_rate_type_selections[0] #=> String, one of "BEFORE_DISCOUNTS", "AFTER_DISCOUNTS", "AFTER_DISCOUNTS_AND_COMMITMENTS"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :management_account_rate_type_selections (Array<String>) —

  The updated preferred rate types for the management account.

• :member_account_rate_type_selections (Array<String>) —

  The updated preferred rate types for member accounts.

• :standalone_account_rate_type_selections (Array<String>) —

  The updated preferred rate types for a standalone account.

Returns:

• (Types::UpdatePreferencesResponse) —

  Returns a response object which responds to the following methods:

  • #management_account_rate_type_selections => Array&lt;String&gt;

  • #member_account_rate_type_selections => Array&lt;String&gt;

  • #standalone_account_rate_type_selections => Array&lt;String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2706

def update_preferences(params = {}, options = {})
  req = build_request(:update_preferences, params)
  req.send_request(options)
end

#update_workload_estimate(params = {}) ⇒ Types::UpdateWorkloadEstimateResponse

Updates an existing workload estimate.

Examples:

Request syntax with placeholder values

resp = client.update_workload_estimate({
  identifier: "ResourceId", # required
  name: "WorkloadEstimateName",
  expires_at: Time.now,
})

Response structure

resp.id #=> String
resp.name #=> String
resp.created_at #=> Time
resp.expires_at #=> Time
resp.rate_type #=> String, one of "BEFORE_DISCOUNTS", "AFTER_DISCOUNTS", "AFTER_DISCOUNTS_AND_COMMITMENTS"
resp.rate_timestamp #=> Time
resp.status #=> String, one of "UPDATING", "VALID", "INVALID", "ACTION_NEEDED"
resp.total_cost #=> Float
resp.cost_currency #=> String, one of "USD"
resp.failure_message #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

  The unique identifier of the workload estimate to update.

• :name (String) —

  The new name for the workload estimate.

• :expires_at (Time, DateTime, Date, Integer, String) —

  The new expiration date for the workload estimate.

Returns:

• (Types::UpdateWorkloadEstimateResponse) —

  Returns a response object which responds to the following methods:

  • #id => String

  • #name => String

  • #created_at => Time

  • #expires_at => Time

  • #rate_type => String

  • #rate_timestamp => Time

  • #status => String

  • #total_cost => Float

  • #cost_currency => String

  • #failure_message => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2760

def update_workload_estimate(params = {}, options = {})
  req = build_request(:update_workload_estimate, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.

# File 'lib/aws-sdk-bcmpricingcalculator/client.rb', line 2789

def waiter_names
  []
end