Struct Client

pub struct Client { /* private fields */ }

Client for AWS Invoicing

Client for invoking operations on AWS Invoicing. Each operation on AWS Invoicing 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_invoicing::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_invoicing::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 CreateInvoiceUnit operation has a Client::create_invoice_unit, 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_invoice_unit()
    .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 batch_get_invoice_profile(&self) -> BatchGetInvoiceProfileFluentBuilder

Constructs a fluent builder for the BatchGetInvoiceProfile operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    Retrieves the corresponding invoice profile data for these account IDs.

    
    
• On success, responds with BatchGetInvoiceProfileOutput with field(s):
  • profiles(Option<Vec::<InvoiceProfile>>):

    A list of invoice profiles corresponding to the requested accounts.

• On failure, responds with SdkError<BatchGetInvoiceProfileError>

impl Client

pub fn create_invoice_unit(&self) -> CreateInvoiceUnitFluentBuilder

Constructs a fluent builder for the CreateInvoiceUnit operation.

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

    The unique name of the invoice unit that is shown on the generated invoice. This can’t be changed once it is set. To change this name, you must delete the invoice unit recreate.

    
    
  • invoice_receiver(impl Into<String>) / set_invoice_receiver(Option<String>):
    required: true
    

    The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID.

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

    The invoice unit’s description. This can be changed at a later time.

    
    
  • tax_inheritance_disabled(bool) / set_tax_inheritance_disabled(Option<bool>):
    required: false
    

    Whether the invoice unit based tax inheritance is/ should be enabled or disabled.

    
    
  • rule(InvoiceUnitRule) / set_rule(Option<InvoiceUnitRule>):
    required: true
    

    The InvoiceUnitRule object used to create invoice units.

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

    The tag structure that contains a tag key and value.

    
    
• On success, responds with CreateInvoiceUnitOutput with field(s):
  • invoice_unit_arn(Option<String>):

    The ARN to identify an invoice unit. This information can’t be modified or deleted.

• On failure, responds with SdkError<CreateInvoiceUnitError>

impl Client

pub fn delete_invoice_unit(&self) -> DeleteInvoiceUnitFluentBuilder

Constructs a fluent builder for the DeleteInvoiceUnit operation.

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

    The ARN to identify an invoice unit. This information can’t be modified or deleted.

    
    
• On success, responds with DeleteInvoiceUnitOutput with field(s):
  • invoice_unit_arn(Option<String>):

    The ARN to identify an invoice unit. This information can’t be modified or deleted.

• On failure, responds with SdkError<DeleteInvoiceUnitError>

impl Client

pub fn get_invoice_unit(&self) -> GetInvoiceUnitFluentBuilder

Constructs a fluent builder for the GetInvoiceUnit operation.

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

    The ARN to identify an invoice unit. This information can’t be modified or deleted.

    
    
  • as_of(DateTime) / set_as_of(Option<DateTime>):
    required: false
    

    The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf time is set to before it was deleted. If an AsOf is not provided, the default value is the current time.

    
    
• On success, responds with GetInvoiceUnitOutput with field(s):
  • invoice_unit_arn(Option<String>):

    The ARN to identify an invoice unit. This information can’t be modified or deleted.

  • invoice_receiver(Option<String>):

    The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID.

  • name(Option<String>):

    The unique name of the invoice unit that is shown on the generated invoice.

  • description(Option<String>):

    The assigned description for an invoice unit.

  • tax_inheritance_disabled(Option<bool>):

    Whether the invoice unit based tax inheritance is/ should be enabled or disabled.

  • rule(Option<InvoiceUnitRule>):

    This is used to categorize the invoice unit. Values are Amazon Web Services account IDs. Currently, the only supported rule is LINKED_ACCOUNT.

  • last_modified(Option<DateTime>):

    The most recent date the invoice unit response was updated.

• On failure, responds with SdkError<GetInvoiceUnitError>

impl Client

pub fn list_invoice_units(&self) -> ListInvoiceUnitsFluentBuilder

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

• The fluent builder is configurable:
  • filters(Filters) / set_filters(Option<Filters>):
    required: false
    

    An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers, Names, and Accounts.

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

    The next token used to indicate where the returned list should start from.

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

    The maximum number of invoice units that can be returned.

    
    
  • as_of(DateTime) / set_as_of(Option<DateTime>):
    required: false
    

    The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf time is set to before it was deleted. If an AsOf is not provided, the default value is the current time.

    
    
• On success, responds with ListInvoiceUnitsOutput with field(s):
  • invoice_units(Option<Vec::<InvoiceUnit>>):

    An invoice unit is a set of mutually exclusive accounts that correspond to your business entity.

  • next_token(Option<String>):

    The next token used to indicate where the returned list should start from.

• On failure, responds with SdkError<ListInvoiceUnitsError>

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 tags to list.

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

    Adds a tag to a 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 tags.

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

    Adds a tag to a 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) to untag.

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

    Keys for the tags to be removed.

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

impl Client

pub fn update_invoice_unit(&self) -> UpdateInvoiceUnitFluentBuilder

Constructs a fluent builder for the UpdateInvoiceUnit operation.

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

    The ARN to identify an invoice unit. This information can’t be modified or deleted.

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

    The assigned description for an invoice unit. This information can’t be modified or deleted.

    
    
  • tax_inheritance_disabled(bool) / set_tax_inheritance_disabled(Option<bool>):
    required: false
    

    Whether the invoice unit based tax inheritance is/ should be enabled or disabled.

    
    
  • rule(InvoiceUnitRule) / set_rule(Option<InvoiceUnitRule>):
    required: false
    

    The InvoiceUnitRule object used to update invoice units.

    
    
• On success, responds with UpdateInvoiceUnitOutput with field(s):
  • invoice_unit_arn(Option<String>):

    The ARN to identify an invoice unit. This information can’t be modified or deleted.

• On failure, responds with SdkError<UpdateInvoiceUnitError>

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.