AWS.ChimeSDKIdentity — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

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

Service Description

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to Amazon Chime SDK identity.

Sending a Request Using ChimeSDKIdentity

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

var chimesdkidentity = new AWS.ChimeSDKIdentity({apiVersion: '2021-04-20'});

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

AWS.config.apiVersions = {
  chimesdkidentity: '2021-04-20',
  // other service API versions
};

var chimesdkidentity = new AWS.ChimeSDKIdentity();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Property Details

endpoint ⇒ AWS.Endpoint

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

Method Details

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

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

identity

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

Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions.

Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.

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

Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.

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

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

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

Deletes an AppInstance and all associated data asynchronously.

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

Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.

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

Deletes an AppInstanceBot.

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

Deletes an AppInstanceUser.

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

Deregisters an AppInstanceUserEndpoint.

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

Returns the full details of an AppInstance.

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

Returns the full details of an AppInstanceAdmin.

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

The AppInstanceBot's information.

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

Returns the full details of an AppInstanceUser.

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

Returns the full details of an AppInstanceUserEndpoint.

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

Gets the retention settings for an AppInstance.

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

Returns a list of the administrators in the AppInstance.

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

Lists all AppInstanceBots created under a single AppInstance.

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

Lists all Amazon Chime AppInstances created under a single AWS account.

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

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

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

List all AppInstanceUsers created under a single AppInstance.

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

Lists the tags applied to an Amazon Chime SDK identity resource.

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

Sets the amount of time in days that a given AppInstance retains data.

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

Sets the number of days before the AppInstanceUser is automatically deleted.

Note: A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary. Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

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

Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

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

Applies the specified tags to the specified Amazon Chime SDK identity resource.

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

Removes the specified tags from the specified Amazon Chime SDK identity resource.

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

Updates AppInstance metadata.

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

Updates the name and metadata of an AppInstanceBot.

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

Updates the details of an AppInstanceUser. You can update names and metadata.

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

Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.