Class: AWS.Amplify

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

Overview

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

Service Description

Amplify is a fully managed continuous deployment and hosting service for modern web apps.

Sending a Request Using Amplify

var amplify = new AWS.Amplify();
amplify.createApp(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 Amplify object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var amplify = new AWS.Amplify({apiVersion: '2017-07-25'});

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

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

var amplify = new AWS.Amplify();

Version:

  • 2017-07-25

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.Amplify(options = {}) ⇒ Object

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

Examples:

Constructing a Amplify object

var amplify = new AWS.Amplify({apiVersion: '2017-07-25'});

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.Amplify.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Amplify.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.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to 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

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

Creates a new Amplify App.

Service Reference:

Examples:

Calling the createApp operation

var params = {
  name: 'STRING_VALUE', /* required */
  oauthToken: 'STRING_VALUE', /* required */
  platform: IOS | ANDROID | WEB | REACT_NATIVE, /* required */
  repository: 'STRING_VALUE', /* required */
  basicAuthCredentials: 'STRING_VALUE',
  buildSpec: 'STRING_VALUE',
  customRules: [
    {
      source: 'STRING_VALUE', /* required */
      target: 'STRING_VALUE', /* required */
      condition: 'STRING_VALUE',
      status: 'STRING_VALUE'
    },
    /* more items */
  ],
  description: 'STRING_VALUE',
  enableBasicAuth: true || false,
  enableBranchAutoBuild: true || false,
  environmentVariables: {
    '<EnvKey>': 'STRING_VALUE',
    /* '<EnvKey>': ... */
  },
  iamServiceRoleArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
amplify.createApp(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 for the Amplify App

    • description — (String)

      Description for an Amplify App

    • repository — (String)

      Repository for an Amplify App

    • platform — (String)

      Platform / framework for an Amplify App

      Possible values include:
      • "IOS"
      • "ANDROID"
      • "WEB"
      • "REACT_NATIVE"
    • iamServiceRoleArn — (String)

      AWS IAM service role for an Amplify App

    • oauthToken — (String)

      OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.

    • environmentVariables — (map<String>)

      Environment variables map for an Amplify App.

    • enableBranchAutoBuild — (Boolean)

      Enable the auto building of branches for an Amplify App.

    • enableBasicAuth — (Boolean)

      Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.

    • basicAuthCredentials — (String)

      Credentials for Basic Authorization for an Amplify App.

    • customRules — (Array<map>)

      Custom rewrite / redirect rules for an Amplify App.

      • sourcerequired — (String)

        The source pattern for a URL rewrite or redirect rule.

      • targetrequired — (String)

        The target pattern for a URL rewrite or redirect rule.

      • status — (String)

        The status code for a URL rewrite or redirect rule.

      • condition — (String)

        The condition for a URL rewrite or redirect rule, e.g. country code.

    • tags — (map<String>)

      Tag for an Amplify App

    • buildSpec — (String)

      BuildSpec for an Amplify App

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:

      • app — (map)

        Amplify App represents different branches of a repository for building, deploying, and hosting.

        • appIdrequired — (String)

          Unique Id for the Amplify App.

        • appArnrequired — (String)

          ARN for the Amplify App.

        • namerequired — (String)

          Name for the Amplify App.

        • tags — (map<String>)

          Tag for Amplify App.

        • descriptionrequired — (String)

          Description for the Amplify App.

        • repositoryrequired — (String)

          Repository for the Amplify App.

        • platformrequired — (String)

          Platform for the Amplify App.

          Possible values include:
          • "IOS"
          • "ANDROID"
          • "WEB"
          • "REACT_NATIVE"
        • createTimerequired — (Date)

          Create date / time for the Amplify App.

        • updateTimerequired — (Date)

          Update date / time for the Amplify App.

        • iamServiceRoleArn — (String)

          IAM service role ARN for the Amplify App.

        • environmentVariablesrequired — (map<String>)

          Environment Variables for the Amplify App.

        • defaultDomainrequired — (String)

          Default domain for the Amplify App.

        • enableBranchAutoBuildrequired — (Boolean)

          Enables auto-building of branches for the Amplify App.

        • enableBasicAuthrequired — (Boolean)

          Enables Basic Authorization for branches for the Amplify App.

        • basicAuthCredentials — (String)

          Basic Authorization credentials for branches for the Amplify App.

        • customRules — (Array<map>)

          Custom redirect / rewrite rules for the Amplify App.

          • sourcerequired — (String)

            The source pattern for a URL rewrite or redirect rule.

          • targetrequired — (String)

            The target pattern for a URL rewrite or redirect rule.

          • status — (String)

            The status code for a URL rewrite or redirect rule.

          • condition — (String)

            The condition for a URL rewrite or redirect rule, e.g. country code.

        • productionBranch — (map)

          Structure with Production Branch information.

          • lastDeployTime — (Date)

            Last Deploy Time of Production Branch.

          • status — (String)

            Status of Production Branch.

          • thumbnailUrl — (String)

            Thumbnail Url for Production Branch.

          • branchName — (String)

            Branch Name for Production Branch.

        • buildSpec — (String)

          BuildSpec content for Amplify App.

Returns:

  • (AWS.Request)

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

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

Creates a new Branch for an Amplify App.

Service Reference:

Examples:

Calling the createBranch operation

var params = {
  appId: 'STRING_VALUE', /* required */
  branchName: 'STRING_VALUE', /* required */
  basicAuthCredentials: 'STRING_VALUE',
  buildSpec: 'STRING_VALUE',
  description: 'STRING_VALUE',
  enableAutoBuild: true || false,
  enableBasicAuth: true || false,
  enableNotification: true || false,
  environmentVariables: {
    '<EnvKey>': 'STRING_VALUE',
    /* '<EnvKey>': ... */
  },
  framework: 'STRING_VALUE',
  stage: PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  ttl: 'STRING_VALUE'
};
amplify.createBranch(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • branchName — (String)

      Name for the branch.

    • description — (String)

      Description for the branch.

    • stage — (String)

      Stage for the branch.

      Possible values include:
      • "PRODUCTION"
      • "BETA"
      • "DEVELOPMENT"
      • "EXPERIMENTAL"
    • framework — (String)

      Framework for the branch.

    • enableNotification — (Boolean)

      Enables notifications for the branch.

    • enableAutoBuild — (Boolean)

      Enables auto building for the branch.

    • environmentVariables — (map<String>)

      Environment Variables for the branch.

    • basicAuthCredentials — (String)

      Basic Authorization credentials for the branch.

    • enableBasicAuth — (Boolean)

      Enables Basic Auth for the branch.

    • tags — (map<String>)

      Tag for the branch.

    • buildSpec — (String)

      BuildSpec for the branch.

    • ttl — (String)

      The content TTL for the website in seconds.

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:

      • branch — (map)

        Branch structure for an Amplify App.

        • branchArnrequired — (String)

          ARN for a branch, part of an Amplify App.

        • branchNamerequired — (String)

          Name for a branch, part of an Amplify App.

        • descriptionrequired — (String)

          Description for a branch, part of an Amplify App.

        • tags — (map<String>)

          Tag for branch for Amplify App.

        • stagerequired — (String)

          Stage for a branch, part of an Amplify App.

          Possible values include:
          • "PRODUCTION"
          • "BETA"
          • "DEVELOPMENT"
          • "EXPERIMENTAL"
        • displayName — (String)

          Display name for a branch, part of an Amplify App.

        • enableNotificationrequired — (Boolean)

          Enables notifications for a branch, part of an Amplify App.

        • createTimerequired — (Date)

          Creation date and time for a branch, part of an Amplify App.

        • updateTimerequired — (Date)

          Last updated date and time for a branch, part of an Amplify App.

        • environmentVariablesrequired — (map<String>)

          Environment Variables specific to a branch, part of an Amplify App.

        • enableAutoBuildrequired — (Boolean)

          Enables auto-building on push for a branch, part of an Amplify App.

        • customDomainsrequired — (Array<String>)

          Custom domains for a branch, part of an Amplify App.

        • frameworkrequired — (String)

          Framework for a branch, part of an Amplify App.

        • activeJobIdrequired — (String)

          Id of the active job for a branch, part of an Amplify App.

        • totalNumberOfJobsrequired — (String)

          Total number of Jobs part of an Amplify App.

        • enableBasicAuthrequired — (Boolean)

          Enables Basic Authorization for a branch, part of an Amplify App.

        • thumbnailUrl — (String)

          Thumbnail Url for the branch.

        • basicAuthCredentials — (String)

          Basic Authorization credentials for a branch, part of an Amplify App.

        • buildSpec — (String)

          BuildSpec content for branch for Amplify App.

        • ttlrequired — (String)

          The content TTL for the website in seconds.

Returns:

  • (AWS.Request)

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

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

Create a new DomainAssociation on an App

Service Reference:

Examples:

Calling the createDomainAssociation operation

var params = {
  appId: 'STRING_VALUE', /* required */
  domainName: 'STRING_VALUE', /* required */
  subDomainSettings: [ /* required */
    {
      branchName: 'STRING_VALUE', /* required */
      prefix: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  enableAutoSubDomain: true || false
};
amplify.createDomainAssociation(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • domainName — (String)

      Domain name for the Domain Association.

    • enableAutoSubDomain — (Boolean)

      Enables automated creation of Subdomains for branches.

    • subDomainSettings — (Array<map>)

      Setting structure for the Subdomain.

      • prefixrequired — (String)

        Prefix setting for the Subdomain.

      • branchNamerequired — (String)

        Branch name setting for the Subdomain.

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:

      • domainAssociation — (map)

        Domain Association structure.

        • domainAssociationArnrequired — (String)

          ARN for the Domain Association.

        • domainNamerequired — (String)

          Name of the domain.

        • enableAutoSubDomainrequired — (Boolean)

          Enables automated creation of Subdomains for branches.

        • domainStatusrequired — (String)

          Status fo the Domain Association.

          Possible values include:
          • "PENDING_VERIFICATION"
          • "IN_PROGRESS"
          • "AVAILABLE"
          • "PENDING_DEPLOYMENT"
          • "FAILED"
        • statusReasonrequired — (String)

          Reason for the current status of the Domain Association.

        • certificateVerificationDNSRecordrequired — (String)

          DNS Record for certificate verification.

        • subDomainsrequired — (Array<map>)

          Subdomains for the Domain Association.

          • subDomainSettingrequired — (map)

            Setting structure for the Subdomain.

            • prefixrequired — (String)

              Prefix setting for the Subdomain.

            • branchNamerequired — (String)

              Branch name setting for the Subdomain.

          • verifiedrequired — (Boolean)

            Verified status of the Subdomain

          • dnsRecordrequired — (String)

            DNS record for the Subdomain.

Returns:

  • (AWS.Request)

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

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

Delete an existing Amplify App by appId.

Service Reference:

Examples:

Calling the deleteApp operation

var params = {
  appId: 'STRING_VALUE' /* required */
};
amplify.deleteApp(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

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:

      • app — (map)

        Amplify App represents different branches of a repository for building, deploying, and hosting.

        • appIdrequired — (String)

          Unique Id for the Amplify App.

        • appArnrequired — (String)

          ARN for the Amplify App.

        • namerequired — (String)

          Name for the Amplify App.

        • tags — (map<String>)

          Tag for Amplify App.

        • descriptionrequired — (String)

          Description for the Amplify App.

        • repositoryrequired — (String)

          Repository for the Amplify App.

        • platformrequired — (String)

          Platform for the Amplify App.

          Possible values include:
          • "IOS"
          • "ANDROID"
          • "WEB"
          • "REACT_NATIVE"
        • createTimerequired — (Date)

          Create date / time for the Amplify App.

        • updateTimerequired — (Date)

          Update date / time for the Amplify App.

        • iamServiceRoleArn — (String)

          IAM service role ARN for the Amplify App.

        • environmentVariablesrequired — (map<String>)

          Environment Variables for the Amplify App.

        • defaultDomainrequired — (String)

          Default domain for the Amplify App.

        • enableBranchAutoBuildrequired — (Boolean)

          Enables auto-building of branches for the Amplify App.

        • enableBasicAuthrequired — (Boolean)

          Enables Basic Authorization for branches for the Amplify App.

        • basicAuthCredentials — (String)

          Basic Authorization credentials for branches for the Amplify App.

        • customRules — (Array<map>)

          Custom redirect / rewrite rules for the Amplify App.

          • sourcerequired — (String)

            The source pattern for a URL rewrite or redirect rule.

          • targetrequired — (String)

            The target pattern for a URL rewrite or redirect rule.

          • status — (String)

            The status code for a URL rewrite or redirect rule.

          • condition — (String)

            The condition for a URL rewrite or redirect rule, e.g. country code.

        • productionBranch — (map)

          Structure with Production Branch information.

          • lastDeployTime — (Date)

            Last Deploy Time of Production Branch.

          • status — (String)

            Status of Production Branch.

          • thumbnailUrl — (String)

            Thumbnail Url for Production Branch.

          • branchName — (String)

            Branch Name for Production Branch.

        • buildSpec — (String)

          BuildSpec content for Amplify App.

Returns:

  • (AWS.Request)

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

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

Deletes a branch for an Amplify App.

Service Reference:

Examples:

Calling the deleteBranch operation

var params = {
  appId: 'STRING_VALUE', /* required */
  branchName: 'STRING_VALUE' /* required */
};
amplify.deleteBranch(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • branchName — (String)

      Name for the branch.

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:

      • branch — (map)

        Branch structure for an Amplify App.

        • branchArnrequired — (String)

          ARN for a branch, part of an Amplify App.

        • branchNamerequired — (String)

          Name for a branch, part of an Amplify App.

        • descriptionrequired — (String)

          Description for a branch, part of an Amplify App.

        • tags — (map<String>)

          Tag for branch for Amplify App.

        • stagerequired — (String)

          Stage for a branch, part of an Amplify App.

          Possible values include:
          • "PRODUCTION"
          • "BETA"
          • "DEVELOPMENT"
          • "EXPERIMENTAL"
        • displayName — (String)

          Display name for a branch, part of an Amplify App.

        • enableNotificationrequired — (Boolean)

          Enables notifications for a branch, part of an Amplify App.

        • createTimerequired — (Date)

          Creation date and time for a branch, part of an Amplify App.

        • updateTimerequired — (Date)

          Last updated date and time for a branch, part of an Amplify App.

        • environmentVariablesrequired — (map<String>)

          Environment Variables specific to a branch, part of an Amplify App.

        • enableAutoBuildrequired — (Boolean)

          Enables auto-building on push for a branch, part of an Amplify App.

        • customDomainsrequired — (Array<String>)

          Custom domains for a branch, part of an Amplify App.

        • frameworkrequired — (String)

          Framework for a branch, part of an Amplify App.

        • activeJobIdrequired — (String)

          Id of the active job for a branch, part of an Amplify App.

        • totalNumberOfJobsrequired — (String)

          Total number of Jobs part of an Amplify App.

        • enableBasicAuthrequired — (Boolean)

          Enables Basic Authorization for a branch, part of an Amplify App.

        • thumbnailUrl — (String)

          Thumbnail Url for the branch.

        • basicAuthCredentials — (String)

          Basic Authorization credentials for a branch, part of an Amplify App.

        • buildSpec — (String)

          BuildSpec content for branch for Amplify App.

        • ttlrequired — (String)

          The content TTL for the website in seconds.

Returns:

  • (AWS.Request)

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

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

Deletes a DomainAssociation.

Service Reference:

Examples:

Calling the deleteDomainAssociation operation

var params = {
  appId: 'STRING_VALUE', /* required */
  domainName: 'STRING_VALUE' /* required */
};
amplify.deleteDomainAssociation(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • domainName — (String)

      Name of the domain.

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:

      • domainAssociation — (map)

        Structure for Domain Association, which associates a custom domain with an Amplify App.

        • domainAssociationArnrequired — (String)

          ARN for the Domain Association.

        • domainNamerequired — (String)

          Name of the domain.

        • enableAutoSubDomainrequired — (Boolean)

          Enables automated creation of Subdomains for branches.

        • domainStatusrequired — (String)

          Status fo the Domain Association.

          Possible values include:
          • "PENDING_VERIFICATION"
          • "IN_PROGRESS"
          • "AVAILABLE"
          • "PENDING_DEPLOYMENT"
          • "FAILED"
        • statusReasonrequired — (String)

          Reason for the current status of the Domain Association.

        • certificateVerificationDNSRecordrequired — (String)

          DNS Record for certificate verification.

        • subDomainsrequired — (Array<map>)

          Subdomains for the Domain Association.

          • subDomainSettingrequired — (map)

            Setting structure for the Subdomain.

            • prefixrequired — (String)

              Prefix setting for the Subdomain.

            • branchNamerequired — (String)

              Branch name setting for the Subdomain.

          • verifiedrequired — (Boolean)

            Verified status of the Subdomain

          • dnsRecordrequired — (String)

            DNS record for the Subdomain.

Returns:

  • (AWS.Request)

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

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

Delete a job, for an Amplify branch, part of Amplify App.

Service Reference:

Examples:

Calling the deleteJob operation

var params = {
  appId: 'STRING_VALUE', /* required */
  branchName: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE' /* required */
};
amplify.deleteJob(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • branchName — (String)

      Name for the branch, for the Job.

    • jobId — (String)

      Unique Id for the Job.

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:

      • jobSummary — (map)

        Structure for the summary of a Job.

        • jobArnrequired — (String)

          Arn for the Job.

        • jobIdrequired — (String)

          Unique Id for the Job.

        • commitIdrequired — (String)

          Commit Id from 3rd party repository provider for the Job.

        • commitMessagerequired — (String)

          Commit message from 3rd party repository provider for the Job.

        • commitTimerequired — (Date)

          Commit date / time for the Job.

        • startTimerequired — (Date)

          Start date / time for the Job.

        • statusrequired — (String)

          Status for the Job.

          Possible values include:
          • "PENDING"
          • "PROVISIONING"
          • "RUNNING"
          • "FAILED"
          • "SUCCEED"
          • "CANCELLING"
          • "CANCELLED"
        • endTime — (Date)

          End date / time for the Job.

        • jobTyperequired — (String)

          Type for the Job.

          Possible values include:
          • "RELEASE"
          • "RETRY"
          • "WEB_HOOK"

Returns:

  • (AWS.Request)

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

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

Retrieves an existing Amplify App by appId.

Service Reference:

Examples:

Calling the getApp operation

var params = {
  appId: 'STRING_VALUE' /* required */
};
amplify.getApp(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

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:

      • app — (map)

        Amplify App represents different branches of a repository for building, deploying, and hosting.

        • appIdrequired — (String)

          Unique Id for the Amplify App.

        • appArnrequired — (String)

          ARN for the Amplify App.

        • namerequired — (String)

          Name for the Amplify App.

        • tags — (map<String>)

          Tag for Amplify App.

        • descriptionrequired — (String)

          Description for the Amplify App.

        • repositoryrequired — (String)

          Repository for the Amplify App.

        • platformrequired — (String)

          Platform for the Amplify App.

          Possible values include:
          • "IOS"
          • "ANDROID"
          • "WEB"
          • "REACT_NATIVE"
        • createTimerequired — (Date)

          Create date / time for the Amplify App.

        • updateTimerequired — (Date)

          Update date / time for the Amplify App.

        • iamServiceRoleArn — (String)

          IAM service role ARN for the Amplify App.

        • environmentVariablesrequired — (map<String>)

          Environment Variables for the Amplify App.

        • defaultDomainrequired — (String)

          Default domain for the Amplify App.

        • enableBranchAutoBuildrequired — (Boolean)

          Enables auto-building of branches for the Amplify App.

        • enableBasicAuthrequired — (Boolean)

          Enables Basic Authorization for branches for the Amplify App.

        • basicAuthCredentials — (String)

          Basic Authorization credentials for branches for the Amplify App.

        • customRules — (Array<map>)

          Custom redirect / rewrite rules for the Amplify App.

          • sourcerequired — (String)

            The source pattern for a URL rewrite or redirect rule.

          • targetrequired — (String)

            The target pattern for a URL rewrite or redirect rule.

          • status — (String)

            The status code for a URL rewrite or redirect rule.

          • condition — (String)

            The condition for a URL rewrite or redirect rule, e.g. country code.

        • productionBranch — (map)

          Structure with Production Branch information.

          • lastDeployTime — (Date)

            Last Deploy Time of Production Branch.

          • status — (String)

            Status of Production Branch.

          • thumbnailUrl — (String)

            Thumbnail Url for Production Branch.

          • branchName — (String)

            Branch Name for Production Branch.

        • buildSpec — (String)

          BuildSpec content for Amplify App.

Returns:

  • (AWS.Request)

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

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

Retrieves a branch for an Amplify App.

Service Reference:

Examples:

Calling the getBranch operation

var params = {
  appId: 'STRING_VALUE', /* required */
  branchName: 'STRING_VALUE' /* required */
};
amplify.getBranch(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • branchName — (String)

      Name for the branch.

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:

      • branch — (map)

        Branch for an Amplify App, which maps to a 3rd party repository branch.

        • branchArnrequired — (String)

          ARN for a branch, part of an Amplify App.

        • branchNamerequired — (String)

          Name for a branch, part of an Amplify App.

        • descriptionrequired — (String)

          Description for a branch, part of an Amplify App.

        • tags — (map<String>)

          Tag for branch for Amplify App.

        • stagerequired — (String)

          Stage for a branch, part of an Amplify App.

          Possible values include:
          • "PRODUCTION"
          • "BETA"
          • "DEVELOPMENT"
          • "EXPERIMENTAL"
        • displayName — (String)

          Display name for a branch, part of an Amplify App.

        • enableNotificationrequired — (Boolean)

          Enables notifications for a branch, part of an Amplify App.

        • createTimerequired — (Date)

          Creation date and time for a branch, part of an Amplify App.

        • updateTimerequired — (Date)

          Last updated date and time for a branch, part of an Amplify App.

        • environmentVariablesrequired — (map<String>)

          Environment Variables specific to a branch, part of an Amplify App.

        • enableAutoBuildrequired — (Boolean)

          Enables auto-building on push for a branch, part of an Amplify App.

        • customDomainsrequired — (Array<String>)

          Custom domains for a branch, part of an Amplify App.

        • frameworkrequired — (String)

          Framework for a branch, part of an Amplify App.

        • activeJobIdrequired — (String)

          Id of the active job for a branch, part of an Amplify App.

        • totalNumberOfJobsrequired — (String)

          Total number of Jobs part of an Amplify App.

        • enableBasicAuthrequired — (Boolean)

          Enables Basic Authorization for a branch, part of an Amplify App.

        • thumbnailUrl — (String)

          Thumbnail Url for the branch.

        • basicAuthCredentials — (String)

          Basic Authorization credentials for a branch, part of an Amplify App.

        • buildSpec — (String)

          BuildSpec content for branch for Amplify App.

        • ttlrequired — (String)

          The content TTL for the website in seconds.

Returns:

  • (AWS.Request)

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

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

Retrieves domain info that corresponds to an appId and domainName.

Service Reference:

Examples:

Calling the getDomainAssociation operation

var params = {
  appId: 'STRING_VALUE', /* required */
  domainName: 'STRING_VALUE' /* required */
};
amplify.getDomainAssociation(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • domainName — (String)

      Name of the domain.

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:

      • domainAssociation — (map)

        Domain Association structure.

        • domainAssociationArnrequired — (String)

          ARN for the Domain Association.

        • domainNamerequired — (String)

          Name of the domain.

        • enableAutoSubDomainrequired — (Boolean)

          Enables automated creation of Subdomains for branches.

        • domainStatusrequired — (String)

          Status fo the Domain Association.

          Possible values include:
          • "PENDING_VERIFICATION"
          • "IN_PROGRESS"
          • "AVAILABLE"
          • "PENDING_DEPLOYMENT"
          • "FAILED"
        • statusReasonrequired — (String)

          Reason for the current status of the Domain Association.

        • certificateVerificationDNSRecordrequired — (String)

          DNS Record for certificate verification.

        • subDomainsrequired — (Array<map>)

          Subdomains for the Domain Association.

          • subDomainSettingrequired — (map)

            Setting structure for the Subdomain.

            • prefixrequired — (String)

              Prefix setting for the Subdomain.

            • branchNamerequired — (String)

              Branch name setting for the Subdomain.

          • verifiedrequired — (Boolean)

            Verified status of the Subdomain

          • dnsRecordrequired — (String)

            DNS record for the Subdomain.

Returns:

  • (AWS.Request)

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

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

Get a job for a branch, part of an Amplify App.

Service Reference:

Examples:

Calling the getJob operation

var params = {
  appId: 'STRING_VALUE', /* required */
  branchName: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE' /* required */
};
amplify.getJob(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • branchName — (String)

      Name for the branch, for the Job.

    • jobId — (String)

      Unique Id for the Job.

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:

      • job — (map)

        Structure for an execution job for an Amplify App.

        • summaryrequired — (map)

          Summary for an execution job for an Amplify App.

          • jobArnrequired — (String)

            Arn for the Job.

          • jobIdrequired — (String)

            Unique Id for the Job.

          • commitIdrequired — (String)

            Commit Id from 3rd party repository provider for the Job.

          • commitMessagerequired — (String)

            Commit message from 3rd party repository provider for the Job.

          • commitTimerequired — (Date)

            Commit date / time for the Job.

          • startTimerequired — (Date)

            Start date / time for the Job.

          • statusrequired — (String)

            Status for the Job.

            Possible values include:
            • "PENDING"
            • "PROVISIONING"
            • "RUNNING"
            • "FAILED"
            • "SUCCEED"
            • "CANCELLING"
            • "CANCELLED"
          • endTime — (Date)

            End date / time for the Job.

          • jobTyperequired — (String)

            Type for the Job.

            Possible values include:
            • "RELEASE"
            • "RETRY"
            • "WEB_HOOK"
        • stepsrequired — (Array<map>)

          Execution steps for an execution job, for an Amplify App.

          • stepNamerequired — (String)

            Name of the execution step.

          • startTimerequired — (Date)

            Start date/ time of the execution step.

          • statusrequired — (String)

            Status of the execution step.

            Possible values include:
            • "PENDING"
            • "PROVISIONING"
            • "RUNNING"
            • "FAILED"
            • "SUCCEED"
            • "CANCELLING"
            • "CANCELLED"
          • endTimerequired — (Date)

            End date/ time of the execution step.

          • logUrl — (String)

            Url to the logs for the execution step.

          • artifactsUrl — (String)

            Url to teh artifact for the execution step.

          • screenshots — (map<String>)

            List of screenshot Urls for the execution step, if relevant.

Returns:

  • (AWS.Request)

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

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

Lists existing Amplify Apps.

Service Reference:

Examples:

Calling the listApps operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
amplify.listApps(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: {})
    • 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.

    • maxResults — (Integer)

      Maximum number of records to list in a single response.

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:

      • apps — (Array<map>)

        List of Amplify Apps.

        • appIdrequired — (String)

          Unique Id for the Amplify App.

        • appArnrequired — (String)

          ARN for the Amplify App.

        • namerequired — (String)

          Name for the Amplify App.

        • tags — (map<String>)

          Tag for Amplify App.

        • descriptionrequired — (String)

          Description for the Amplify App.

        • repositoryrequired — (String)

          Repository for the Amplify App.

        • platformrequired — (String)

          Platform for the Amplify App.

          Possible values include:
          • "IOS"
          • "ANDROID"
          • "WEB"
          • "REACT_NATIVE"
        • createTimerequired — (Date)

          Create date / time for the Amplify App.

        • updateTimerequired — (Date)

          Update date / time for the Amplify App.

        • iamServiceRoleArn — (String)

          IAM service role ARN for the Amplify App.

        • environmentVariablesrequired — (map<String>)

          Environment Variables for the Amplify App.

        • defaultDomainrequired — (String)

          Default domain for the Amplify App.

        • enableBranchAutoBuildrequired — (Boolean)

          Enables auto-building of branches for the Amplify App.

        • enableBasicAuthrequired — (Boolean)

          Enables Basic Authorization for branches for the Amplify App.

        • basicAuthCredentials — (String)

          Basic Authorization credentials for branches for the Amplify App.

        • customRules — (Array<map>)

          Custom redirect / rewrite rules for the Amplify App.

          • sourcerequired — (String)

            The source pattern for a URL rewrite or redirect rule.

          • targetrequired — (String)

            The target pattern for a URL rewrite or redirect rule.

          • status — (String)

            The status code for a URL rewrite or redirect rule.

          • condition — (String)

            The condition for a URL rewrite or redirect rule, e.g. country code.

        • productionBranch — (map)

          Structure with Production Branch information.

          • lastDeployTime — (Date)

            Last Deploy Time of Production Branch.

          • status — (String)

            Status of Production Branch.

          • thumbnailUrl — (String)

            Thumbnail Url for Production Branch.

          • branchName — (String)

            Branch Name for Production Branch.

        • buildSpec — (String)

          BuildSpec content for Amplify App.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Lists branches for an Amplify App.

Service Reference:

Examples:

Calling the listBranches operation

var params = {
  appId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
amplify.listBranches(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • nextToken — (String)

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

    • maxResults — (Integer)

      Maximum number of records to list in a single response.

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:

      • branches — (Array<map>)

        List of branches for an Amplify App.

        • branchArnrequired — (String)

          ARN for a branch, part of an Amplify App.

        • branchNamerequired — (String)

          Name for a branch, part of an Amplify App.

        • descriptionrequired — (String)

          Description for a branch, part of an Amplify App.

        • tags — (map<String>)

          Tag for branch for Amplify App.

        • stagerequired — (String)

          Stage for a branch, part of an Amplify App.

          Possible values include:
          • "PRODUCTION"
          • "BETA"
          • "DEVELOPMENT"
          • "EXPERIMENTAL"
        • displayName — (String)

          Display name for a branch, part of an Amplify App.

        • enableNotificationrequired — (Boolean)

          Enables notifications for a branch, part of an Amplify App.

        • createTimerequired — (Date)

          Creation date and time for a branch, part of an Amplify App.

        • updateTimerequired — (Date)

          Last updated date and time for a branch, part of an Amplify App.

        • environmentVariablesrequired — (map<String>)

          Environment Variables specific to a branch, part of an Amplify App.

        • enableAutoBuildrequired — (Boolean)

          Enables auto-building on push for a branch, part of an Amplify App.

        • customDomainsrequired — (Array<String>)

          Custom domains for a branch, part of an Amplify App.

        • frameworkrequired — (String)

          Framework for a branch, part of an Amplify App.

        • activeJobIdrequired — (String)

          Id of the active job for a branch, part of an Amplify App.

        • totalNumberOfJobsrequired — (String)

          Total number of Jobs part of an Amplify App.

        • enableBasicAuthrequired — (Boolean)

          Enables Basic Authorization for a branch, part of an Amplify App.

        • thumbnailUrl — (String)

          Thumbnail Url for the branch.

        • basicAuthCredentials — (String)

          Basic Authorization credentials for a branch, part of an Amplify App.

        • buildSpec — (String)

          BuildSpec content for branch for Amplify App.

        • ttlrequired — (String)

          The content TTL for the website in seconds.

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

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

List domains with an app

Service Reference:

Examples:

Calling the listDomainAssociations operation

var params = {
  appId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
amplify.listDomainAssociations(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • nextToken — (String)

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

    • maxResults — (Integer)

      Maximum number of records to list in a single response.

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:

      • domainAssociations — (Array<map>)

        List of Domain Associations.

        • domainAssociationArnrequired — (String)

          ARN for the Domain Association.

        • domainNamerequired — (String)

          Name of the domain.

        • enableAutoSubDomainrequired — (Boolean)

          Enables automated creation of Subdomains for branches.

        • domainStatusrequired — (String)

          Status fo the Domain Association.

          Possible values include:
          • "PENDING_VERIFICATION"
          • "IN_PROGRESS"
          • "AVAILABLE"
          • "PENDING_DEPLOYMENT"
          • "FAILED"
        • statusReasonrequired — (String)

          Reason for the current status of the Domain Association.

        • certificateVerificationDNSRecordrequired — (String)

          DNS Record for certificate verification.

        • subDomainsrequired — (Array<map>)

          Subdomains for the Domain Association.

          • subDomainSettingrequired — (map)

            Setting structure for the Subdomain.

            • prefixrequired — (String)

              Prefix setting for the Subdomain.

            • branchNamerequired — (String)

              Branch name setting for the Subdomain.

          • verifiedrequired — (Boolean)

            Verified status of the Subdomain

          • dnsRecordrequired — (String)

            DNS record for the Subdomain.

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

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

List Jobs for a branch, part of an Amplify App.

Service Reference:

Examples:

Calling the listJobs operation

var params = {
  appId: 'STRING_VALUE', /* required */
  branchName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
amplify.listJobs(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • branchName — (String)

      Name for a branch.

    • nextToken — (String)

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

    • maxResults — (Integer)

      Maximum number of records to list in a single response.

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:

      • jobSummaries — (Array<map>)

        Result structure for list job result request.

        • jobArnrequired — (String)

          Arn for the Job.

        • jobIdrequired — (String)

          Unique Id for the Job.

        • commitIdrequired — (String)

          Commit Id from 3rd party repository provider for the Job.

        • commitMessagerequired — (String)

          Commit message from 3rd party repository provider for the Job.

        • commitTimerequired — (Date)

          Commit date / time for the Job.

        • startTimerequired — (Date)

          Start date / time for the Job.

        • statusrequired — (String)

          Status for the Job.

          Possible values include:
          • "PENDING"
          • "PROVISIONING"
          • "RUNNING"
          • "FAILED"
          • "SUCCEED"
          • "CANCELLING"
          • "CANCELLED"
        • endTime — (Date)

          End date / time for the Job.

        • jobTyperequired — (String)

          Type for the Job.

          Possible values include:
          • "RELEASE"
          • "RETRY"
          • "WEB_HOOK"
      • 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.

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

Starts a new job for a branch, part of an Amplify App.

Service Reference:

Examples:

Calling the startJob operation

var params = {
  appId: 'STRING_VALUE', /* required */
  branchName: 'STRING_VALUE', /* required */
  jobType: RELEASE | RETRY | WEB_HOOK, /* required */
  commitId: 'STRING_VALUE',
  commitMessage: 'STRING_VALUE',
  commitTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  jobId: 'STRING_VALUE',
  jobReason: 'STRING_VALUE'
};
amplify.startJob(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • branchName — (String)

      Name for the branch, for the Job.

    • jobId — (String)

      Unique Id for the Job.

    • jobType — (String)

      Type for the Job.

      Possible values include:
      • "RELEASE"
      • "RETRY"
      • "WEB_HOOK"
    • jobReason — (String)

      Reason for the Job.

    • commitId — (String)

      Commit Id from 3rd party repository provider for the Job.

    • commitMessage — (String)

      Commit message from 3rd party repository provider for the Job.

    • commitTime — (Date)

      Commit date / time for the Job.

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:

      • jobSummary — (map)

        Summary for the Job.

        • jobArnrequired — (String)

          Arn for the Job.

        • jobIdrequired — (String)

          Unique Id for the Job.

        • commitIdrequired — (String)

          Commit Id from 3rd party repository provider for the Job.

        • commitMessagerequired — (String)

          Commit message from 3rd party repository provider for the Job.

        • commitTimerequired — (Date)

          Commit date / time for the Job.

        • startTimerequired — (Date)

          Start date / time for the Job.

        • statusrequired — (String)

          Status for the Job.

          Possible values include:
          • "PENDING"
          • "PROVISIONING"
          • "RUNNING"
          • "FAILED"
          • "SUCCEED"
          • "CANCELLING"
          • "CANCELLED"
        • endTime — (Date)

          End date / time for the Job.

        • jobTyperequired — (String)

          Type for the Job.

          Possible values include:
          • "RELEASE"
          • "RETRY"
          • "WEB_HOOK"

Returns:

  • (AWS.Request)

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

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

Stop a job that is in progress, for an Amplify branch, part of Amplify App.

Service Reference:

Examples:

Calling the stopJob operation

var params = {
  appId: 'STRING_VALUE', /* required */
  branchName: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE' /* required */
};
amplify.stopJob(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • branchName — (String)

      Name for the branch, for the Job.

    • jobId — (String)

      Unique Id for the Job.

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:

      • jobSummary — (map)

        Summary for the Job.

        • jobArnrequired — (String)

          Arn for the Job.

        • jobIdrequired — (String)

          Unique Id for the Job.

        • commitIdrequired — (String)

          Commit Id from 3rd party repository provider for the Job.

        • commitMessagerequired — (String)

          Commit message from 3rd party repository provider for the Job.

        • commitTimerequired — (Date)

          Commit date / time for the Job.

        • startTimerequired — (Date)

          Start date / time for the Job.

        • statusrequired — (String)

          Status for the Job.

          Possible values include:
          • "PENDING"
          • "PROVISIONING"
          • "RUNNING"
          • "FAILED"
          • "SUCCEED"
          • "CANCELLING"
          • "CANCELLED"
        • endTime — (Date)

          End date / time for the Job.

        • jobTyperequired — (String)

          Type for the Job.

          Possible values include:
          • "RELEASE"
          • "RETRY"
          • "WEB_HOOK"

Returns:

  • (AWS.Request)

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

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

Updates an existing Amplify App.

Service Reference:

Examples:

Calling the updateApp operation

var params = {
  appId: 'STRING_VALUE', /* required */
  basicAuthCredentials: 'STRING_VALUE',
  buildSpec: 'STRING_VALUE',
  customRules: [
    {
      source: 'STRING_VALUE', /* required */
      target: 'STRING_VALUE', /* required */
      condition: 'STRING_VALUE',
      status: 'STRING_VALUE'
    },
    /* more items */
  ],
  description: 'STRING_VALUE',
  enableBasicAuth: true || false,
  enableBranchAutoBuild: true || false,
  environmentVariables: {
    '<EnvKey>': 'STRING_VALUE',
    /* '<EnvKey>': ... */
  },
  iamServiceRoleArn: 'STRING_VALUE',
  name: 'STRING_VALUE',
  platform: IOS | ANDROID | WEB | REACT_NATIVE
};
amplify.updateApp(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • name — (String)

      Name for an Amplify App.

    • description — (String)

      Description for an Amplify App.

    • platform — (String)

      Platform for an Amplify App.

      Possible values include:
      • "IOS"
      • "ANDROID"
      • "WEB"
      • "REACT_NATIVE"
    • iamServiceRoleArn — (String)

      IAM service role for an Amplify App.

    • environmentVariables — (map<String>)

      Environment Variables for an Amplify App.

    • enableBranchAutoBuild — (Boolean)

      Enables branch auto-building for an Amplify App.

    • enableBasicAuth — (Boolean)

      Enables Basic Authorization for an Amplify App.

    • basicAuthCredentials — (String)

      Basic Authorization credentials for an Amplify App.

    • customRules — (Array<map>)

      Custom redirect / rewrite rules for an Amplify App.

      • sourcerequired — (String)

        The source pattern for a URL rewrite or redirect rule.

      • targetrequired — (String)

        The target pattern for a URL rewrite or redirect rule.

      • status — (String)

        The status code for a URL rewrite or redirect rule.

      • condition — (String)

        The condition for a URL rewrite or redirect rule, e.g. country code.

    • buildSpec — (String)

      BuildSpec for an Amplify App.

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:

      • app — (map)

        App structure for the updated App.

        • appIdrequired — (String)

          Unique Id for the Amplify App.

        • appArnrequired — (String)

          ARN for the Amplify App.

        • namerequired — (String)

          Name for the Amplify App.

        • tags — (map<String>)

          Tag for Amplify App.

        • descriptionrequired — (String)

          Description for the Amplify App.

        • repositoryrequired — (String)

          Repository for the Amplify App.

        • platformrequired — (String)

          Platform for the Amplify App.

          Possible values include:
          • "IOS"
          • "ANDROID"
          • "WEB"
          • "REACT_NATIVE"
        • createTimerequired — (Date)

          Create date / time for the Amplify App.

        • updateTimerequired — (Date)

          Update date / time for the Amplify App.

        • iamServiceRoleArn — (String)

          IAM service role ARN for the Amplify App.

        • environmentVariablesrequired — (map<String>)

          Environment Variables for the Amplify App.

        • defaultDomainrequired — (String)

          Default domain for the Amplify App.

        • enableBranchAutoBuildrequired — (Boolean)

          Enables auto-building of branches for the Amplify App.

        • enableBasicAuthrequired — (Boolean)

          Enables Basic Authorization for branches for the Amplify App.

        • basicAuthCredentials — (String)

          Basic Authorization credentials for branches for the Amplify App.

        • customRules — (Array<map>)

          Custom redirect / rewrite rules for the Amplify App.

          • sourcerequired — (String)

            The source pattern for a URL rewrite or redirect rule.

          • targetrequired — (String)

            The target pattern for a URL rewrite or redirect rule.

          • status — (String)

            The status code for a URL rewrite or redirect rule.

          • condition — (String)

            The condition for a URL rewrite or redirect rule, e.g. country code.

        • productionBranch — (map)

          Structure with Production Branch information.

          • lastDeployTime — (Date)

            Last Deploy Time of Production Branch.

          • status — (String)

            Status of Production Branch.

          • thumbnailUrl — (String)

            Thumbnail Url for Production Branch.

          • branchName — (String)

            Branch Name for Production Branch.

        • buildSpec — (String)

          BuildSpec content for Amplify App.

Returns:

  • (AWS.Request)

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

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

Updates a branch for an Amplify App.

Service Reference:

Examples:

Calling the updateBranch operation

var params = {
  appId: 'STRING_VALUE', /* required */
  branchName: 'STRING_VALUE', /* required */
  basicAuthCredentials: 'STRING_VALUE',
  buildSpec: 'STRING_VALUE',
  description: 'STRING_VALUE',
  enableAutoBuild: true || false,
  enableBasicAuth: true || false,
  enableNotification: true || false,
  environmentVariables: {
    '<EnvKey>': 'STRING_VALUE',
    /* '<EnvKey>': ... */
  },
  framework: 'STRING_VALUE',
  stage: PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL,
  ttl: 'STRING_VALUE'
};
amplify.updateBranch(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • branchName — (String)

      Name for the branch.

    • description — (String)

      Description for the branch.

    • framework — (String)

      Framework for the branch.

    • stage — (String)

      Stage for the branch.

      Possible values include:
      • "PRODUCTION"
      • "BETA"
      • "DEVELOPMENT"
      • "EXPERIMENTAL"
    • enableNotification — (Boolean)

      Enables notifications for the branch.

    • enableAutoBuild — (Boolean)

      Enables auto building for the branch.

    • environmentVariables — (map<String>)

      Environment Variables for the branch.

    • basicAuthCredentials — (String)

      Basic Authorization credentials for the branch.

    • enableBasicAuth — (Boolean)

      Enables Basic Auth for the branch.

    • buildSpec — (String)

      BuildSpec for the branch.

    • ttl — (String)

      The content TTL for the website in seconds.

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:

      • branch — (map)

        Branch structure for an Amplify App.

        • branchArnrequired — (String)

          ARN for a branch, part of an Amplify App.

        • branchNamerequired — (String)

          Name for a branch, part of an Amplify App.

        • descriptionrequired — (String)

          Description for a branch, part of an Amplify App.

        • tags — (map<String>)

          Tag for branch for Amplify App.

        • stagerequired — (String)

          Stage for a branch, part of an Amplify App.

          Possible values include:
          • "PRODUCTION"
          • "BETA"
          • "DEVELOPMENT"
          • "EXPERIMENTAL"
        • displayName — (String)

          Display name for a branch, part of an Amplify App.

        • enableNotificationrequired — (Boolean)

          Enables notifications for a branch, part of an Amplify App.

        • createTimerequired — (Date)

          Creation date and time for a branch, part of an Amplify App.

        • updateTimerequired — (Date)

          Last updated date and time for a branch, part of an Amplify App.

        • environmentVariablesrequired — (map<String>)

          Environment Variables specific to a branch, part of an Amplify App.

        • enableAutoBuildrequired — (Boolean)

          Enables auto-building on push for a branch, part of an Amplify App.

        • customDomainsrequired — (Array<String>)

          Custom domains for a branch, part of an Amplify App.

        • frameworkrequired — (String)

          Framework for a branch, part of an Amplify App.

        • activeJobIdrequired — (String)

          Id of the active job for a branch, part of an Amplify App.

        • totalNumberOfJobsrequired — (String)

          Total number of Jobs part of an Amplify App.

        • enableBasicAuthrequired — (Boolean)

          Enables Basic Authorization for a branch, part of an Amplify App.

        • thumbnailUrl — (String)

          Thumbnail Url for the branch.

        • basicAuthCredentials — (String)

          Basic Authorization credentials for a branch, part of an Amplify App.

        • buildSpec — (String)

          BuildSpec content for branch for Amplify App.

        • ttlrequired — (String)

          The content TTL for the website in seconds.

Returns:

  • (AWS.Request)

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

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

Create a new DomainAssociation on an App

Service Reference:

Examples:

Calling the updateDomainAssociation operation

var params = {
  appId: 'STRING_VALUE', /* required */
  domainName: 'STRING_VALUE', /* required */
  subDomainSettings: [ /* required */
    {
      branchName: 'STRING_VALUE', /* required */
      prefix: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  enableAutoSubDomain: true || false
};
amplify.updateDomainAssociation(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: {})
    • appId — (String)

      Unique Id for an Amplify App.

    • domainName — (String)

      Name of the domain.

    • enableAutoSubDomain — (Boolean)

      Enables automated creation of Subdomains for branches.

    • subDomainSettings — (Array<map>)

      Setting structure for the Subdomain.

      • prefixrequired — (String)

        Prefix setting for the Subdomain.

      • branchNamerequired — (String)

        Branch name setting for the Subdomain.

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:

      • domainAssociation — (map)

        Domain Association structure.

        • domainAssociationArnrequired — (String)

          ARN for the Domain Association.

        • domainNamerequired — (String)

          Name of the domain.

        • enableAutoSubDomainrequired — (Boolean)

          Enables automated creation of Subdomains for branches.

        • domainStatusrequired — (String)

          Status fo the Domain Association.

          Possible values include:
          • "PENDING_VERIFICATION"
          • "IN_PROGRESS"
          • "AVAILABLE"
          • "PENDING_DEPLOYMENT"
          • "FAILED"
        • statusReasonrequired — (String)

          Reason for the current status of the Domain Association.

        • certificateVerificationDNSRecordrequired — (String)

          DNS Record for certificate verification.

        • subDomainsrequired — (Array<map>)

          Subdomains for the Domain Association.

          • subDomainSettingrequired — (map)

            Setting structure for the Subdomain.

            • prefixrequired — (String)

              Prefix setting for the Subdomain.

            • branchNamerequired — (String)

              Branch name setting for the Subdomain.

          • verifiedrequired — (Boolean)

            Verified status of the Subdomain

          • dnsRecordrequired — (String)

            DNS record for the Subdomain.

Returns:

  • (AWS.Request)

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