Class: AWS.Mobile

Inherits:
AWS.Service show all
Identifier:
mobile
API Version:
2017-07-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using Mobile

var mobile = new AWS.Mobile();
mobile.createProject(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Mobile object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var mobile = new AWS.Mobile({apiVersion: '2017-07-01'});

You can also set the API version globally in AWS.config.apiVersions using the mobile service identifier:

AWS.config.apiVersions = {
  mobile: '2017-07-01',
  // other service API versions
};

var mobile = new AWS.Mobile();

Version:

  • 2017-07-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Mobile(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Mobile object

var mobile = new AWS.Mobile({apiVersion: '2017-07-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Mobile.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Mobile.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Mobile.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createProject(params = {}, callback) ⇒ AWS.Request

Creates an AWS Mobile Hub project.

Service Reference:

Examples:

Calling the createProject operation

var params = {
  contents: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  name: 'STRING_VALUE',
  region: 'STRING_VALUE',
  snapshotId: 'STRING_VALUE'
};
mobile.createProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      Name of the project.

    • region — (String)

      Default region where project resources should be created.

    • contents — (Buffer, Typed Array, Blob, String)

      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.

    • snapshotId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • details — (map)

        Detailed information about the created AWS Mobile Hub project.

        • name — (String)

          Name of the project.

        • projectId — (String)

          Unique project identifier.

        • region — (String)

          Default region to use for AWS resource creation in the AWS Mobile Hub project.

        • state — (String)

          Synchronization state for a project.

          Possible values include:
          • "NORMAL"
          • "SYNCING"
          • "IMPORTING"
        • createdDate — (Date)

          Date the project was created.

        • lastUpdatedDate — (Date)

          Date of the last modification of the project.

        • consoleUrl — (String)

          Website URL for this project in the AWS Mobile Hub console.

        • resources — (Array<map>)

          List of AWS resources associated with a project.

          • type — (String)

            Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).

          • name — (String)

            Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).

          • arn — (String)

            AWS resource name which uniquely identifies the resource in AWS systems.

          • feature — (String)

            Identifies which feature in AWS Mobile Hub is associated with this AWS resource.

          • attributes — (map<String>)

            Key-value attribute pairs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteProject(params = {}, callback) ⇒ AWS.Request

Delets a project in AWS Mobile Hub.

Service Reference:

Examples:

Calling the deleteProject operation

var params = {
  projectId: 'STRING_VALUE' /* required */
};
mobile.deleteProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • projectId — (String)

      Unique project identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • deletedResources — (Array<map>)

        Resources which were deleted.

        • type — (String)

          Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).

        • name — (String)

          Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).

        • arn — (String)

          AWS resource name which uniquely identifies the resource in AWS systems.

        • feature — (String)

          Identifies which feature in AWS Mobile Hub is associated with this AWS resource.

        • attributes — (map<String>)

          Key-value attribute pairs.

      • orphanedResources — (Array<map>)

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

        • type — (String)

          Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).

        • name — (String)

          Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).

        • arn — (String)

          AWS resource name which uniquely identifies the resource in AWS systems.

        • feature — (String)

          Identifies which feature in AWS Mobile Hub is associated with this AWS resource.

        • attributes — (map<String>)

          Key-value attribute pairs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeBundle(params = {}, callback) ⇒ AWS.Request

Get the bundle details for the requested bundle id.

Service Reference:

Examples:

Calling the describeBundle operation

var params = {
  bundleId: 'STRING_VALUE' /* required */
};
mobile.describeBundle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • bundleId — (String)

      Unique bundle identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • details — (map)

        The details of the bundle.

        • bundleId — (String)

          Unique bundle identifier.

        • title — (String)

          Title of the download bundle.

        • version — (String)

          Version of the download bundle.

        • description — (String)

          Description of the download bundle.

        • iconUrl — (String)

          Icon for the download bundle.

        • availablePlatforms — (Array<String>)

          Developer desktop or mobile app or website platforms.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeProject(params = {}, callback) ⇒ AWS.Request

Gets details about a project in AWS Mobile Hub.

Service Reference:

Examples:

