Struct Client

pub struct Client { /* private fields */ }

Client for AWS Cost and Usage Report Service

Client for invoking operations on AWS Cost and Usage Report Service. Each operation on AWS Cost and Usage Report Service 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_costandusagereport::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_costandusagereport::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 DeleteReportDefinition operation has a Client::delete_report_definition, 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.delete_report_definition()
    .report_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 delete_report_definition(&self) -> DeleteReportDefinitionFluentBuilder

Constructs a fluent builder for the DeleteReportDefinition operation.

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

    The name of the report that you want to delete. The name must be unique, is case sensitive, and can’t include spaces.

    
    
• On success, responds with DeleteReportDefinitionOutput with field(s):
  • response_message(Option<String>):

    Whether the deletion was successful or not.

• On failure, responds with SdkError<DeleteReportDefinitionError>

impl Client

pub fn describe_report_definitions( &self, ) -> DescribeReportDefinitionsFluentBuilder

Constructs a fluent builder for the DescribeReportDefinitions 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 that Amazon Web Services returns for the operation.

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

    A generic string.

    
    
• On success, responds with DescribeReportDefinitionsOutput with field(s):
  • report_definitions(Option<Vec::<ReportDefinition>>):

    An Amazon Web Services Cost and Usage Report list owned by the account.

  • next_token(Option<String>):

    A generic string.

• On failure, responds with SdkError<DescribeReportDefinitionsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The report name of the report definition that tags are to be returned for.

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

    The tags assigned to the report definition resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn modify_report_definition(&self) -> ModifyReportDefinitionFluentBuilder

Constructs a fluent builder for the ModifyReportDefinition operation.

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

    The name of the report that you want to create. The name must be unique, is case sensitive, and can’t include spaces.

    
    
  • report_definition(ReportDefinition) / set_report_definition(Option<ReportDefinition>):
    required: true
    

    The definition of Amazon Web Services Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.

    
    
• On success, responds with ModifyReportDefinitionOutput
• On failure, responds with SdkError<ModifyReportDefinitionError>

impl Client

pub fn put_report_definition(&self) -> PutReportDefinitionFluentBuilder

Constructs a fluent builder for the PutReportDefinition operation.

• The fluent builder is configurable:
  • report_definition(ReportDefinition) / set_report_definition(Option<ReportDefinition>):
    required: true
    

    Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and data file information.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to be assigned to the report definition resource.

    
    
• On success, responds with PutReportDefinitionOutput
• On failure, responds with SdkError<PutReportDefinitionError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    The report name of the report definition that tags are to be associated with.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tags to be assigned to the report definition 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:
  • report_name(impl Into<String>) / set_report_name(Option<String>):
    required: true
    

    The report name of the report definition that tags are to be disassociated from.

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

    The tags to be disassociated from the report definition resource.

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

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 copy 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.