You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.ChimeSDKIdentity

Inherits:
AWS.Service show all
Identifier:
chimesdkidentity
API Version:
2021-04-20
Defined in:
(unknown)

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();

Version:

  • 2021-04-20

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

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

Examples:

Constructing a ChimeSDKIdentity object

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

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|AWS.Endpoint)

    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' or an Endpoint object.

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

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

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

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

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

Service Reference:

Examples:

Calling the createAppInstance operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Metadata: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkidentity.createAppInstance(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)

      The name of the AppInstance.

    • Metadata — (String)

      The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

    • ClientRequestToken — (String)

      The unique ID of the request. Use different tokens to create different AppInstances.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      Tags assigned to the AppInstance.

      • Keyrequired — (String)

        The key in a tag.

      • Valuerequired — (String)

        The value in a tag.

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:

      • AppInstanceArn — (String)

        The Amazon Resource Number (ARN) of the AppInstance.

Returns:

  • (AWS.Request)

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

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

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

  • ChannelModerator actions across all channels in the AppInstance.

  • DeleteChannelMessage actions.

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

Service Reference:

Examples:

Calling the createAppInstanceAdmin operation

var params = {
  AppInstanceAdminArn: 'STRING_VALUE', /* required */
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chimesdkidentity.createAppInstanceAdmin(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: {})
    • AppInstanceAdminArn — (String)

      The ARN of the administrator of the current AppInstance.

    • AppInstanceArn — (String)

      The ARN of the AppInstance.

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:

      • AppInstanceAdmin — (map)

        The ARN and name of the administrator, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • AppInstanceArn — (String)

        The ARN of the of the admin for the AppInstance.

Returns:

  • (AWS.Request)

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

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.

Service Reference:

Examples:

Calling the createAppInstanceBot operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Configuration: { /* required */
    Lex: { /* required */
      LexBotAliasArn: 'STRING_VALUE', /* required */
      LocaleId: 'STRING_VALUE', /* required */
      RespondsTo: STANDARD_MESSAGES, /* required */
      WelcomeIntent: 'STRING_VALUE'
    }
  },
  Metadata: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkidentity.createAppInstanceBot(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance request.

    • Name — (String)

      The user's name.

    • Metadata — (String)

      The request metadata. Limited to a 1KB string in UTF-8.

    • ClientRequestToken — (String)

      The unique ID for the client making the request. Use different tokens for different AppInstanceBots.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      The tags assigned to the AppInstanceBot.

      • Keyrequired — (String)

        The key in a tag.

      • Valuerequired — (String)

        The value in a tag.

    • Configuration — (map)

      Configuration information about the Amazon Lex V2 V2 bot.

      • Lexrequired — (map)

        The configuration for an Amazon Lex V2 bot.

        • RespondsTorequired — (String)

          Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

          Possible values include:
          • "STANDARD_MESSAGES"
        • LexBotAliasArnrequired — (String)

          The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS

        • LocaleIdrequired — (String)

          Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide.

        • WelcomeIntent — (String)

          The name of the welcome intent configured in the Amazon Lex V2 bot.

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:

      • AppInstanceBotArn — (String)

        The ARN of the AppinstanceBot.

Returns:

  • (AWS.Request)

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

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.

Service Reference:

Examples:

Calling the createAppInstanceUser operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  AppInstanceUserId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ExpirationSettings: {
    ExpirationCriterion: CREATED_TIMESTAMP, /* required */
    ExpirationDays: 'NUMBER_VALUE' /* required */
  },
  Metadata: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkidentity.createAppInstanceUser(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance request.

    • AppInstanceUserId — (String)

      The user ID of the AppInstance.

    • Name — (String)

      The user's name.

    • Metadata — (String)

      The request's metadata. Limited to a 1KB string in UTF-8.

    • ClientRequestToken — (String)

      The unique ID of the request. Use different tokens to request additional AppInstances.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      Tags assigned to the AppInstanceUser.

      • Keyrequired — (String)

        The key in a tag.

      • Valuerequired — (String)

        The value in a tag.

    • ExpirationSettings — (map)

      Settings that control the interval after which the AppInstanceUser is automatically deleted.

      • ExpirationDaysrequired — (Integer)

        The period in days after which an AppInstanceUser will be automatically deleted.

      • ExpirationCriterionrequired — (String)

        Specifies the conditions under which an AppInstanceUser will expire.

        Possible values include:
        • "CREATED_TIMESTAMP"

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:

      • AppInstanceUserArn — (String)

        The user's ARN.

Returns:

  • (AWS.Request)

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

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

Deletes an AppInstance and all associated data asynchronously.

Service Reference:

Examples:

Calling the deleteAppInstance operation

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

      The ARN of the AppInstance.

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.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the deleteAppInstanceAdmin operation

var params = {
  AppInstanceAdminArn: 'STRING_VALUE', /* required */
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chimesdkidentity.deleteAppInstanceAdmin(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: {})
    • AppInstanceAdminArn — (String)

      The ARN of the AppInstance's administrator.

    • AppInstanceArn — (String)

      The ARN of the AppInstance.

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.

Returns:

  • (AWS.Request)

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

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

Deletes an AppInstanceBot.

Service Reference:

Examples:

Calling the deleteAppInstanceBot operation

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

      The ARN of the AppInstanceBot being deleted.

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.

Returns:

  • (AWS.Request)

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

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

Deletes an AppInstanceUser.

Service Reference:

Examples:

Calling the deleteAppInstanceUser operation

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

      The ARN of the user request being deleted.

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.

Returns:

  • (AWS.Request)

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

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

Deregisters an AppInstanceUserEndpoint.

Examples:

Calling the deregisterAppInstanceUserEndpoint operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE', /* required */
  EndpointId: 'STRING_VALUE' /* required */
};
chimesdkidentity.deregisterAppInstanceUserEndpoint(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUser.

    • EndpointId — (String)

      The unique identifier of the AppInstanceUserEndpoint.

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.

Returns:

  • (AWS.Request)

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

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

Returns the full details of an AppInstance.

Service Reference:

Examples:

Calling the describeAppInstance operation

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

      The ARN of the AppInstance.

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:

      • AppInstance — (map)

        The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.

        • AppInstanceArn — (String)

          The ARN of the messaging instance.

        • Name — (String)

          The name of an AppInstance.

        • CreatedTimestamp — (Date)

          The time at which an AppInstance was created. In epoch milliseconds.

        • LastUpdatedTimestamp — (Date)

          The time an AppInstance was last updated. In epoch milliseconds.

        • Metadata — (String)

          The metadata of an AppInstance.

Returns:

  • (AWS.Request)

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

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

Returns the full details of an AppInstanceAdmin.

Service Reference:

Examples:

Calling the describeAppInstanceAdmin operation

var params = {
  AppInstanceAdminArn: 'STRING_VALUE', /* required */
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chimesdkidentity.describeAppInstanceAdmin(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: {})
    • AppInstanceAdminArn — (String)

      The ARN of the AppInstanceAdmin.

    • AppInstanceArn — (String)

      The ARN of the AppInstance.

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:

      • AppInstanceAdmin — (map)

        The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

        • Admin — (map)

          The AppInstanceAdmin data.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

        • AppInstanceArn — (String)

          The ARN of the AppInstance for which the user is an administrator.

        • CreatedTimestamp — (Date)

          The time at which an administrator was created.

Returns:

  • (AWS.Request)

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

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

The AppInstanceBot's information.

Service Reference:

Examples:

Calling the describeAppInstanceBot operation

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

      The ARN of the AppInstanceBot.

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:

      • AppInstanceBot — (map)

        The detials of the AppInstanceBot.

        • AppInstanceBotArn — (String)

          The ARN of the AppInstanceBot.

        • Name — (String)

          The name of the AppInstanceBot.

        • Configuration — (map)

          The data processing instructions for an AppInstanceBot.

          • Lexrequired — (map)

            The configuration for an Amazon Lex V2 bot.

            • RespondsTorequired — (String)

              Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

              Possible values include:
              • "STANDARD_MESSAGES"
            • LexBotAliasArnrequired — (String)

              The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS

            • LocaleIdrequired — (String)

              Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide.

            • WelcomeIntent — (String)

              The name of the welcome intent configured in the Amazon Lex V2 bot.

        • CreatedTimestamp — (Date)

          The time at which the AppInstanceBot was created.

        • LastUpdatedTimestamp — (Date)

          The time at which the AppInstanceBot was last updated.

        • Metadata — (String)

          The metadata for an AppInstanceBot.

Returns:

  • (AWS.Request)

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

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

Returns the full details of an AppInstanceUser.

Service Reference:

Examples:

Calling the describeAppInstanceUser operation

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

      The ARN of the AppInstanceUser.

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:

      • AppInstanceUser — (map)

        The name of the AppInstanceUser.

        • AppInstanceUserArn — (String)

          The ARN of the AppInstanceUser.

        • Name — (String)

          The name of the AppInstanceUser.

        • Metadata — (String)

          The metadata of the AppInstanceUser.

        • CreatedTimestamp — (Date)

          The time at which the AppInstanceUser was created.

        • LastUpdatedTimestamp — (Date)

          The time at which the AppInstanceUser was last updated.

        • ExpirationSettings — (map)

          The interval after which an AppInstanceUser is automatically deleted.

          • ExpirationDaysrequired — (Integer)

            The period in days after which an AppInstanceUser will be automatically deleted.

          • ExpirationCriterionrequired — (String)

            Specifies the conditions under which an AppInstanceUser will expire.

            Possible values include:
            • "CREATED_TIMESTAMP"

Returns:

  • (AWS.Request)

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

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

Returns the full details of an AppInstanceUserEndpoint.

Service Reference:

Examples:

Calling the describeAppInstanceUserEndpoint operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE', /* required */
  EndpointId: 'STRING_VALUE' /* required */
};
chimesdkidentity.describeAppInstanceUserEndpoint(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUser.

    • EndpointId — (String)

      The unique identifier of the AppInstanceUserEndpoint.

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:

      • AppInstanceUserEndpoint — (map)

        The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.

        • AppInstanceUserArn — (String)

          The ARN of the AppInstanceUser.

        • EndpointId — (String)

          The unique identifier of the AppInstanceUserEndpoint.

        • Name — (String)

          The name of the AppInstanceUserEndpoint.

        • Type — (String)

          The type of the AppInstanceUserEndpoint.

          Possible values include:
          • "APNS"
          • "APNS_SANDBOX"
          • "GCM"
        • ResourceArn — (String)

          The ARN of the resource to which the endpoint belongs.

        • EndpointAttributes — (map)

          The attributes of an Endpoint.

          • DeviceTokenrequired — (String)

            The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.

          • VoipDeviceToken — (String)

            The VOIP device token for the APNS and APNS_SANDBOX endpoint types.

        • CreatedTimestamp — (Date)

          The time at which an AppInstanceUserEndpoint was created.

        • LastUpdatedTimestamp — (Date)

          The time at which an AppInstanceUserEndpoint was last updated.

        • AllowMessages — (String)

          Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

          Possible values include:
          • "ALL"
          • "NONE"
        • EndpointState — (map)

          A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

          • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

          • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

          • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

          • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

          • Statusrequired — (String)

            Enum that indicates the Status of an AppInstanceUserEndpoint.

            Possible values include:
            • "ACTIVE"
            • "INACTIVE"
          • StatusReason — (String)

            The reason for the EndpointStatus.

            Possible values include:
            • "INVALID_DEVICE_TOKEN"
            • "INVALID_PINPOINT_ARN"

Returns:

  • (AWS.Request)

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

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

Gets the retention settings for an AppInstance.

Service Reference:

Examples:

Calling the getAppInstanceRetentionSettings operation

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

      The ARN of the AppInstance.

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:

      • AppInstanceRetentionSettings — (map)

        The retention settings for the AppInstance.

        • ChannelRetentionSettings — (map)

          The length of time in days to retain the messages in a channel.

          • RetentionDays — (Integer)

            The time in days to retain the messages in a channel.

      • InitiateDeletionTimestamp — (Date)

        The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

Returns:

  • (AWS.Request)

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

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

Returns a list of the administrators in the AppInstance.

Service Reference:

Examples:

Calling the listAppInstanceAdmins operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkidentity.listAppInstanceAdmins(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • MaxResults — (Integer)

      The maximum number of administrators that you want to return.

    • NextToken — (String)

      The token returned from previous API requests until the number of administrators is reached.

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:

      • AppInstanceArn — (String)

        The ARN of the AppInstance.

      • AppInstanceAdmins — (Array<map>)

        The information for each administrator.

        • Admin — (map)

          The details of the AppInstanceAdmin.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

      • NextToken — (String)

        The token returned from previous API requests until the number of administrators is reached.

Returns:

  • (AWS.Request)

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

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

Lists all AppInstanceBots created under a single AppInstance.

Service Reference:

Examples:

Calling the listAppInstanceBots operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkidentity.listAppInstanceBots(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • MaxResults — (Integer)

      The maximum number of requests to return.

    • NextToken — (String)

      The token passed by previous API calls until all requested bots are returned.

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:

      • AppInstanceArn — (String)

        The ARN of the AppInstance.

      • AppInstanceBots — (Array<map>)

        The information for each requested AppInstanceBot.

        • AppInstanceBotArn — (String)

          The ARN of the AppInstanceBot.

        • Name — (String)

          The name of the AppInstanceBox.

        • Metadata — (String)

          The metadata of the AppInstanceBot.

      • NextToken — (String)

        The token passed by previous API calls until all requested bots are returned.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the listAppInstances operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkidentity.listAppInstances(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)

      The maximum number of AppInstances that you want to return.

    • NextToken — (String)

      The token passed by previous API requests until you reach the maximum number of AppInstances.

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:

      • AppInstances — (Array<map>)

        The information for each AppInstance.

        • AppInstanceArn — (String)

          The AppInstance ARN.

        • Name — (String)

          The name of the AppInstance.

        • Metadata — (String)

          The metadata of the AppInstance.

      • NextToken — (String)

        The token passed by previous API requests until the maximum number of AppInstances is reached.

Returns:

  • (AWS.Request)

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

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

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Service Reference:

Examples:

Calling the listAppInstanceUserEndpoints operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkidentity.listAppInstanceUserEndpoints(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUser.

    • MaxResults — (Integer)

      The maximum number of endpoints that you want to return.

    • NextToken — (String)

      The token passed by previous API calls until all requested endpoints are returned.

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:

      • AppInstanceUserEndpoints — (Array<map>)

        The information for each requested AppInstanceUserEndpoint.

        • AppInstanceUserArn — (String)

          The ARN of the AppInstanceUser.

        • EndpointId — (String)

          The unique identifier of the AppInstanceUserEndpoint.

        • Name — (String)

          The name of the AppInstanceUserEndpoint.

        • Type — (String)

          The type of the AppInstanceUserEndpoint.

          Possible values include:
          • "APNS"
          • "APNS_SANDBOX"
          • "GCM"
        • AllowMessages — (String)

          BBoolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

          Possible values include:
          • "ALL"
          • "NONE"
        • EndpointState — (map)

          A read-only field that represent the state of an AppInstanceUserEndpoint.

          • Statusrequired — (String)

            Enum that indicates the Status of an AppInstanceUserEndpoint.

            Possible values include:
            • "ACTIVE"
            • "INACTIVE"
          • StatusReason — (String)

            The reason for the EndpointStatus.

            Possible values include:
            • "INVALID_DEVICE_TOKEN"
            • "INVALID_PINPOINT_ARN"
      • NextToken — (String)

        The token passed by previous API calls until all requested endpoints are returned.

Returns:

  • (AWS.Request)

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

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

List all AppInstanceUsers created under a single AppInstance.

Service Reference:

Examples:

Calling the listAppInstanceUsers operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkidentity.listAppInstanceUsers(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • MaxResults — (Integer)

      The maximum number of requests that you want returned.

    • NextToken — (String)

      The token passed by previous API calls until all requested users are returned.

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:

      • AppInstanceArn — (String)

        The ARN of the AppInstance.

      • AppInstanceUsers — (Array<map>)

        The information for each requested AppInstanceUser.

        • AppInstanceUserArn — (String)

          The ARN of the AppInstanceUser.

        • Name — (String)

          The name of an AppInstanceUser.

        • Metadata — (String)

          The metadata of the AppInstanceUser.

      • NextToken — (String)

        The token passed by previous API calls until all requested users are returned.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the listTagsForResource operation

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

      The ARN of the resource.

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:

      • Tags — (Array<map>)

        The tag key-value pairs.

        • Keyrequired — (String)

          The key in a tag.

        • Valuerequired — (String)

          The value in a tag.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the putAppInstanceRetentionSettings operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  AppInstanceRetentionSettings: { /* required */
    ChannelRetentionSettings: {
      RetentionDays: 'NUMBER_VALUE'
    }
  }
};
chimesdkidentity.putAppInstanceRetentionSettings(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • AppInstanceRetentionSettings — (map)

      The time in days to retain data. Data type: number.

      • ChannelRetentionSettings — (map)

        The length of time in days to retain the messages in a channel.

        • RetentionDays — (Integer)

          The time in days to retain the messages in a channel.

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:

      • AppInstanceRetentionSettings — (map)

        The time in days to retain data. Data type: number.

        • ChannelRetentionSettings — (map)

          The length of time in days to retain the messages in a channel.

          • RetentionDays — (Integer)

            The time in days to retain the messages in a channel.

      • InitiateDeletionTimestamp — (Date)

        The time at which the API deletes data.

Returns:

  • (AWS.Request)

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

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.

Examples:

Calling the putAppInstanceUserExpirationSettings operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE', /* required */
  ExpirationSettings: {
    ExpirationCriterion: CREATED_TIMESTAMP, /* required */
    ExpirationDays: 'NUMBER_VALUE' /* required */
  }
};
chimesdkidentity.putAppInstanceUserExpirationSettings(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUser.

    • ExpirationSettings — (map)

      Settings that control the interval after which an AppInstanceUser is automatically deleted.

      • ExpirationDaysrequired — (Integer)

        The period in days after which an AppInstanceUser will be automatically deleted.

      • ExpirationCriterionrequired — (String)

        Specifies the conditions under which an AppInstanceUser will expire.

        Possible values include:
        • "CREATED_TIMESTAMP"

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:

      • AppInstanceUserArn — (String)

        The ARN of the AppInstanceUser.

      • ExpirationSettings — (map)

        Settings that control the interval after which an AppInstanceUser is automatically deleted.

        • ExpirationDaysrequired — (Integer)

          The period in days after which an AppInstanceUser will be automatically deleted.

        • ExpirationCriterionrequired — (String)

          Specifies the conditions under which an AppInstanceUser will expire.

          Possible values include:
          • "CREATED_TIMESTAMP"

Returns:

  • (AWS.Request)

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

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.

Service Reference:

Examples:

Calling the registerAppInstanceUserEndpoint operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  EndpointAttributes: { /* required */
    DeviceToken: 'STRING_VALUE', /* required */
    VoipDeviceToken: 'STRING_VALUE'
  },
  ResourceArn: 'STRING_VALUE', /* required */
  Type: APNS | APNS_SANDBOX | GCM, /* required */
  AllowMessages: ALL | NONE,
  Name: 'STRING_VALUE'
};
chimesdkidentity.registerAppInstanceUserEndpoint(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUser.

    • Name — (String)

      The name of the AppInstanceUserEndpoint.

    • Type — (String)

      The type of the AppInstanceUserEndpoint. Supported types:

      • APNS: The mobile notification service for an Apple device.

      • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

      • GCM: The mobile notification service for an Android device.

      Populate the ResourceArn value of each type as PinpointAppArn.

      Possible values include:
      • "APNS"
      • "APNS_SANDBOX"
      • "GCM"
    • ResourceArn — (String)

      The ARN of the resource to which the endpoint belongs.

    • EndpointAttributes — (map)

      The attributes of an Endpoint.

      • DeviceTokenrequired — (String)

        The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.

      • VoipDeviceToken — (String)

        The VOIP device token for the APNS and APNS_SANDBOX endpoint types.

    • ClientRequestToken — (String)

      The unique ID assigned to the request. Use different tokens to register other endpoints.

      If a token is not provided, the SDK will use a version 4 UUID.
    • AllowMessages — (String)

      Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

      Possible values include:
      • "ALL"
      • "NONE"

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:

      • AppInstanceUserArn — (String)

        The ARN of the AppInstanceUser.

      • EndpointId — (String)

        The unique identifier of the AppInstanceUserEndpoint.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkidentity.tagResource(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: {})
    • ResourceARN — (String)

      The resource ARN.

    • Tags — (Array<map>)

      The tag key-value pairs.

      • Keyrequired — (String)

        The key in a tag.

      • Valuerequired — (String)

        The value in a tag.

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.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chimesdkidentity.untagResource(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: {})
    • ResourceARN — (String)

      The resource ARN.

    • TagKeys — (Array<String>)

      The tag keys.

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.

Returns:

  • (AWS.Request)

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

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

Updates AppInstance metadata.

Service Reference:

Examples:

Calling the updateAppInstance operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  Metadata: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
chimesdkidentity.updateAppInstance(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • Name — (String)

      The name that you want to change.

    • Metadata — (String)

      The metadata that you want to change.

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:

      • AppInstanceArn — (String)

        The ARN of the AppInstance.

Returns:

  • (AWS.Request)

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

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

Updates the name and metadata of an AppInstanceBot.

Service Reference:

Examples:

Calling the updateAppInstanceBot operation

var params = {
  AppInstanceBotArn: 'STRING_VALUE', /* required */
  Metadata: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
chimesdkidentity.updateAppInstanceBot(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: {})
    • AppInstanceBotArn — (String)

      The ARN of the AppInstanceBot.

    • Name — (String)

      The name of the AppInstanceBot.

    • Metadata — (String)

      The metadata of the AppInstanceBot.

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:

      • AppInstanceBotArn — (String)

        The ARN of the AppInstanceBot.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the updateAppInstanceUser operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE', /* required */
  Metadata: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
chimesdkidentity.updateAppInstanceUser(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUser.

    • Name — (String)

      The name of the AppInstanceUser.

    • Metadata — (String)

      The metadata of the AppInstanceUser.

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:

      • AppInstanceUserArn — (String)

        The ARN of the AppInstanceUser.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the updateAppInstanceUserEndpoint operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE', /* required */
  EndpointId: 'STRING_VALUE', /* required */
  AllowMessages: ALL | NONE,
  Name: 'STRING_VALUE'
};
chimesdkidentity.updateAppInstanceUserEndpoint(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUser.

    • EndpointId — (String)

      The unique identifier of the AppInstanceUserEndpoint.

    • Name — (String)

      The name of the AppInstanceUserEndpoint.

    • AllowMessages — (String)

      Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

      Possible values include:
      • "ALL"
      • "NONE"

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:

      • AppInstanceUserArn — (String)

        The ARN of the AppInstanceUser.

      • EndpointId — (String)

        The unique identifier of the AppInstanceUserEndpoint.

Returns:

  • (AWS.Request)

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