Class: Aws::BCMDashboards::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::BCMDashboards::Client

show all

Includes:: ClientStubs

Defined in:: gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
Creates a new dashboard that can contain multiple widgets displaying cost and usage data.
#delete_dashboard(params = {}) ⇒ Types::DeleteDashboardResponse
Deletes a specified dashboard.
#get_dashboard(params = {}) ⇒ Types::GetDashboardResponse
Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.
#list_dashboards(params = {}) ⇒ Types::ListDashboardsResponse
Returns a list of all dashboards in your account.
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of all tags associated with a specified dashboard resource.
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for a specified dashboard resource.
#untag_resource(params = {}) ⇒ Struct
Removes specified tags from a dashboard resource.
#update_dashboard(params = {}) ⇒ Types::UpdateDashboardResponse
Updates an existing dashboard's properties, including its name, description, and widget configurations.

Instance Method Summary collapse

#initialize(options) ⇒ Client constructor
A new instance of Client.

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[:credentials]
- The :access_key_id, :secret_access_key, :session_token, and :account_id options.
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].
- ~/.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['AWS_EC2_METADATA_DISABLED'] 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[:region]
- ENV['AWS_REGION']
- ENV['AMAZON_REGION']
- ENV['AWS_DEFAULT_REGION']
- ~/.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['AWS_AUTH_SCHEME_PREFERENCE'] 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 https://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 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 - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
: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[:sigv4a_signing_region_set]
- ENV['AWS_SIGV4A_SIGNING_REGION_SET']
- ~/.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::BCMDashboards::EndpointProvider) —
The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::BCMDashboards::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 'http://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.



480
481
482

# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb', line 480

def initialize(*args)
  super
end

Instance Method Details

#create_dashboard(params = {}) ⇒ `Types::CreateDashboardResponse`

Creates a new dashboard that can contain multiple widgets displaying cost and usage data. You can add custom widgets or use predefined widgets, arranging them in your preferred layout.

Examples:

Example: Creating a dashboard


