Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Billing and Cost Management Data Exports

Client for invoking operations on AWS Billing and Cost Management Data Exports. Each operation on AWS Billing and Cost Management Data Exports 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_bcmdataexports::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_bcmdataexports::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 DeleteExport operation has a Client::delete_export, 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_export()
    .export_arn("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_export(&self) -> CreateExportFluentBuilder

Constructs a fluent builder for the CreateExport operation.

• The fluent builder is configurable:
  • export(Export) / set_export(Option<Export>):
    required: true
    

    The details of the export, including data query, name, description, and destination configuration.

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

    An optional list of tags to associate with the specified export. Each tag consists of a key and a value, and each key must be unique for the resource.

    
    
• On success, responds with CreateExportOutput with field(s):
  • export_arn(Option<String>):

    The Amazon Resource Name (ARN) for this export.

• On failure, responds with SdkError<CreateExportError>

impl Client

pub fn delete_export(&self) -> DeleteExportFluentBuilder

Constructs a fluent builder for the DeleteExport operation.

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

    The Amazon Resource Name (ARN) for this export.

    
    
• On success, responds with DeleteExportOutput with field(s):
  • export_arn(Option<String>):

    The Amazon Resource Name (ARN) for this export.

• On failure, responds with SdkError<DeleteExportError>

impl Client

pub fn get_execution(&self) -> GetExecutionFluentBuilder

Constructs a fluent builder for the GetExecution operation.

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

    The Amazon Resource Name (ARN) of the Export object that generated this specific execution.

    
    
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The ID for this specific execution.

    
    
• On success, responds with GetExecutionOutput with field(s):
  • execution_id(Option<String>):

    The ID for this specific execution.

  • export(Option<Export>):

    The export data for this specific execution. This export data is a snapshot from when the execution was generated. The data could be different from the current export data if the export was updated since the execution was generated.

  • execution_status(Option<ExecutionStatus>):

    The status of this specific execution.

• On failure, responds with SdkError<GetExecutionError>

impl Client

pub fn get_export(&self) -> GetExportFluentBuilder

Constructs a fluent builder for the GetExport operation.

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

    The Amazon Resource Name (ARN) for this export.

    
    
• On success, responds with GetExportOutput with field(s):
  • export(Option<Export>):

    The data for this specific export.

  • export_status(Option<ExportStatus>):

    The status of this specific export.

• On failure, responds with SdkError<GetExportError>

impl Client

pub fn get_table(&self) -> GetTableFluentBuilder

Constructs a fluent builder for the GetTable operation.

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

    The name of the table.

    
    
  • table_properties(impl Into<String>, impl Into<String>) / set_table_properties(Option<HashMap::<String, String>>):
    required: false
    

    TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. Tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified.

    
    
• On success, responds with GetTableOutput with field(s):
  • table_name(Option<String>):

    The name of the table.

  • description(Option<String>):

    The table description.

  • table_properties(Option<HashMap::<String, String>>):

    TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. Tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified.

  • schema(Option<Vec::<Column>>):

    The schema of the table.

• On failure, responds with SdkError<GetTableError>

impl Client

pub fn list_executions(&self) -> ListExecutionsFluentBuilder

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

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

    The Amazon Resource Name (ARN) for this export.

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

    The maximum number of objects that are returned for the request.

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

    The token to retrieve the next set of results.

    
    
• On success, responds with ListExecutionsOutput with field(s):
  • executions(Option<Vec::<ExecutionReference>>):

    The list of executions.

  • next_token(Option<String>):

    The token to retrieve the next set of results.

• On failure, responds with SdkError<ListExecutionsError>

impl Client

pub fn list_exports(&self) -> ListExportsFluentBuilder

Constructs a fluent builder for the ListExports 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 objects that are returned for the request.

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

    The token to retrieve the next set of results.

    
    
• On success, responds with ListExportsOutput with field(s):
  • exports(Option<Vec::<ExportReference>>):

    The details of the exports, including name and export status.

  • next_token(Option<String>):

    The token to retrieve the next set of results.

• On failure, responds with SdkError<ListExportsError>

impl Client

pub fn list_tables(&self) -> ListTablesFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to retrieve the next set of results.

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

    The maximum number of objects that are returned for the request.

    
    
• On success, responds with ListTablesOutput with field(s):
  • tables(Option<Vec::<Table>>):

    The list of tables.

  • next_token(Option<String>):

    The token to retrieve the next set of results.

• On failure, responds with SdkError<ListTablesError>

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.

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

    The maximum number of objects that are returned for the request.

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

    The token to retrieve the next set of results.

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

    An optional list of tags to associate with the specified export. Each tag consists of a key and a value, and each key must be unique for the resource.

  • next_token(Option<String>):

    The token to retrieve the next set of results.

• 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 associate with the resource. Each tag consists of a key and a value, and each key must be unique for 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 unique identifier for the resource.

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

    The tag keys that are associated with the resource ARN.

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

impl Client

pub fn update_export(&self) -> UpdateExportFluentBuilder

Constructs a fluent builder for the UpdateExport operation.

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

    The Amazon Resource Name (ARN) for this export.

    
    
  • export(Export) / set_export(Option<Export>):
    required: true
    

    The name and query details for the export.

    
    
• On success, responds with UpdateExportOutput with field(s):
  • export_arn(Option<String>):

    The Amazon Resource Name (ARN) for this export.

• On failure, responds with SdkError<UpdateExportError>

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.