Struct Client

pub struct Client { /* private fields */ }

Client for AWS Billing

Client for invoking operations on AWS Billing. Each operation on AWS Billing 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_billing::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_billing::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 CreateBillingView operation has a Client::create_billing_view, 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_billing_view()
    .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_billing_view(&self) -> CreateBillingViewFluentBuilder

Constructs a fluent builder for the CreateBillingView operation.

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

    The name of the billing view.

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

    The description of the billing view.

    
    
  • source_views(impl Into<String>) / set_source_views(Option<Vec::<String>>):
    required: true
    

    A list of billing views used as the data source for the custom billing view.

    
    
  • data_filter_expression(Expression) / set_data_filter_expression(Option<Expression>):
    required: false
    

    See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

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

    A unique, case-sensitive identifier you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. If the original request completes successfully, any subsequent retries complete successfully without performing any further actions with an idempotent request.

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

    A list of key value map specifying tags associated to the billing view being created.

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

    The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

  • created_at(Option<DateTime>):

    The time when the billing view was created.

• On failure, responds with SdkError<CreateBillingViewError>

impl Client

pub fn delete_billing_view(&self) -> DeleteBillingViewFluentBuilder

Constructs a fluent builder for the DeleteBillingView operation.

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

    The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

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

    The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

• On failure, responds with SdkError<DeleteBillingViewError>

impl Client

pub fn get_billing_view(&self) -> GetBillingViewFluentBuilder

Constructs a fluent builder for the GetBillingView operation.

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

    The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

    
    
• On success, responds with GetBillingViewOutput with field(s):
  • billing_view(Option<BillingViewElement>):

    The billing view element associated with the specified ARN.

• On failure, responds with SdkError<GetBillingViewError>

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 Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.

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

    The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.

  • policy(Option<String>):

    The resource-based policy document attached to the resource in JSON format.

• On failure, responds with SdkError<GetResourcePolicyError>

impl Client

pub fn list_billing_views(&self) -> ListBillingViewsFluentBuilder

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

• The fluent builder is configurable:
  • active_time_range(ActiveTimeRange) / set_active_time_range(Option<ActiveTimeRange>):
    required: false
    

    The time range for the billing views listed. PRIMARY billing view is always listed. BILLING_GROUP billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.

    
    
  • arns(impl Into<String>) / set_arns(Option<Vec::<String>>):
    required: false
    

    The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

    
    
  • billing_view_types(BillingViewType) / set_billing_view_types(Option<Vec::<BillingViewType>>):
    required: false
    

    The type of billing view.

    
    
  • owner_account_id(impl Into<String>) / set_owner_account_id(Option<String>):
    required: false
    

    The list of owners of the billing view.

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

    The maximum number of billing views to retrieve. Default is 100.

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

    The pagination token that is used on subsequent calls to list billing views.

    
    
• On success, responds with ListBillingViewsOutput with field(s):
  • billing_views(Vec::<BillingViewListElement>):

    A list of BillingViewListElement retrieved.

  • next_token(Option<String>):

    The pagination token to use on subsequent calls to list billing views.

• On failure, responds with SdkError<ListBillingViewsError>

impl Client

pub fn list_source_views_for_billing_view( &self, ) -> ListSourceViewsForBillingViewFluentBuilder

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

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

    The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

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

    The number of entries a paginated response contains.

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

    The pagination token that is used on subsequent calls to list billing views.

    
    
• On success, responds with ListSourceViewsForBillingViewOutput with field(s):
  • source_views(Vec::<String>):

    A list of billing views used as the data source for the custom billing view.

  • next_token(Option<String>):

    The pagination token that is used on subsequent calls to list billing views.

• On failure, responds with SdkError<ListSourceViewsForBillingViewError>

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 Amazon Resource Name (ARN) of the resource.

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

    A list of tag key value pairs that are associated with the 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 Amazon Resource Name (ARN) of the resource.

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

    A list of tag key value pairs that are associated with the resource.

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

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

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

    A list of tag key value pairs that are associated with the resource.

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

impl Client

pub fn update_billing_view(&self) -> UpdateBillingViewFluentBuilder

Constructs a fluent builder for the UpdateBillingView operation.

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

    The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

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

    The name of the billing view.

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

    The description of the billing view.

    
    
  • data_filter_expression(Expression) / set_data_filter_expression(Option<Expression>):
    required: false
    

    See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

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

    The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

  • updated_at(Option<DateTime>):

    The time when the billing view was last updated.

• On failure, responds with SdkError<UpdateBillingViewError>

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.