Class: AWS.ChimeSDKIdentity

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 name and ARN of the admin for the AppInstance.

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

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  AppInstanceUserId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Name: 'STRING_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 token assigned to the user requesting an AppInstance.

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

    Tags assigned to the AppInstanceUser.

    • Key — required — (String)

      The key in a tag.

    • Value — required — (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:

    • AppInstanceUserArn — (String)

      The user's ARN.

Returns:

• (AWS.Request) —

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

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.

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.

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.

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.

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.

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.

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.

Returns:

• (AWS.Request) —

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

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.

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

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

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.

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.

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.

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.

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

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.

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.

      • Key — required — (String)

        The key in a tag.

      • Value — required — (String)

        The value in a tag.

Returns:

• (AWS.Request) —

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

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.

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.

    • DeviceToken — required — (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 idempotency token for each client request.

    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.

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.

    • Key — required — (String)

      The key in a tag.

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

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.

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.

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.

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.