resp = client.create_dashboard({
  name: "cost-dashboards", 
  description: "Dashboard for tracking costs", 
  widgets: [
    {
      configs: [
        {
          display_config: {
            graph: {
              "costTrend" => {
                visual_type: "LINE", 
              }, 
            }, 
          }, 
          query_parameters: {
            cost_and_usage: {
              granularity: "MONTHLY", 
              group_by: [
                {
                  type: "DIMENSION", 
                  key: "SERVICE", 
                }, 
              ], 
              metrics: [
                "UnblendedCost", 
              ], 
              time_range: {
                end_time: {
                  type: "RELATIVE", 
                  value: "now", 
                }, 
                start_time: {
                  type: "RELATIVE", 
                  value: "-9M", 
                }, 
              }, 
            }, 
          }, 
        }, 
      ], 
      height: 7, 
      horizontal_offset: 0, 
      title: "Monthly Cost Trend", 
      width: 4, 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.create_dashboard({
  name: "DashboardName", # required
  description: "Description",
  widgets: [ # required
    {
      title: "WidgetTitle", # required
      description: "Description",
      width: 1,
      height: 1,
      horizontal_offset: 1,
      configs: [ # required
        {
          query_parameters: { # required
            cost_and_usage: {
              metrics: ["AmortizedCost"], # required, accepts AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, UsageQuantity, SpendCoveredBySavingsPlans, Hour, Unit, Cost
              time_range: { # required
                start_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
                end_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
              },
              granularity: "HOURLY", # required, accepts HOURLY, DAILY, MONTHLY
              group_by: [
                {
                  key: "GroupDefinitionKeyString", # required
                  type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
                },
              ],
              filter: {
                or: [
                  {
                    # recursive Expression
                  },
                ],
                and: [
                  {
                    # recursive Expression
                  },
                ],
                not: {
                  # recursive Expression
                },
                dimensions: {
                  key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, RESOURCE_ID, SUBSCRIPTION_ID, TAG_KEY, OPERATING_SYSTEM, TENANCY, BILLING_ENTITY, RESERVATION_ID, COST_CATEGORY_NAME, DATABASE_ENGINE, LEGAL_ENTITY_NAME, SAVINGS_PLANS_TYPE, INSTANCE_TYPE_FAMILY, CACHE_ENGINE, DEPLOYMENT_OPTION, SCOPE, PLATFORM
                  values: ["String"], # required
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                tags: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                cost_categories: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
              },
            },
            savings_plans_coverage: {
              time_range: { # required
                start_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
                end_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
              },
              metrics: ["AmortizedCost"], # accepts AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, UsageQuantity, SpendCoveredBySavingsPlans, Hour, Unit, Cost
              granularity: "HOURLY", # accepts HOURLY, DAILY, MONTHLY
              group_by: [
                {
                  key: "GroupDefinitionKeyString", # required
                  type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
                },
              ],
              filter: {
                or: [
                  {
                    # recursive Expression
                  },
                ],
                and: [
                  {
                    # recursive Expression
                  },
                ],
                not: {
                  # recursive Expression
                },
                dimensions: {
                  key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, RESOURCE_ID, SUBSCRIPTION_ID, TAG_KEY, OPERATING_SYSTEM, TENANCY, BILLING_ENTITY, RESERVATION_ID, COST_CATEGORY_NAME, DATABASE_ENGINE, LEGAL_ENTITY_NAME, SAVINGS_PLANS_TYPE, INSTANCE_TYPE_FAMILY, CACHE_ENGINE, DEPLOYMENT_OPTION, SCOPE, PLATFORM
                  values: ["String"], # required
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                tags: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                cost_categories: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
              },
            },
            savings_plans_utilization: {
              time_range: { # required
                start_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
                end_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
              },
              granularity: "HOURLY", # accepts HOURLY, DAILY, MONTHLY
              filter: {
                or: [
                  {
                    # recursive Expression
                  },
                ],
                and: [
                  {
                    # recursive Expression
                  },
                ],
                not: {
                  # recursive Expression
                },
                dimensions: {
                  key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, RESOURCE_ID, SUBSCRIPTION_ID, TAG_KEY, OPERATING_SYSTEM, TENANCY, BILLING_ENTITY, RESERVATION_ID, COST_CATEGORY_NAME, DATABASE_ENGINE, LEGAL_ENTITY_NAME, SAVINGS_PLANS_TYPE, INSTANCE_TYPE_FAMILY, CACHE_ENGINE, DEPLOYMENT_OPTION, SCOPE, PLATFORM
                  values: ["String"], # required
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                tags: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                cost_categories: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
              },
            },
            reservation_coverage: {
              time_range: { # required
                start_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
                end_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
              },
              group_by: [
                {
                  key: "GroupDefinitionKeyString", # required
                  type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
                },
              ],
              granularity: "HOURLY", # accepts HOURLY, DAILY, MONTHLY
              filter: {
                or: [
                  {
                    # recursive Expression
                  },
                ],
                and: [
                  {
                    # recursive Expression
                  },
                ],
                not: {
                  # recursive Expression
                },
                dimensions: {
                  key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, RESOURCE_ID, SUBSCRIPTION_ID, TAG_KEY, OPERATING_SYSTEM, TENANCY, BILLING_ENTITY, RESERVATION_ID, COST_CATEGORY_NAME, DATABASE_ENGINE, LEGAL_ENTITY_NAME, SAVINGS_PLANS_TYPE, INSTANCE_TYPE_FAMILY, CACHE_ENGINE, DEPLOYMENT_OPTION, SCOPE, PLATFORM
                  values: ["String"], # required
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                tags: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                cost_categories: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
              },
              metrics: ["AmortizedCost"], # accepts AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, UsageQuantity, SpendCoveredBySavingsPlans, Hour, Unit, Cost
            },
            reservation_utilization: {
              time_range: { # required
                start_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
                end_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
              },
              group_by: [
                {
                  key: "GroupDefinitionKeyString", # required
                  type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
                },
              ],
              granularity: "HOURLY", # accepts HOURLY, DAILY, MONTHLY
              filter: {
                or: [
                  {
                    # recursive Expression
                  },
                ],
                and: [
                  {
                    # recursive Expression
                  },
                ],
                not: {
                  # recursive Expression
                },
                dimensions: {
                  key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, RESOURCE_ID, SUBSCRIPTION_ID, TAG_KEY, OPERATING_SYSTEM, TENANCY, BILLING_ENTITY, RESERVATION_ID, COST_CATEGORY_NAME, DATABASE_ENGINE, LEGAL_ENTITY_NAME, SAVINGS_PLANS_TYPE, INSTANCE_TYPE_FAMILY, CACHE_ENGINE, DEPLOYMENT_OPTION, SCOPE, PLATFORM
                  values: ["String"], # required
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                tags: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                cost_categories: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
              },
            },
          },
          display_config: { # required
            graph: {
              "GenericString" => {
                visual_type: "LINE", # required, accepts LINE, BAR, STACK
              },
            },
            table: {
            },
          },
        },
      ],
    },
  ],
  resource_tags: [
    {
      key: "ResourceTagKey", # required
      value: "ResourceTagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String

Parameters:

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

Options Hash (params):

:name (required, String) —
The name of the dashboard. The name must be unique within your account.
:description (String) —
A description of the dashboard's purpose or contents.
:widgets (required, Array<Types::Widget>) —
An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.
:resource_tags (Array<Types::ResourceTag>) —
The tags to apply to the dashboard resource for organization and management.

Returns:

(Types::CreateDashboardResponse) —
Returns a response object which responds to the following methods:
- #arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb', line 848

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

#delete_dashboard(params = {}) ⇒ `Types::DeleteDashboardResponse`

Deletes a specified dashboard. This action cannot be undone.

Examples:

Example: Deleting a dashboard


resp = client.delete_dashboard({
  arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
}

Request syntax with placeholder values


resp = client.delete_dashboard({
  arn: "DashboardArn", # required
})

Response structure


resp.arn #=> String

Parameters:

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

Options Hash (params):

:arn (required, String) —
The ARN of the dashboard to be deleted.

Returns:

(Types::DeleteDashboardResponse) —
Returns a response object which responds to the following methods:
- #arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb', line 888

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

#get_dashboard(params = {}) ⇒ `Types::GetDashboardResponse`

Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.

Examples:

Example: Getting information about a dashboard


resp = client.get_dashboard({
  arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
})

resp.to_h outputs the following:
{
  name: "cost-dashboards", 
  type: "CUSTOM", 
  arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
  created_at: Time.parse(1753741462.721), 
  description: "Dashboard for tracking costs", 
  updated_at: Time.parse(1753741462.721), 
  widgets: [
    {
      configs: [
        {
          display_config: {
            graph: {
              "costTrend" => {
                visual_type: "LINE", 
              }, 
            }, 
          }, 
          query_parameters: {
            cost_and_usage: {
              granularity: "MONTHLY", 
              group_by: [
                {
                  type: "DIMENSION", 
                  key: "SERVICE", 
                }, 
              ], 
              metrics: [
                "UnblendedCost", 
              ], 
              time_range: {
                end_time: {
                  type: "RELATIVE", 
                  value: "now", 
                }, 
                start_time: {
                  type: "RELATIVE", 
                  value: "-6M", 
                }, 
              }, 
            }, 
          }, 
        }, 
      ], 
      height: 7, 
      horizontal_offset: 0, 
      title: "Monthly Cost Trend", 
      width: 4, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_dashboard({
  arn: "DashboardArn", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.type #=> String, one of "CUSTOM"
resp.widgets #=> Array
resp.widgets[0].title #=> String
resp.widgets[0].description #=> String
resp.widgets[0].width #=> Integer
resp.widgets[0].height #=> Integer
resp.widgets[0].horizontal_offset #=> Integer
resp.widgets[0].configs #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.metrics #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.metrics[0] #=> String, one of "AmortizedCost", "BlendedCost", "NetAmortizedCost", "NetUnblendedCost", "NormalizedUsageAmount", "UnblendedCost", "UsageQuantity", "SpendCoveredBySavingsPlans", "Hour", "Unit", "Cost"
resp.widgets[0].configs[0].query_parameters.cost_and_usage.time_range.start_time.type #=> String, one of "ABSOLUTE", "RELATIVE"
resp.widgets[0].configs[0].query_parameters.cost_and_usage.time_range.start_time.value #=> String
resp.widgets[0].configs[0].query_parameters.cost_and_usage.time_range.end_time.type #=> String, one of "ABSOLUTE", "RELATIVE"
resp.widgets[0].configs[0].query_parameters.cost_and_usage.time_range.end_time.value #=> String
resp.widgets[0].configs[0].query_parameters.cost_and_usage.granularity #=> String, one of "HOURLY", "DAILY", "MONTHLY"
resp.widgets[0].configs[0].query_parameters.cost_and_usage.group_by #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.group_by[0].key #=> String
resp.widgets[0].configs[0].query_parameters.cost_and_usage.group_by[0].type #=> String, one of "DIMENSION", "TAG", "COST_CATEGORY"
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.or #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.or[0] #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.and #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.and[0] #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.not #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.dimensions.key #=> String, one of "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "RESOURCE_ID", "SUBSCRIPTION_ID", "TAG_KEY", "OPERATING_SYSTEM", "TENANCY", "BILLING_ENTITY", "RESERVATION_ID", "COST_CATEGORY_NAME", "DATABASE_ENGINE", "LEGAL_ENTITY_NAME", "SAVINGS_PLANS_TYPE", "INSTANCE_TYPE_FAMILY", "CACHE_ENGINE", "DEPLOYMENT_OPTION", "SCOPE", "PLATFORM"
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.dimensions.values #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.dimensions.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.dimensions.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.dimensions.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.tags.key #=> String
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.tags.values #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.tags.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.tags.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.tags.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.cost_categories.key #=> String
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.cost_categories.values #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.cost_categories.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.cost_categories.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.cost_and_usage.filter.cost_categories.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.time_range.start_time.type #=> String, one of "ABSOLUTE", "RELATIVE"
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.time_range.start_time.value #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.time_range.end_time.type #=> String, one of "ABSOLUTE", "RELATIVE"
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.time_range.end_time.value #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.metrics #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.metrics[0] #=> String, one of "AmortizedCost", "BlendedCost", "NetAmortizedCost", "NetUnblendedCost", "NormalizedUsageAmount", "UnblendedCost", "UsageQuantity", "SpendCoveredBySavingsPlans", "Hour", "Unit", "Cost"
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.granularity #=> String, one of "HOURLY", "DAILY", "MONTHLY"
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.group_by #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.group_by[0].key #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.group_by[0].type #=> String, one of "DIMENSION", "TAG", "COST_CATEGORY"
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.or #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.or[0] #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.and #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.and[0] #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.not #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.dimensions.key #=> String, one of "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "RESOURCE_ID", "SUBSCRIPTION_ID", "TAG_KEY", "OPERATING_SYSTEM", "TENANCY", "BILLING_ENTITY", "RESERVATION_ID", "COST_CATEGORY_NAME", "DATABASE_ENGINE", "LEGAL_ENTITY_NAME", "SAVINGS_PLANS_TYPE", "INSTANCE_TYPE_FAMILY", "CACHE_ENGINE", "DEPLOYMENT_OPTION", "SCOPE", "PLATFORM"
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.dimensions.values #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.dimensions.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.dimensions.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.dimensions.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.tags.key #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.tags.values #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.tags.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.tags.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.tags.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.cost_categories.key #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.cost_categories.values #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.cost_categories.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.cost_categories.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_coverage.filter.cost_categories.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.time_range.start_time.type #=> String, one of "ABSOLUTE", "RELATIVE"
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.time_range.start_time.value #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.time_range.end_time.type #=> String, one of "ABSOLUTE", "RELATIVE"
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.time_range.end_time.value #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.granularity #=> String, one of "HOURLY", "DAILY", "MONTHLY"
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.or #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.or[0] #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.and #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.and[0] #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.not #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.dimensions.key #=> String, one of "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "RESOURCE_ID", "SUBSCRIPTION_ID", "TAG_KEY", "OPERATING_SYSTEM", "TENANCY", "BILLING_ENTITY", "RESERVATION_ID", "COST_CATEGORY_NAME", "DATABASE_ENGINE", "LEGAL_ENTITY_NAME", "SAVINGS_PLANS_TYPE", "INSTANCE_TYPE_FAMILY", "CACHE_ENGINE", "DEPLOYMENT_OPTION", "SCOPE", "PLATFORM"
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.dimensions.values #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.dimensions.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.dimensions.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.dimensions.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.tags.key #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.tags.values #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.tags.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.tags.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.tags.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.cost_categories.key #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.cost_categories.values #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.cost_categories.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.cost_categories.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.savings_plans_utilization.filter.cost_categories.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.reservation_coverage.time_range.start_time.type #=> String, one of "ABSOLUTE", "RELATIVE"
resp.widgets[0].configs[0].query_parameters.reservation_coverage.time_range.start_time.value #=> String
resp.widgets[0].configs[0].query_parameters.reservation_coverage.time_range.end_time.type #=> String, one of "ABSOLUTE", "RELATIVE"
resp.widgets[0].configs[0].query_parameters.reservation_coverage.time_range.end_time.value #=> String
resp.widgets[0].configs[0].query_parameters.reservation_coverage.group_by #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_coverage.group_by[0].key #=> String
resp.widgets[0].configs[0].query_parameters.reservation_coverage.group_by[0].type #=> String, one of "DIMENSION", "TAG", "COST_CATEGORY"
resp.widgets[0].configs[0].query_parameters.reservation_coverage.granularity #=> String, one of "HOURLY", "DAILY", "MONTHLY"
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.or #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.or[0] #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.and #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.and[0] #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.not #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.dimensions.key #=> String, one of "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "RESOURCE_ID", "SUBSCRIPTION_ID", "TAG_KEY", "OPERATING_SYSTEM", "TENANCY", "BILLING_ENTITY", "RESERVATION_ID", "COST_CATEGORY_NAME", "DATABASE_ENGINE", "LEGAL_ENTITY_NAME", "SAVINGS_PLANS_TYPE", "INSTANCE_TYPE_FAMILY", "CACHE_ENGINE", "DEPLOYMENT_OPTION", "SCOPE", "PLATFORM"
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.dimensions.values #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.dimensions.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.dimensions.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.dimensions.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.tags.key #=> String
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.tags.values #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.tags.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.tags.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.tags.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.cost_categories.key #=> String
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.cost_categories.values #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.cost_categories.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.cost_categories.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_coverage.filter.cost_categories.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.reservation_coverage.metrics #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_coverage.metrics[0] #=> String, one of "AmortizedCost", "BlendedCost", "NetAmortizedCost", "NetUnblendedCost", "NormalizedUsageAmount", "UnblendedCost", "UsageQuantity", "SpendCoveredBySavingsPlans", "Hour", "Unit", "Cost"
resp.widgets[0].configs[0].query_parameters.reservation_utilization.time_range.start_time.type #=> String, one of "ABSOLUTE", "RELATIVE"
resp.widgets[0].configs[0].query_parameters.reservation_utilization.time_range.start_time.value #=> String
resp.widgets[0].configs[0].query_parameters.reservation_utilization.time_range.end_time.type #=> String, one of "ABSOLUTE", "RELATIVE"
resp.widgets[0].configs[0].query_parameters.reservation_utilization.time_range.end_time.value #=> String
resp.widgets[0].configs[0].query_parameters.reservation_utilization.group_by #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_utilization.group_by[0].key #=> String
resp.widgets[0].configs[0].query_parameters.reservation_utilization.group_by[0].type #=> String, one of "DIMENSION", "TAG", "COST_CATEGORY"
resp.widgets[0].configs[0].query_parameters.reservation_utilization.granularity #=> String, one of "HOURLY", "DAILY", "MONTHLY"
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.or #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.or[0] #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.and #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.and[0] #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.not #=> Types::Expression
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.dimensions.key #=> String, one of "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "RESOURCE_ID", "SUBSCRIPTION_ID", "TAG_KEY", "OPERATING_SYSTEM", "TENANCY", "BILLING_ENTITY", "RESERVATION_ID", "COST_CATEGORY_NAME", "DATABASE_ENGINE", "LEGAL_ENTITY_NAME", "SAVINGS_PLANS_TYPE", "INSTANCE_TYPE_FAMILY", "CACHE_ENGINE", "DEPLOYMENT_OPTION", "SCOPE", "PLATFORM"
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.dimensions.values #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.dimensions.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.dimensions.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.dimensions.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.tags.key #=> String
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.tags.values #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.tags.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.tags.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.tags.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.cost_categories.key #=> String
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.cost_categories.values #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.cost_categories.values[0] #=> String
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.cost_categories.match_options #=> Array
resp.widgets[0].configs[0].query_parameters.reservation_utilization.filter.cost_categories.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.widgets[0].configs[0].display_config.graph #=> Hash
resp.widgets[0].configs[0].display_config.graph["GenericString"].visual_type #=> String, one of "LINE", "BAR", "STACK"
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

Options Hash (params):

:arn (required, String) —
The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.

Returns:

(Types::GetDashboardResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #name => String
- #description => String
- #type => String
- #widgets => Array<Types::Widget>
- #created_at => Time
- #updated_at => Time

See Also:

AWS API Documentation

# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb', line 1141

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

#get_resource_policy(params = {}) ⇒ `Types::GetResourcePolicyResponse`

Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.

Examples:

Example: Getting resource policy for a resource


resp = client.get_resource_policy({
  resource_arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
})

resp.to_h outputs the following:
{
  policy_document: "{}", 
  resource_arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
}

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "DashboardArn", # required
})

Response structure


resp.resource_arn #=> String
resp.policy_document #=> String

Parameters:

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

Options Hash (params):

:resource_arn (required, String) —
The ARN of the dashboard whose resource-based policy you want to retrieve.

Returns:

(Types::GetResourcePolicyResponse) —
Returns a response object which responds to the following methods:
- #resource_arn => String
- #policy_document => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb', line 1186

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

#list_dashboards(params = {}) ⇒ `Types::ListDashboardsResponse`

Returns a list of all dashboards in your account.

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

Examples:

Example: Listing dashboards for a user


resp = client.list_dashboards({
})

resp.to_h outputs the following:
{
  dashboards: [
    {
      name: "monthly-cost-dashboard", 
      type: "CUSTOM", 
      arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
      created_at: Time.parse(1753741462.721), 
      description: "Dashboard for tracking monthly cost", 
      updated_at: Time.parse(1753741462.721), 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_dashboards({
  max_results: 1,
  next_token: "NextPageToken",
})

Response structure


resp.dashboards #=> Array
resp.dashboards[0].arn #=> String
resp.dashboards[0].name #=> String
resp.dashboards[0].description #=> String
resp.dashboards[0].type #=> String, one of "CUSTOM"
resp.dashboards[0].created_at #=> Time
resp.dashboards[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:max_results (Integer) —
The maximum number of results to return in a single call. The default value is 20.
:next_token (String) —
The token for the next page of results. Use the value returned in the previous response.

Returns:

(Types::ListDashboardsResponse) —
Returns a response object which responds to the following methods:
- #dashboards => Array<Types::DashboardReference>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb', line 1250

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

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

Returns a list of all tags associated with a specified dashboard resource.

Examples:

Example: Listing tags for a resource


resp = client.list_tags_for_resource({
  resource_arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
})

resp.to_h outputs the following:
{
  resource_tags: [
    {
      key: "keyOne", 
      value: "valueOne", 
    }, 
    {
      key: "keyTwo", 
      value: "valueTwo", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "DashboardArn", # required
})

Response structure


resp.resource_tags #=> Array
resp.resource_tags[0].key #=> String
resp.resource_tags[0].value #=> String

Parameters:

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

Options Hash (params):

:resource_arn (required, String) —
The unique identifier for the resource.

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #resource_tags => Array<Types::ResourceTag>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb', line 1302

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

#tag_resource(params = {}) ⇒ `Struct`

Adds or updates tags for a specified dashboard resource.

Examples:

Example: Adding tag(s) to a resource


resp = client.tag_resource({
  resource_arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
  resource_tags: [
    {
      key: "keyOne", 
      value: "valueOne", 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "DashboardArn", # required
  resource_tags: [ # required
    {
      key: "ResourceTagKey", # required
      value: "ResourceTagValue", # required
    },
  ],
})

Parameters:

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

Options Hash (params):

:resource_arn (required, String) —
The unique identifier for the resource.
:resource_tags (required, Array<Types::ResourceTag>) —
The tags to add to the dashboard resource.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb', line 1346

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

#untag_resource(params = {}) ⇒ `Struct`

Removes specified tags from a dashboard resource.

Examples:

Example: Removing tag(s) from a resource


resp = client.untag_resource({
  resource_arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
  resource_tag_keys: [
    "keyOne", 
  ], 
})

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "DashboardArn", # required
  resource_tag_keys: ["ResourceTagKey"], # required
})

Parameters:

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

Options Hash (params):

:resource_arn (required, String) —
The unique identifier for the resource.
:resource_tag_keys (required, Array<String>) —
The keys of the tags to remove from the dashboard resource.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb', line 1382

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

#update_dashboard(params = {}) ⇒ `Types::UpdateDashboardResponse`

Updates an existing dashboard's properties, including its name, description, and widget configurations.

Examples:

Example: Updating a dashboard


resp = client.update_dashboard({
  name: "cost-dashboards-updated", 
  arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", 
  description: "Dashboard for tracking costs version 2", 
  widgets: [
    {
      configs: [
        {
          display_config: {
            graph: {
              "costTrend" => {
                visual_type: "LINE", 
              }, 
            }, 
          }, 
          query_parameters: {
            cost_and_usage: {
              granularity: "MONTHLY", 
              group_by: [
                {
                  type: "DIMENSION", 
                  key: "SERVICE", 
                }, 
              ], 
              metrics: [
                "UnblendedCost", 
              ], 
              time_range: {
                end_time: {
                  type: "RELATIVE", 
                  value: "now", 
                }, 
                start_time: {
                  type: "RELATIVE", 
                  value: "-3M", 
                }, 
              }, 
            }, 
          }, 
        }, 
      ], 
      height: 7, 
      horizontal_offset: 2, 
      title: "Monthly Cost Trend", 
      width: 4, 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.update_dashboard({
  arn: "DashboardArn", # required
  name: "DashboardName",
  description: "Description",
  widgets: [
    {
      title: "WidgetTitle", # required
      description: "Description",
      width: 1,
      height: 1,
      horizontal_offset: 1,
      configs: [ # required
        {
          query_parameters: { # required
            cost_and_usage: {
              metrics: ["AmortizedCost"], # required, accepts AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, UsageQuantity, SpendCoveredBySavingsPlans, Hour, Unit, Cost
              time_range: { # required
                start_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
                end_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
              },
              granularity: "HOURLY", # required, accepts HOURLY, DAILY, MONTHLY
              group_by: [
                {
                  key: "GroupDefinitionKeyString", # required
                  type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
                },
              ],
              filter: {
                or: [
                  {
                    # recursive Expression
                  },
                ],
                and: [
                  {
                    # recursive Expression
                  },
                ],
                not: {
                  # recursive Expression
                },
                dimensions: {
                  key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, RESOURCE_ID, SUBSCRIPTION_ID, TAG_KEY, OPERATING_SYSTEM, TENANCY, BILLING_ENTITY, RESERVATION_ID, COST_CATEGORY_NAME, DATABASE_ENGINE, LEGAL_ENTITY_NAME, SAVINGS_PLANS_TYPE, INSTANCE_TYPE_FAMILY, CACHE_ENGINE, DEPLOYMENT_OPTION, SCOPE, PLATFORM
                  values: ["String"], # required
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                tags: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                cost_categories: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
              },
            },
            savings_plans_coverage: {
              time_range: { # required
                start_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
                end_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
              },
              metrics: ["AmortizedCost"], # accepts AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, UsageQuantity, SpendCoveredBySavingsPlans, Hour, Unit, Cost
              granularity: "HOURLY", # accepts HOURLY, DAILY, MONTHLY
              group_by: [
                {
                  key: "GroupDefinitionKeyString", # required
                  type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
                },
              ],
              filter: {
                or: [
                  {
                    # recursive Expression
                  },
                ],
                and: [
                  {
                    # recursive Expression
                  },
                ],
                not: {
                  # recursive Expression
                },
                dimensions: {
                  key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, RESOURCE_ID, SUBSCRIPTION_ID, TAG_KEY, OPERATING_SYSTEM, TENANCY, BILLING_ENTITY, RESERVATION_ID, COST_CATEGORY_NAME, DATABASE_ENGINE, LEGAL_ENTITY_NAME, SAVINGS_PLANS_TYPE, INSTANCE_TYPE_FAMILY, CACHE_ENGINE, DEPLOYMENT_OPTION, SCOPE, PLATFORM
                  values: ["String"], # required
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                tags: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                cost_categories: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
              },
            },
            savings_plans_utilization: {
              time_range: { # required
                start_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
                end_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
              },
              granularity: "HOURLY", # accepts HOURLY, DAILY, MONTHLY
              filter: {
                or: [
                  {
                    # recursive Expression
                  },
                ],
                and: [
                  {
                    # recursive Expression
                  },
                ],
                not: {
                  # recursive Expression
                },
                dimensions: {
                  key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, RESOURCE_ID, SUBSCRIPTION_ID, TAG_KEY, OPERATING_SYSTEM, TENANCY, BILLING_ENTITY, RESERVATION_ID, COST_CATEGORY_NAME, DATABASE_ENGINE, LEGAL_ENTITY_NAME, SAVINGS_PLANS_TYPE, INSTANCE_TYPE_FAMILY, CACHE_ENGINE, DEPLOYMENT_OPTION, SCOPE, PLATFORM
                  values: ["String"], # required
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                tags: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                cost_categories: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
              },
            },
            reservation_coverage: {
              time_range: { # required
                start_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
                end_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
              },
              group_by: [
                {
                  key: "GroupDefinitionKeyString", # required
                  type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
                },
              ],
              granularity: "HOURLY", # accepts HOURLY, DAILY, MONTHLY
              filter: {
                or: [
                  {
                    # recursive Expression
                  },
                ],
                and: [
                  {
                    # recursive Expression
                  },
                ],
                not: {
                  # recursive Expression
                },
                dimensions: {
                  key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, RESOURCE_ID, SUBSCRIPTION_ID, TAG_KEY, OPERATING_SYSTEM, TENANCY, BILLING_ENTITY, RESERVATION_ID, COST_CATEGORY_NAME, DATABASE_ENGINE, LEGAL_ENTITY_NAME, SAVINGS_PLANS_TYPE, INSTANCE_TYPE_FAMILY, CACHE_ENGINE, DEPLOYMENT_OPTION, SCOPE, PLATFORM
                  values: ["String"], # required
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                tags: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                cost_categories: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
              },
              metrics: ["AmortizedCost"], # accepts AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, UsageQuantity, SpendCoveredBySavingsPlans, Hour, Unit, Cost
            },
            reservation_utilization: {
              time_range: { # required
                start_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
                end_time: { # required
                  type: "ABSOLUTE", # required, accepts ABSOLUTE, RELATIVE
                  value: "GenericString", # required
                },
              },
              group_by: [
                {
                  key: "GroupDefinitionKeyString", # required
                  type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
                },
              ],
              granularity: "HOURLY", # accepts HOURLY, DAILY, MONTHLY
              filter: {
                or: [
                  {
                    # recursive Expression
                  },
                ],
                and: [
                  {
                    # recursive Expression
                  },
                ],
                not: {
                  # recursive Expression
                },
                dimensions: {
                  key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, RESOURCE_ID, SUBSCRIPTION_ID, TAG_KEY, OPERATING_SYSTEM, TENANCY, BILLING_ENTITY, RESERVATION_ID, COST_CATEGORY_NAME, DATABASE_ENGINE, LEGAL_ENTITY_NAME, SAVINGS_PLANS_TYPE, INSTANCE_TYPE_FAMILY, CACHE_ENGINE, DEPLOYMENT_OPTION, SCOPE, PLATFORM
                  values: ["String"], # required
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                tags: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
                cost_categories: {
                  key: "String",
                  values: ["String"],
                  match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
                },
              },
            },
          },
          display_config: { # required
            graph: {
              "GenericString" => {
                visual_type: "LINE", # required, accepts LINE, BAR, STACK
              },
            },
            table: {
            },
          },
        },
      ],
    },
  ],
})

Response structure


resp.arn #=> String

Parameters:

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

Options Hash (params):

:arn (required, String) —
The ARN of the dashboard to update.
:name (String) —
The new name for the dashboard. If not specified, the existing name is retained.
:description (String) —
The new description for the dashboard. If not specified, the existing description is retained.
:widgets (Array<Types::Widget>) —
The updated array of widget configurations for the dashboard. Replaces all existing widgets.

Returns:

(Types::UpdateDashboardResponse) —
Returns a response object which responds to the following methods:
- #arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/client.rb', line 1743

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

Class: Aws::BCMDashboards::Client

Overview

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options) ⇒ Client

Instance Method Details

#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse

Examples:

Example: Creating a dashboard

Request syntax with placeholder values

Response structure

#delete_dashboard(params = {}) ⇒ Types::DeleteDashboardResponse

Examples:

Example: Deleting a dashboard

Request syntax with placeholder values

Response structure

#get_dashboard(params = {}) ⇒ Types::GetDashboardResponse

Examples:

Example: Getting information about a dashboard

Request syntax with placeholder values

Response structure

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse

Examples:

Example: Getting resource policy for a resource

Request syntax with placeholder values

Response structure

#list_dashboards(params = {}) ⇒ Types::ListDashboardsResponse

Examples:

Example: Listing dashboards for a user

Request syntax with placeholder values

Response structure

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

Examples:

Example: Listing tags for a resource

Request syntax with placeholder values

Response structure

#tag_resource(params = {}) ⇒ Struct

Examples:

Example: Adding tag(s) to a resource

Request syntax with placeholder values

#untag_resource(params = {}) ⇒ Struct

Examples:

Example: Removing tag(s) from a resource

Request syntax with placeholder values

#update_dashboard(params = {}) ⇒ Types::UpdateDashboardResponse

Examples:

Example: Updating a dashboard

Request syntax with placeholder values

Response structure

#initialize(options) ⇒ `Client`

#create_dashboard(params = {}) ⇒ `Types::CreateDashboardResponse`

#delete_dashboard(params = {}) ⇒ `Types::DeleteDashboardResponse`

#get_dashboard(params = {}) ⇒ `Types::GetDashboardResponse`

#get_resource_policy(params = {}) ⇒ `Types::GetResourcePolicyResponse`

#list_dashboards(params = {}) ⇒ `Types::ListDashboardsResponse`

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

#tag_resource(params = {}) ⇒ `Struct`

#untag_resource(params = {}) ⇒ `Struct`

#update_dashboard(params = {}) ⇒ `Types::UpdateDashboardResponse`