Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Free Tier

Client for invoking operations on AWS Free Tier. Each operation on AWS Free Tier 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_freetier::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_freetier::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 GetAccountActivity operation has a Client::get_account_activity, 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.get_account_activity()
    .activity_id("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 get_account_activity(&self) -> GetAccountActivityFluentBuilder

Constructs a fluent builder for the GetAccountActivity operation.

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

    A unique identifier that identifies the activity.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: false
    

    The language code used to return translated title and description fields.

    
    
• On success, responds with GetAccountActivityOutput with field(s):
  • activity_id(String):

    A unique identifier that identifies the activity.

  • title(String):

    A short activity title.

  • description(String):

    Provides detailed information about the activity and its expected outcomes.

  • status(ActivityStatus):

    The current activity status.

  • instructions_url(String):

    The URL resource that provides guidance on activity requirements and completion.

  • reward(Option<ActivityReward>):

    A reward granted upon activity completion.

  • estimated_time_to_complete_in_minutes(Option<i32>):

    The estimated time to complete the activity. This is the duration in minutes.

  • expires_at(Option<DateTime>):

    The time by which the activity must be completed to receive a reward.

  • started_at(Option<DateTime>):

    The timestamp when the activity started. This field appears only for activities in the IN_PROGRESS or COMPLETED states.

  • completed_at(Option<DateTime>):

    The timestamp when the activity is completed. This field appears only for activities in the COMPLETED state.

• On failure, responds with SdkError<GetAccountActivityError>

impl Client

pub fn get_account_plan_state(&self) -> GetAccountPlanStateFluentBuilder

Constructs a fluent builder for the GetAccountPlanState operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAccountPlanStateOutput with field(s):
  • account_id(String):

    A unique identifier that identifies the account.

  • account_plan_type(AccountPlanType):

    The plan type for the account.

  • account_plan_status(AccountPlanStatus):

    The current status for the account plan.

  • account_plan_remaining_credits(Option<MonetaryAmount>):

    The amount of credits remaining for the account.

  • account_plan_expiration_date(Option<DateTime>):

    The timestamp for when the current account plan expires.

• On failure, responds with SdkError<GetAccountPlanStateError>

impl Client

pub fn get_free_tier_usage(&self) -> GetFreeTierUsageFluentBuilder

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

• The fluent builder is configurable:
  • filter(Expression) / set_filter(Option<Expression>):
    required: false
    

    An expression that specifies the conditions that you want each FreeTierUsage object to meet.

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

    The maximum number of results to return in the response. MaxResults means that there can be up to the specified number of values, but there might be fewer results based on your filters.

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

    The pagination token that indicates the next set of results to retrieve.

    
    
• On success, responds with GetFreeTierUsageOutput with field(s):
  • free_tier_usages(Vec::<FreeTierUsage>):

    The list of Free Tier usage objects that meet your filter expression.

  • next_token(Option<String>):

    The pagination token that indicates the next set of results to retrieve.

• On failure, responds with SdkError<GetFreeTierUsageError>

impl Client

pub fn list_account_activities(&self) -> ListAccountActivitiesFluentBuilder

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

• The fluent builder is configurable:
  • filter_activity_statuses(ActivityStatus) / set_filter_activity_statuses(Option<Vec::<ActivityStatus>>):
    required: false
    

    The activity status filter. This field can be used to filter the response by activities status.

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

    A token from a previous paginated response. If this is specified, the response includes records beginning from this token (inclusive), up to the number specified by maxResults.

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

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: false
    

    The language code used to return translated titles.

    
    
• On success, responds with ListAccountActivitiesOutput with field(s):
  • activities(Vec::<ActivitySummary>):

    A brief information about the activities.

  • next_token(Option<String>):

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

• On failure, responds with SdkError<ListAccountActivitiesError>

impl Client

pub fn upgrade_account_plan(&self) -> UpgradeAccountPlanFluentBuilder

Constructs a fluent builder for the UpgradeAccountPlan operation.

• The fluent builder is configurable:
  • account_plan_type(AccountPlanType) / set_account_plan_type(Option<AccountPlanType>):
    required: true
    

    The target account plan type. This makes it explicit about the change and latest value of the accountPlanType.

    
    
• On success, responds with UpgradeAccountPlanOutput with field(s):
  • account_id(String):

    A unique identifier that identifies the account.

  • account_plan_type(AccountPlanType):

    The type of plan for the account.

  • account_plan_status(AccountPlanStatus):

    This indicates the latest state of the account plan within its lifecycle.

• On failure, responds with SdkError<UpgradeAccountPlanError>

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.