Calling the describeProject operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  syncFromResources: true || false
};
mobile.describeProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • projectId — (String)

      Unique project identifier.

    • syncFromResources — (Boolean)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • details — (map)

        Detailed information about an AWS Mobile Hub project.

        • name — (String)

          Name of the project.

        • projectId — (String)

          Unique project identifier.

        • region — (String)

          Default region to use for AWS resource creation in the AWS Mobile Hub project.

        • state — (String)

          Synchronization state for a project.

          Possible values include:
          • "NORMAL"
          • "SYNCING"
          • "IMPORTING"
        • createdDate — (Date)

          Date the project was created.

        • lastUpdatedDate — (Date)

          Date of the last modification of the project.

        • consoleUrl — (String)

          Website URL for this project in the AWS Mobile Hub console.

        • resources — (Array<map>)

          List of AWS resources associated with a project.

          • type — (String)

            Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).

          • name — (String)

            Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).

          • arn — (String)

            AWS resource name which uniquely identifies the resource in AWS systems.

          • feature — (String)

            Identifies which feature in AWS Mobile Hub is associated with this AWS resource.

          • attributes — (map<String>)

            Key-value attribute pairs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

exportBundle(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the exportBundle operation

var params = {
  bundleId: 'STRING_VALUE', /* required */
  platform: OSX | WINDOWS | LINUX | OBJC | SWIFT | ANDROID | JAVASCRIPT,
  projectId: 'STRING_VALUE'
};
mobile.exportBundle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • bundleId — (String)

      Unique bundle identifier.

    • projectId — (String)

      Unique project identifier.

    • platform — (String)

      Developer desktop or target application platform.

      Possible values include:
      • "OSX"
      • "WINDOWS"
      • "LINUX"
      • "OBJC"
      • "SWIFT"
      • "ANDROID"
      • "JAVASCRIPT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • downloadUrl — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

exportProject(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the exportProject operation

var params = {
  projectId: 'STRING_VALUE' /* required */
};
mobile.exportProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • projectId — (String)

      Unique project identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • downloadUrl — (String)

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

      • shareUrl — (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.

      • snapshotId — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBundles(params = {}, callback) ⇒ AWS.Request

List all available bundles.

Service Reference:

Examples:

Calling the listBundles operation

var params = {
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
mobile.listBundles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      Maximum number of records to list in a single response.

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • bundleList — (Array<map>)

        A list of bundles.

        • bundleId — (String)

          Unique bundle identifier.

        • title — (String)

          Title of the download bundle.

        • version — (String)

          Version of the download bundle.

        • description — (String)

          Description of the download bundle.

        • iconUrl — (String)

          Icon for the download bundle.

        • availablePlatforms — (Array<String>)

          Developer desktop or mobile app or website platforms.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listProjects(params = {}, callback) ⇒ AWS.Request

Lists projects in AWS Mobile Hub.

Service Reference:

Examples:

Calling the listProjects operation

var params = {
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
mobile.listProjects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      Maximum number of records to list in a single response.

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • projects — (Array<map>)

        List of projects.

        • name — (String)

          Name of the project.

        • projectId — (String)

          Unique project identifier.

      • nextToken — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateProject(params = {}, callback) ⇒ AWS.Request

Update an existing project.

Service Reference:

Examples:

Calling the updateProject operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  contents: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
};
mobile.updateProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • contents — (Buffer, Typed Array, Blob, String)

      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.

    • projectId — (String)

      Unique project identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • details — (map)

        Detailed information about the updated AWS Mobile Hub project.

        • name — (String)

          Name of the project.

        • projectId — (String)

          Unique project identifier.

        • region — (String)

          Default region to use for AWS resource creation in the AWS Mobile Hub project.

        • state — (String)

          Synchronization state for a project.

          Possible values include:
          • "NORMAL"
          • "SYNCING"
          • "IMPORTING"
        • createdDate — (Date)

          Date the project was created.

        • lastUpdatedDate — (Date)

          Date of the last modification of the project.

        • consoleUrl — (String)

          Website URL for this project in the AWS Mobile Hub console.

        • resources — (Array<map>)

          List of AWS resources associated with a project.

          • type — (String)

            Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).

          • name — (String)

            Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).

          • arn — (String)

            AWS resource name which uniquely identifies the resource in AWS systems.

          • feature — (String)

            Identifies which feature in AWS Mobile Hub is associated with this AWS resource.

          • attributes — (map<String>)

            Key-value attribute pairs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.