AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing Mobile AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Mobile.AmazonMobileClient

Namespace: Amazon.Mobile
Assembly: AWSSDK.Mobile.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonMobileClient : AmazonServiceClient
         IAmazonMobile, IAmazonService, IDisposable

The AmazonMobileClient type exposes the following members

Constructors

NameDescription
Public Method AmazonMobileClient()

Constructs AmazonMobileClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMobileClient(RegionEndpoint)

Constructs AmazonMobileClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMobileClient(AmazonMobileConfig)

Constructs AmazonMobileClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMobileClient(AWSCredentials)

Constructs AmazonMobileClient with AWS Credentials

Public Method AmazonMobileClient(AWSCredentials, RegionEndpoint)

Constructs AmazonMobileClient with AWS Credentials

Public Method AmazonMobileClient(AWSCredentials, AmazonMobileConfig)

Constructs AmazonMobileClient with AWS Credentials and an AmazonMobileClient Configuration object.

Public Method AmazonMobileClient(string, string)

Constructs AmazonMobileClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMobileClient(string, string, RegionEndpoint)

Constructs AmazonMobileClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMobileClient(string, string, AmazonMobileConfig)

Constructs AmazonMobileClient with AWS Access Key ID, AWS Secret Key and an AmazonMobileClient Configuration object.

Public Method AmazonMobileClient(string, string, string)

Constructs AmazonMobileClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMobileClient(string, string, string, RegionEndpoint)

Constructs AmazonMobileClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMobileClient(string, string, string, AmazonMobileConfig)

Constructs AmazonMobileClient with AWS Access Key ID, AWS Secret Key and an AmazonMobileClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateProject(CreateProjectRequest)

Creates an AWS Mobile Hub project.

Public Method CreateProjectAsync(CreateProjectRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProject operation.

Public Method DeleteProject(DeleteProjectRequest)

Delets a project in AWS Mobile Hub.

Public Method DeleteProjectAsync(DeleteProjectRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProject operation.

Public Method DescribeBundle(DescribeBundleRequest)

Get the bundle details for the requested bundle id.

Public Method DescribeBundleAsync(DescribeBundleRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeBundle operation.

Public Method DescribeProject(DescribeProjectRequest)

Gets details about a project in AWS Mobile Hub.

Public Method DescribeProjectAsync(DescribeProjectRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProject operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ExportBundle(ExportBundleRequest)

Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.

Public Method ExportBundleAsync(ExportBundleRequest, CancellationToken)

Initiates the asynchronous execution of the ExportBundle operation.

Public Method ExportProject(ExportProjectRequest)

Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account.

Public Method ExportProjectAsync(ExportProjectRequest, CancellationToken)

Initiates the asynchronous execution of the ExportProject operation.

Public Method ListBundles(ListBundlesRequest)

List all available bundles.

Public Method ListBundlesAsync(ListBundlesRequest, CancellationToken)

Initiates the asynchronous execution of the ListBundles operation.

Public Method ListProjects(ListProjectsRequest)

Lists projects in AWS Mobile Hub.

Public Method ListProjectsAsync(ListProjectsRequest, CancellationToken)

Initiates the asynchronous execution of the ListProjects operation.

Public Method UpdateProject(UpdateProjectRequest)

Update an existing project.

Public Method UpdateProjectAsync(UpdateProjectRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateProject operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms