Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Billing and Cost Management Dashboards

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

Constructing a Client

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

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

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

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

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

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

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

Using the Client

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

let result = client.create_dashboard()
    .name("example")
    .send()
    .await;

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

Implementations

impl Client

pub fn create_dashboard(&self) -> CreateDashboardFluentBuilder

Constructs a fluent builder for the CreateDashboard operation.

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

    The name of the dashboard. The name must be unique within your account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the dashboard’s purpose or contents.

    
    
  • widgets(Widget) / set_widgets(Option<Vec::<Widget>>):
    required: true
    

    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(ResourceTag) / set_resource_tags(Option<Vec::<ResourceTag>>):
    required: false
    

    The tags to apply to the dashboard resource for organization and management.

    
    
• On success, responds with CreateDashboardOutput with field(s):
  • arn(String):

    The ARN of the newly created dashboard.

• On failure, responds with SdkError<CreateDashboardError>

impl Client

pub fn delete_dashboard(&self) -> DeleteDashboardFluentBuilder

Constructs a fluent builder for the DeleteDashboard operation.

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

    The ARN of the dashboard to be deleted.

    
    
• On success, responds with DeleteDashboardOutput with field(s):
  • arn(String):

    The ARN of the dashboard that was deleted.

• On failure, responds with SdkError<DeleteDashboardError>

impl Client

pub fn get_dashboard(&self) -> GetDashboardFluentBuilder

Constructs a fluent builder for the GetDashboard operation.

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

    The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.

    
    
• On success, responds with GetDashboardOutput with field(s):
  • arn(String):

    The ARN of the retrieved dashboard.

  • name(String):

    The name of the retrieved dashboard.

  • description(Option<String>):

    The description of the retrieved dashboard.

  • r#type(DashboardType):

    Indicates the dashboard type.

  • widgets(Vec::<Widget>):

    An array of widget configurations that make up the dashboard.

  • created_at(DateTime):

    The timestamp when the dashboard was created.

  • updated_at(DateTime):

    The timestamp when the dashboard was last modified.

• On failure, responds with SdkError<GetDashboardError>

impl Client

pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder

Constructs a fluent builder for the GetResourcePolicy operation.

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

    The ARN of the dashboard whose resource-based policy you want to retrieve.

    
    
• On success, responds with GetResourcePolicyOutput with field(s):
  • resource_arn(String):

    The ARN of the dashboard for which the resource-based policy was retrieved.

  • policy_document(String):

    The JSON policy document that represents the dashboard’s resource-based policy.

• On failure, responds with SdkError<GetResourcePolicyError>

impl Client

pub fn list_dashboards(&self) -> ListDashboardsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call. The default value is 20.

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

    The token for the next page of results. Use the value returned in the previous response.

    
    
• On success, responds with ListDashboardsOutput with field(s):
  • dashboards(Vec::<DashboardReference>):

    An array of dashboard references, containing basic information about each dashboard.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.

• On failure, responds with SdkError<ListDashboardsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The unique identifier for the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • resource_tags(Option<Vec::<ResourceTag>>):

    The list of tags associated with the specified dashboard resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    The unique identifier for the resource.

    
    
  • resource_tags(ResourceTag) / set_resource_tags(Option<Vec::<ResourceTag>>):
    required: true
    

    The tags to add to the dashboard resource.

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

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    The unique identifier for the resource.

    
    
  • resource_tag_keys(impl Into<String>) / set_resource_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags to remove from the dashboard resource.

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

impl Client

pub fn update_dashboard(&self) -> UpdateDashboardFluentBuilder

Constructs a fluent builder for the UpdateDashboard operation.

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

    The ARN of the dashboard to update.

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

    The new name for the dashboard. If not specified, the existing name is retained.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new description for the dashboard. If not specified, the existing description is retained.

    
    
  • widgets(Widget) / set_widgets(Option<Vec::<Widget>>):
    required: false
    

    The updated array of widget configurations for the dashboard. Replaces all existing widgets.

    
    
• On success, responds with UpdateDashboardOutput with field(s):
  • arn(String):

    The ARN of the updated dashboard.

• On failure, responds with SdkError<UpdateDashboardError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

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

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

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

Creates a new client from an SDK Config.

Panics

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

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.