Struct Client

pub struct Client { /* private fields */ }

Client for AWS Mobile

Client for invoking operations on AWS Mobile. Each operation on AWS Mobile 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_mobile::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_mobile::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 CreateProject operation has a Client::create_project, 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_project()
    .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_project(&self) -> CreateProjectFluentBuilder

Constructs a fluent builder for the CreateProject operation.

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

    Name of the project.

    
    
  • region(impl Into<String>) / set_region(Option<String>):
    required: false
    

    Default region where project resources should be created.

    
    
  • contents(Blob) / set_contents(Option<Blob>):
    required: false
    

    ZIP or YAML file which contains configuration settings to be used when creating the project. This may be the contents of the file downloaded from the URL provided in an export project operation.

    
    
  • snapshot_id(impl Into<String>) / set_snapshot_id(Option<String>):
    required: false
    

    Unique identifier for an exported snapshot of project configuration. This snapshot identifier is included in the share URL when a project is exported.

    
    
• On success, responds with CreateProjectOutput with field(s):
  • details(Option<ProjectDetails>):

    Detailed information about the created AWS Mobile Hub project.

• On failure, responds with SdkError<CreateProjectError>

impl Client

pub fn delete_project(&self) -> DeleteProjectFluentBuilder

Constructs a fluent builder for the DeleteProject operation.

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

    Unique project identifier.

    
    
• On success, responds with DeleteProjectOutput with field(s):
  • deleted_resources(Option<Vec::<Resource>>):

    Resources which were deleted.

  • orphaned_resources(Option<Vec::<Resource>>):

    Resources which were not deleted, due to a risk of losing potentially important data or files.

• On failure, responds with SdkError<DeleteProjectError>

impl Client

pub fn describe_bundle(&self) -> DescribeBundleFluentBuilder

Constructs a fluent builder for the DescribeBundle operation.

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

    Unique bundle identifier.

    
    
• On success, responds with DescribeBundleOutput with field(s):
  • details(Option<BundleDetails>):

    The details of the bundle.

• On failure, responds with SdkError<DescribeBundleError>

impl Client

pub fn describe_project(&self) -> DescribeProjectFluentBuilder

Constructs a fluent builder for the DescribeProject operation.

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

    Unique project identifier.

    
    
  • sync_from_resources(bool) / set_sync_from_resources(Option<bool>):
    required: false
    

    If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub project.

    
    
• On success, responds with DescribeProjectOutput with field(s):
  • details(Option<ProjectDetails>):

    Detailed information about an AWS Mobile Hub project.

• On failure, responds with SdkError<DescribeProjectError>

impl Client

pub fn export_bundle(&self) -> ExportBundleFluentBuilder

Constructs a fluent builder for the ExportBundle operation.

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

    Unique bundle identifier.

    
    
  • project_id(impl Into<String>) / set_project_id(Option<String>):
    required: false
    

    Unique project identifier.

    
    
  • platform(Platform) / set_platform(Option<Platform>):
    required: false
    

    Developer desktop or target application platform.

    
    
• On success, responds with ExportBundleOutput with field(s):
  • download_url(Option<String>):

    URL which contains the custom-generated SDK and tool packages used to integrate the client mobile app or web app with the AWS resources created by the AWS Mobile Hub project.

• On failure, responds with SdkError<ExportBundleError>

impl Client

pub fn export_project(&self) -> ExportProjectFluentBuilder

Constructs a fluent builder for the ExportProject operation.

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

    Unique project identifier.

    
    
• On success, responds with ExportProjectOutput with field(s):
  • download_url(Option<String>):

    URL which can be used to download the exported project configuation file(s).

  • share_url(Option<String>):

    URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again.

  • snapshot_id(Option<String>):

    Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL.

• On failure, responds with SdkError<ExportProjectError>

impl Client

pub fn list_bundles(&self) -> ListBundlesFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of records to list in a single response.

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

    Pagination token. Set to null to start listing bundles from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more bundles.

    
    
• On success, responds with ListBundlesOutput with field(s):
  • bundle_list(Option<Vec::<BundleDetails>>):

    A list of bundles.

  • next_token(Option<String>):

    Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

• On failure, responds with SdkError<ListBundlesError>

impl Client

pub fn list_projects(&self) -> ListProjectsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of records to list in a single response.

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

    Pagination token. Set to null to start listing projects from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more projects.

    
    
• On success, responds with ListProjectsOutput with field(s):
  • projects(Option<Vec::<ProjectSummary>>):

    List of projects.

  • next_token(Option<String>):

    Pagination token. Set to null to start listing records from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more entries.

• On failure, responds with SdkError<ListProjectsError>

impl Client

pub fn update_project(&self) -> UpdateProjectFluentBuilder

Constructs a fluent builder for the UpdateProject operation.

• The fluent builder is configurable:
  • contents(Blob) / set_contents(Option<Blob>):
    required: false
    

    ZIP or YAML file which contains project configuration to be updated. This should be the contents of the file downloaded from the URL provided in an export project operation.

    
    
  • project_id(impl Into<String>) / set_project_id(Option<String>):
    required: true
    

    Unique project identifier.

    
    
• On success, responds with UpdateProjectOutput with field(s):
  • details(Option<ProjectDetails>):

    Detailed information about the updated AWS Mobile Hub project.

• On failure, responds with SdkError<UpdateProjectError>

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.