Struct aws_sdk_mobile::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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_mobile::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_mobile::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_mobile::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn create_project(&self) -> CreateProject

Constructs a fluent builder for the CreateProject operation.

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

    Name of the project.

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

    Default region where project resources should be created.

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

    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>):

    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>

pub fn delete_project(&self) -> DeleteProject

Constructs a fluent builder for the DeleteProject operation.

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

    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>

pub fn describe_bundle(&self) -> DescribeBundle

Constructs a fluent builder for the DescribeBundle operation.

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

    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>

pub fn describe_project(&self) -> DescribeProject

Constructs a fluent builder for the DescribeProject operation.

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

    Unique project identifier.

  • sync_from_resources(bool) / set_sync_from_resources(bool):

    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>

pub fn export_bundle(&self) -> ExportBundle

Constructs a fluent builder for the ExportBundle operation.

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

    Unique bundle identifier.

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

    Unique project identifier.

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

    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>

pub fn export_project(&self) -> ExportProject

Constructs a fluent builder for the ExportProject operation.

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

    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>

pub fn list_bundles(&self) -> ListBundles

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(i32):

    Maximum number of records to list in a single response.

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

    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>

pub fn list_projects(&self) -> ListProjects

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(i32):

    Maximum number of records to list in a single response.

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

    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>

pub fn update_project(&self) -> UpdateProject

Constructs a fluent builder for the UpdateProject operation.

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

    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>):

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

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

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.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.