Class: AWS.ChimeSDKMessaging

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MemberArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  SubChannelId: 'STRING_VALUE',
  Type: DEFAULT | HIDDEN
};
chimesdkmessaging.batchCreateChannelMembership(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel to which you're adding users or bots.

  • Type — (String)

    The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

    Possible values include:
    • "DEFAULT"
    • "HIDDEN"
  • MemberArns — (Array<String>)

    The ARNs of the members you want to add to the channel. Only AppInstanceUsers and AppInstanceBots can be added as a channel member.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • SubChannelId — (String)

    The ID of the SubChannel in the request.

    Note: Only required when creating membership in a SubChannel for a moderator in an elastic 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:

    • BatchChannelMemberships — (map)

      The list of channel memberships in the response.

      • InvitedBy — (map)

        The identifier of the member who invited another member.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • Type — (String)

        The membership types set for the channel members.

        Possible values include:
        • "DEFAULT"
        • "HIDDEN"
      • Members — (Array<map>)

        The users successfully added to the request.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • ChannelArn — (String)

        The ARN of the channel to which you're adding members.

      • SubChannelId — (String)

        The ID of the SubChannel.

    • Errors — (Array<map>)

      If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.

      • MemberArn — (String)

        The AppInstanceUserArn of the member that the service couldn't add.

      • ErrorCode — (String)

        The error code.

        Possible values include:
        • "BadRequest"
        • "Conflict"
        • "Forbidden"
        • "NotFound"
        • "PreconditionFailed"
        • "ResourceLimitExceeded"
        • "ServiceFailure"
        • "AccessDenied"
        • "ServiceUnavailable"
        • "Throttled"
        • "Throttling"
        • "Unauthorized"
        • "Unprocessable"
        • "VoiceConnectorGroupAssociationsExist"
        • "PhoneNumberAssociationsExist"
      • ErrorMessage — (String)

        The error message.

Returns:

• (AWS.Request) —

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

var params = {
  CallbackId: 'STRING_VALUE', /* required */
  ChannelArn: 'STRING_VALUE', /* required */
  ChannelMessage: { /* required */
    MessageId: 'STRING_VALUE', /* required */
    Content: 'STRING_VALUE',
    ContentType: 'STRING_VALUE',
    MessageAttributes: {
      '<MessageAttributeName>': {
        StringValues: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* '<MessageAttributeName>': ... */
    },
    Metadata: 'STRING_VALUE',
    PushNotification: {
      Body: 'STRING_VALUE',
      Title: 'STRING_VALUE',
      Type: DEFAULT | VOIP
    },
    SubChannelId: 'STRING_VALUE'
  },
  DeleteResource: true || false
};
chimesdkmessaging.channelFlowCallback(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: {}) —
  • CallbackId — (String)

    The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.

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

    The ARN of the channel.

  • DeleteResource — (Boolean)

    When a processor determines that a message needs to be DENIED, pass this parameter with a value of true.

  • ChannelMessage — (map)

    Stores information about the processed message.

    • MessageId — required — (String)

      The message ID.

    • Content — (String)

      The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

    • Metadata — (String)

      The message metadata.

    • PushNotification — (map)

      The push notification configuration of the message.

      • Title — (String)

        The title of the push notification.

      • Body — (String)

        The body of the push notification.

      • Type — (String)

        Enum value that indicates the type of the push notification for a message. DEFAULT: Normal mobile push notification. VOIP: VOIP mobile push notification.

        Possible values include:
        • "DEFAULT"
        • "VOIP"
    • MessageAttributes — (map<map>)

      The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

      • StringValues — (Array<String>)

        The strings in a message attribute value.

    • SubChannelId — (String)

      The ID of the SubChannel.

    • ContentType — (String)

      The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

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:

    • ChannelArn — (String)

      The ARN of the channel.

    • CallbackId — (String)

      The call back ID passed in the request.

Returns:

• (AWS.Request) —

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

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ChannelId: 'STRING_VALUE',
  ElasticChannelConfiguration: {
    MaximumSubChannels: 'NUMBER_VALUE', /* required */
    MinimumMembershipPercentage: 'NUMBER_VALUE', /* required */
    TargetMembershipsPerSubChannel: 'NUMBER_VALUE' /* required */
  },
  ExpirationSettings: {
    ExpirationCriterion: CREATED_TIMESTAMP | LAST_MESSAGE_TIMESTAMP, /* required */
    ExpirationDays: 'NUMBER_VALUE' /* required */
  },
  MemberArns: [
    'STRING_VALUE',
    /* more items */
  ],
  Metadata: 'STRING_VALUE',
  Mode: UNRESTRICTED | RESTRICTED,
  ModeratorArns: [
    'STRING_VALUE',
    /* more items */
  ],
  Privacy: PUBLIC | PRIVATE,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkmessaging.createChannel(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 channel request.

  • Name — (String)

    The name of the channel.

  • Mode — (String)

    The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

    Possible values include:
    • "UNRESTRICTED"
    • "RESTRICTED"
  • Privacy — (String)

    The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

    Possible values include:
    • "PUBLIC"
    • "PRIVATE"
  • Metadata — (String)

    The metadata of the creation request. Limited to 1KB and UTF-8.

  • ClientRequestToken — (String)

    The client token for the request. An Idempotency token.

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

    The tags for the creation request.

    • Key — required — (String)

      The key in a tag.

    • Value — required — (String)

      The value in a tag.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • ChannelId — (String)

    The ID of the channel in the request.

  • MemberArns — (Array<String>)

    The ARNs of the channel members in the request.

  • ModeratorArns — (Array<String>)

    The ARNs of the channel moderators in the request.

  • ElasticChannelConfiguration — (map)

    The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.

    • MaximumSubChannels — required — (Integer)

      The maximum number of SubChannels that you want to allow in the elastic channel.

    • TargetMembershipsPerSubChannel — required — (Integer)

      The maximum number of members allowed in a SubChannel.

    • MinimumMembershipPercentage — required — (Integer)

      The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.

  • ExpirationSettings — (map)

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

    • ExpirationDays — required — (Integer)

      The period in days after which the system automatically deletes a channel.

    • ExpirationCriterion — required — (String)

      The conditions that must be met for a channel to expire.

      Possible values include:
      • "CREATED_TIMESTAMP"
      • "LAST_MESSAGE_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:

    • ChannelArn — (String)

      The ARN of the channel.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE' /* required */
};
chimesdkmessaging.createChannelBan(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: {}) —
  • ChannelArn — (String)

    The ARN of the ban request.

  • MemberArn — (String)

    The AppInstanceUserArn of the member being banned.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • ChannelArn — (String)

      The ARN of the response to the ban request.

    • Member — (map)

      The ChannelArn and BannedIdentity of the member in the ban response.

      • Arn — (String)

        The ARN in an Identity.

      • Name — (String)

        The name in an Identity.

Returns:

• (AWS.Request) —

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

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Processors: [ /* required */
    {
      Configuration: { /* required */
        Lambda: { /* required */
          InvocationType: ASYNC, /* required */
          ResourceArn: 'STRING_VALUE' /* required */
        }
      },
      ExecutionOrder: 'NUMBER_VALUE', /* required */
      FallbackAction: CONTINUE | ABORT, /* required */
      Name: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkmessaging.createChannelFlow(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 channel flow request.

  • Processors — (Array<map>)

    Information about the processor Lambda functions.

    • Name — required — (String)

      The name of the channel flow.

    • Configuration — required — (map)

      The information about the type of processor and its identifier.

      • Lambda — required — (map)

        Indicates that the processor is of type Lambda.

        • ResourceArn — required — (String)

          The ARN of the Lambda message processing function.

        • InvocationType — required — (String)

          Controls how the Lambda function is invoked.

          Possible values include:
          • "ASYNC"
    • ExecutionOrder — required — (Integer)

      The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.

    • FallbackAction — required — (String)

      Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.

      Possible values include:
      • "CONTINUE"
      • "ABORT"
  • Name — (String)

    The name of the channel flow.

  • Tags — (Array<map>)

    The tags for the creation request.

    • Key — required — (String)

      The key in a tag.

    • Value — required — (String)

      The value in a tag.

  • ClientRequestToken — (String)

    The client token for the request. An Idempotency token.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • ChannelFlowArn — (String)

      The ARN of the channel flow.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE', /* required */
  Type: DEFAULT | HIDDEN, /* required */
  SubChannelId: 'STRING_VALUE'
};
chimesdkmessaging.createChannelMembership(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel to which you're adding users.

  • MemberArn — (String)

    The AppInstanceUserArn of the member you want to add to the channel.

  • Type — (String)

    The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

    Possible values include:
    • "DEFAULT"
    • "HIDDEN"
  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • SubChannelId — (String)

    The ID of the SubChannel in the request.

    Note: Only required when creating membership in a SubChannel for a moderator in an elastic 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:

    • ChannelArn — (String)

      The ARN of the channel.

    • Member — (map)

      The ARN and metadata of the member being added.

      • Arn — (String)

        The ARN in an Identity.

      • Name — (String)

        The name in an Identity.

    • SubChannelId — (String)

      The ID of the SubChannel in the response.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChannelModeratorArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE' /* required */
};
chimesdkmessaging.createChannelModerator(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • ChannelModeratorArn — (String)

    The AppInstanceUserArn of the moderator.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • ChannelArn — (String)

      The ARN of the channel.

    • ChannelModerator — (map)

      The ARNs of the channel and the moderator.

      • Arn — (String)

        The ARN in an Identity.

      • Name — (String)

        The name in an Identity.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE' /* required */
};
chimesdkmessaging.deleteChannel(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel being deleted.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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 = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE' /* required */
};
chimesdkmessaging.deleteChannelBan(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel from which the AppInstanceUser was banned.

  • MemberArn — (String)

    The ARN of the AppInstanceUser that you want to reinstate.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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 = {
  ChannelFlowArn: 'STRING_VALUE' /* required */
};
chimesdkmessaging.deleteChannelFlow(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: {}) —
  • ChannelFlowArn — (String)

    The ARN of the channel flow.

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 = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE', /* required */
  SubChannelId: 'STRING_VALUE'
};
chimesdkmessaging.deleteChannelMembership(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel from which you want to remove the user.

  • MemberArn — (String)

    The AppInstanceUserArn of the member that you're removing from the channel.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • SubChannelId — (String)

    The ID of the SubChannel in the request.

    Note: Only for use by moderators.

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 = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE', /* required */
  SubChannelId: 'STRING_VALUE'
};
chimesdkmessaging.deleteChannelMessage(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • MessageId — (String)

    The ID of the message being deleted.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • SubChannelId — (String)

    The ID of the SubChannel in the request.

    Note: Only required when deleting messages in a SubChannel that the user belongs to.

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 = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChannelModeratorArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE' /* required */
};
chimesdkmessaging.deleteChannelModerator(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • ChannelModeratorArn — (String)

    The AppInstanceUserArn of the moderator being deleted.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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 */
};
chimesdkmessaging.deleteMessagingStreamingConfigurations(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 streaming configurations 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 = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE' /* required */
};
chimesdkmessaging.describeChannel(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • Channel — (map)

      The channel details.

      • Name — (String)

        The name of a channel.

      • ChannelArn — (String)

        The ARN of a channel.

      • Mode — (String)

        The mode of the channel.

        Possible values include:
        • "UNRESTRICTED"
        • "RESTRICTED"
      • Privacy — (String)

        The channel's privacy setting.

        Possible values include:
        • "PUBLIC"
        • "PRIVATE"
      • Metadata — (String)

        The channel's metadata.

      • CreatedBy — (map)

        The AppInstanceUser who created the channel.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • CreatedTimestamp — (Date)

        The time at which the AppInstanceUser created the channel.

      • LastMessageTimestamp — (Date)

        The time at which a member sent the last message in the channel.

      • LastUpdatedTimestamp — (Date)

        The time at which a channel was last updated.

      • ChannelFlowArn — (String)

        The ARN of the channel flow.

      • ElasticChannelConfiguration — (map)

        The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

        • MaximumSubChannels — required — (Integer)

          The maximum number of SubChannels that you want to allow in the elastic channel.

        • TargetMembershipsPerSubChannel — required — (Integer)

          The maximum number of members allowed in a SubChannel.

        • MinimumMembershipPercentage — required — (Integer)

          The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.

      • ExpirationSettings — (map)

        Settings that control when a channel expires.

        • ExpirationDays — required — (Integer)

          The period in days after which the system automatically deletes a channel.

        • ExpirationCriterion — required — (String)

          The conditions that must be met for a channel to expire.

          Possible values include:
          • "CREATED_TIMESTAMP"
          • "LAST_MESSAGE_TIMESTAMP"

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE' /* required */
};
chimesdkmessaging.describeChannelBan(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel from which the user is banned.

  • MemberArn — (String)

    The AppInstanceUserArn of the member being banned.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • ChannelBan — (map)

      The details of the ban.

      • Member — (map)

        The member being banned from the channel.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • ChannelArn — (String)

        The ARN of the channel from which a member is being banned.

      • CreatedTimestamp — (Date)

        The time at which the ban was created.

      • CreatedBy — (map)

        The AppInstanceUser who created the ban.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

Returns:

• (AWS.Request) —

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

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

    The ARN of the channel flow.

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:

    • ChannelFlow — (map)

      The channel flow details.

      • ChannelFlowArn — (String)

        The ARN of the channel flow.

      • Processors — (Array<map>)

        Information about the processor Lambda functions.

        • Name — required — (String)

          The name of the channel flow.

        • Configuration — required — (map)

          The information about the type of processor and its identifier.

          • Lambda — required — (map)

            Indicates that the processor is of type Lambda.

            • ResourceArn — required — (String)

              The ARN of the Lambda message processing function.

            • InvocationType — required — (String)

              Controls how the Lambda function is invoked.

              Possible values include:
              • "ASYNC"
        • ExecutionOrder — required — (Integer)

          The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.

        • FallbackAction — required — (String)

          Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.

          Possible values include:
          • "CONTINUE"
          • "ABORT"
      • Name — (String)

        The name of the channel flow.

      • CreatedTimestamp — (Date)

        The time at which the channel flow was created.

      • LastUpdatedTimestamp — (Date)

        The time at which a channel flow was updated.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE', /* required */
  SubChannelId: 'STRING_VALUE'
};
chimesdkmessaging.describeChannelMembership(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • MemberArn — (String)

    The AppInstanceUserArn of the member.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • SubChannelId — (String)

    The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.

    Note: Only required to get a user’s SubChannel membership details.

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:

    • ChannelMembership — (map)

      The details of the membership.

      • InvitedBy — (map)

        The identifier of the member who invited another member.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • Type — (String)

        The membership type set for the channel member.

        Possible values include:
        • "DEFAULT"
        • "HIDDEN"
      • Member — (map)

        The data of the channel member.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • ChannelArn — (String)

        The ARN of the member's channel.

      • CreatedTimestamp — (Date)

        The time at which the channel membership was created.

      • LastUpdatedTimestamp — (Date)

        The time at which a channel membership was last updated.

      • SubChannelId — (String)

        The ID of the SubChannel that a user belongs to.

Returns:

• (AWS.Request) —

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

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

    The ARN of the channel to which the user belongs.

  • AppInstanceUserArn — (String)

    The ARN of the user or bot in a channel.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • ChannelMembership — (map)

      The channel to which a user belongs.

      • ChannelSummary — (map)

        Returns the channel data for an AppInstance.

        • Name — (String)

          The name of the channel.

        • ChannelArn — (String)

          The ARN of the channel.

        • Mode — (String)

          The mode of the channel.

          Possible values include:
          • "UNRESTRICTED"
          • "RESTRICTED"
        • Privacy — (String)

          The privacy setting of the channel.

          Possible values include:
          • "PUBLIC"
          • "PRIVATE"
        • Metadata — (String)

          The metadata of the channel.

        • LastMessageTimestamp — (Date)

          The time at which the last persistent message visible to the caller in a channel was sent.

      • AppInstanceUserMembershipSummary — (map)

        Returns the channel membership data for an AppInstance.

        • Type — (String)

          The type of ChannelMembership.

          Possible values include:
          • "DEFAULT"
          • "HIDDEN"
        • ReadMarkerTimestamp — (Date)

          The time at which an AppInstanceUser last marked a channel as read.

        • SubChannelId — (String)

          The ID of the SubChannel that the AppInstanceUser is a member of.

Returns:

• (AWS.Request) —

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

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

    The ARN of the moderated channel.

  • AppInstanceUserArn — (String)

    The ARN of the user or bot in the moderated channel.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • Channel — (map)

      The moderated channel.

      • ChannelSummary — (map)

        Summary of the details of a Channel.

        • Name — (String)

          The name of the channel.

        • ChannelArn — (String)

          The ARN of the channel.

        • Mode — (String)

          The mode of the channel.

          Possible values include:
          • "UNRESTRICTED"
          • "RESTRICTED"
        • Privacy — (String)

          The privacy setting of the channel.

          Possible values include:
          • "PUBLIC"
          • "PRIVATE"
        • Metadata — (String)

          The metadata of the channel.

        • LastMessageTimestamp — (Date)

          The time at which the last persistent message visible to the caller in a channel was sent.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChannelModeratorArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE' /* required */
};
chimesdkmessaging.describeChannelModerator(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • ChannelModeratorArn — (String)

    The AppInstanceUserArn of the channel moderator.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • ChannelModerator — (map)

      The details of the channel moderator.

      • Moderator — (map)

        The moderator's data.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • ChannelArn — (String)

        The ARN of the moderator's channel.

      • CreatedTimestamp — (Date)

        The time at which the moderator was created.

      • CreatedBy — (map)

        The AppInstanceUser who created the moderator.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChannelFlowArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE' /* required */
};
chimesdkmessaging.disassociateChannelFlow(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • ChannelFlowArn — (String)

    The ARN of the channel flow.

  • ChimeBearer — (String)

    The AppInstanceUserArn of the user making the API call.

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 = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE' /* required */
};
chimesdkmessaging.getChannelMembershipPreferences(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • MemberArn — (String)

    The AppInstanceUserArn of the member retrieving the preferences.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • ChannelArn — (String)

      The ARN of the channel.

    • Member — (map)

      The details of a user.

      • Arn — (String)

        The ARN in an Identity.

      • Name — (String)

        The name in an Identity.

    • Preferences — (map)

      The channel membership preferences for an AppInstanceUser .

      • PushNotifications — (map)

        The push notification configuration of a message.

        • AllowNotifications — required — (String)

          Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.

          Possible values include:
          • "ALL"
          • "NONE"
          • "FILTERED"
        • FilterRule — (String)

          The simple JSON object used to send a subset of a push notification to the requested member.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE', /* required */
  SubChannelId: 'STRING_VALUE'
};
chimesdkmessaging.getChannelMessage(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • MessageId — (String)

    The ID of the message.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • SubChannelId — (String)

    The ID of the SubChannel in the request.

    Note: Only required when getting messages in a SubChannel that the user belongs to.

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:

    • ChannelMessage — (map)

      The details of and content in the message.

      • ChannelArn — (String)

        The ARN of the channel.

      • MessageId — (String)

        The ID of a message.

      • Content — (String)

        The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

      • Metadata — (String)

        The message metadata.

      • Type — (String)

        The message type.

        Possible values include:
        • "STANDARD"
        • "CONTROL"
      • CreatedTimestamp — (Date)

        The time at which the message was created.

      • LastEditedTimestamp — (Date)

        The time at which a message was edited.

      • LastUpdatedTimestamp — (Date)

        The time at which a message was updated.

      • Sender — (map)

        The message sender.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • Redacted — (Boolean)

        Hides the content of a message.

      • Persistence — (String)

        The persistence setting for a channel message.

        Possible values include:
        • "PERSISTENT"
        • "NON_PERSISTENT"
      • Status — (map)

        The status of the channel message.

        • Value — (String)

          The message status value.

          Possible values include:
          • "SENT"
          • "PENDING"
          • "FAILED"
          • "DENIED"
        • Detail — (String)

          Contains more details about the message status.

      • MessageAttributes — (map<map>)

        The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

        • StringValues — (Array<String>)

          The strings in a message attribute value.

      • SubChannelId — (String)

        The ID of the SubChannel.

      • ContentType — (String)

        The content type of the channel message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

      • Target — (Array<map>)

        The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

        • MemberArn — (String)

          The ARN of the target channel member.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE', /* required */
  SubChannelId: 'STRING_VALUE'
};
chimesdkmessaging.getChannelMessageStatus(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel

  • MessageId — (String)

    The ID of the message.

  • ChimeBearer — (String)

    The AppInstanceUserArn of the user making the API call.

  • SubChannelId — (String)

    The ID of the SubChannel in the request.

    Note: Only required when getting message status in a SubChannel that the user belongs to.

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:

    • Status — (map)

      The message status and details.

      • Value — (String)

        The message status value.

        Possible values include:
        • "SENT"
        • "PENDING"
        • "FAILED"
        • "DENIED"
      • Detail — (String)

        Contains more details about the message status.

Returns:

• (AWS.Request) —

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

var params = {
};
chimesdkmessaging.getMessagingSessionEndpoint(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: {})

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:

    • Endpoint — (map)

      The endpoint returned in the response.

      • Url — (String)

        The endpoint to which you establish a websocket connection.

Returns:

• (AWS.Request) —

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

var params = {
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chimesdkmessaging.getMessagingStreamingConfigurations(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 streaming configurations.

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:

    • StreamingConfigurations — (Array<map>)

      The streaming settings.

      • DataType — required — (String)

        The data type of the configuration.

        Possible values include:
        • "Channel"
        • "ChannelMessage"
      • ResourceArn — required — (String)

        The ARN of the resource in the configuration.

Returns:

• (AWS.Request) —

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

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

    The ARN of the channel.

  • MaxResults — (Integer)

    The maximum number of bans that you want returned.

  • NextToken — (String)

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

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • ChannelArn — (String)

      The ARN of the channel.

    • NextToken — (String)

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

    • ChannelBans — (Array<map>)

      The information for each requested ban.

      • Member — (map)

        The member being banned from a channel.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

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'
};
chimesdkmessaging.listChannelFlows(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 app instance.

  • MaxResults — (Integer)

    The maximum number of channel flows that you want to return.

  • NextToken — (String)

    The token passed by previous API calls until all requested channel flows 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:

    • ChannelFlows — (Array<map>)

      The information about each channel flow.

      • ChannelFlowArn — (String)

        The ARN of the channel flow.

      • Name — (String)

        The name of the channel flow.

      • Processors — (Array<map>)

        Information about the processor Lambda functions.

        • Name — required — (String)

          The name of the channel flow.

        • Configuration — required — (map)

          The information about the type of processor and its identifier.

          • Lambda — required — (map)

            Indicates that the processor is of type Lambda.

            • ResourceArn — required — (String)

              The ARN of the Lambda message processing function.

            • InvocationType — required — (String)

              Controls how the Lambda function is invoked.

              Possible values include:
              • "ASYNC"
        • ExecutionOrder — required — (Integer)

          The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.

        • FallbackAction — required — (String)

          Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.

          Possible values include:
          • "CONTINUE"
          • "ABORT"
    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SubChannelId: 'STRING_VALUE',
  Type: DEFAULT | HIDDEN
};
chimesdkmessaging.listChannelMemberships(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: {}) —
  • ChannelArn — (String)

    The maximum number of channel memberships that you want returned.

  • Type — (String)

    The membership type of a user, DEFAULT or HIDDEN. Default members are returned as part of ListChannelMemberships if no type is specified. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN.

    Possible values include:
    • "DEFAULT"
    • "HIDDEN"
  • MaxResults — (Integer)

    The maximum number of channel memberships that you want returned.

  • NextToken — (String)

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

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • SubChannelId — (String)

    The ID of the SubChannel in the request.

    Note: Only required when listing a user's memberships in a particular sub-channel of an elastic 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:

    • ChannelArn — (String)

      The ARN of the channel.

    • ChannelMemberships — (Array<map>)

      The information for the requested channel memberships.

      • Member — (map)

        A member's summary data.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  ChimeBearer: 'STRING_VALUE', /* required */
  AppInstanceUserArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkmessaging.listChannelMembershipsForAppInstanceUser(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 or bot.

  • MaxResults — (Integer)

    The maximum number of users that you want returned.

  • NextToken — (String)

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

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • ChannelMemberships — (Array<map>)

      The information for the requested channel memberships.

      • ChannelSummary — (map)

        Returns the channel data for an AppInstance.

        • Name — (String)

          The name of the channel.

        • ChannelArn — (String)

          The ARN of the channel.

        • Mode — (String)

          The mode of the channel.

          Possible values include:
          • "UNRESTRICTED"
          • "RESTRICTED"
        • Privacy — (String)

          The privacy setting of the channel.

          Possible values include:
          • "PUBLIC"
          • "PRIVATE"
        • Metadata — (String)

          The metadata of the channel.

        • LastMessageTimestamp — (Date)

          The time at which the last persistent message visible to the caller in a channel was sent.

      • AppInstanceUserMembershipSummary — (map)

        Returns the channel membership data for an AppInstance.

        • Type — (String)

          The type of ChannelMembership.

          Possible values include:
          • "DEFAULT"
          • "HIDDEN"
        • ReadMarkerTimestamp — (Date)

          The time at which an AppInstanceUser last marked a channel as read.

        • SubChannelId — (String)

          The ID of the SubChannel that the AppInstanceUser is a member of.

    • 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 = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  NotAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  NotBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  SortOrder: ASCENDING | DESCENDING,
  SubChannelId: 'STRING_VALUE'
};
chimesdkmessaging.listChannelMessages(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • SortOrder — (String)

    The order in which you want messages sorted. Default is Descending, based on time created.

    Possible values include:
    • "ASCENDING"
    • "DESCENDING"
  • NotBefore — (Date)

    The initial or starting time stamp for your requested messages.

  • NotAfter — (Date)

    The final or ending time stamp for your requested messages.

  • MaxResults — (Integer)

    The maximum number of messages that you want returned.

  • NextToken — (String)

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

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • SubChannelId — (String)

    The ID of the SubChannel in the request.

    Note: Only required when listing the messages in a SubChannel that the user belongs to.

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:

    • ChannelArn — (String)

      The ARN of the channel containing the requested messages.

    • NextToken — (String)

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

    • ChannelMessages — (Array<map>)

      The information about, and content of, each requested message.

      • MessageId — (String)

        The ID of the message.

      • Content — (String)

        The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

      • Metadata — (String)

        The metadata of the message.

      • Type — (String)

        The type of message.

        Possible values include:
        • "STANDARD"
        • "CONTROL"
      • CreatedTimestamp — (Date)

        The time at which the message summary was created.

      • LastUpdatedTimestamp — (Date)

        The time at which a message was last updated.

      • LastEditedTimestamp — (Date)

        The time at which a message was last edited.

      • Sender — (map)

        The message sender.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • Redacted — (Boolean)

        Indicates whether a message was redacted.

      • Status — (map)

        The message status. The status value is SENT for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.

        • Value — (String)

          The message status value.

          Possible values include:
          • "SENT"
          • "PENDING"
          • "FAILED"
          • "DENIED"
        • Detail — (String)

          Contains more details about the message status.

      • MessageAttributes — (map<map>)

        The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

        • StringValues — (Array<String>)

          The strings in a message attribute value.

      • ContentType — (String)

        The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

      • Target — (Array<map>)

        The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

        • MemberArn — (String)

          The ARN of the target channel member.

    • SubChannelId — (String)

      The ID of the SubChannel in the response.

Returns:

• (AWS.Request) —

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

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

    The ARN of the channel.

  • MaxResults — (Integer)

    The maximum number of moderators that you want returned.

  • NextToken — (String)

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

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • ChannelArn — (String)

      The ARN of the channel.

    • NextToken — (String)

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

    • ChannelModerators — (Array<map>)

      The information about and names of each moderator.

      • Moderator — (map)

        The data for a moderator.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

Returns:

• (AWS.Request) —

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

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Privacy: PUBLIC | PRIVATE
};
chimesdkmessaging.listChannels(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.

  • Privacy — (String)

    The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

    Possible values include:
    • "PUBLIC"
    • "PRIVATE"
  • MaxResults — (Integer)

    The maximum number of channels that you want to return.

  • NextToken — (String)

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

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • Channels — (Array<map>)

      The information about each channel.

      • Name — (String)

        The name of the channel.

      • ChannelArn — (String)

        The ARN of the channel.

      • Mode — (String)

        The mode of the channel.

        Possible values include:
        • "UNRESTRICTED"
        • "RESTRICTED"
      • Privacy — (String)

        The privacy setting of the channel.

        Possible values include:
        • "PUBLIC"
        • "PRIVATE"
      • Metadata — (String)

        The metadata of the channel.

      • LastMessageTimestamp — (Date)

        The time at which the last persistent message visible to the caller in a channel was sent.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

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

    The ARN of the channel flow.

  • MaxResults — (Integer)

    The maximum number of channels that you want to return.

  • NextToken — (String)

    The token passed by previous API calls until all requested channels 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:

    • Channels — (Array<map>)

      The information about each channel.

      • Name — (String)

        The name of the channel flow.

      • ChannelArn — (String)

        The ARN of the channel.

      • Mode — (String)

        The mode of the channel.

        Possible values include:
        • "UNRESTRICTED"
        • "RESTRICTED"
      • Privacy — (String)

        The channel's privacy setting.

        Possible values include:
        • "PUBLIC"
        • "PRIVATE"
      • Metadata — (String)

        The channel's metadata.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  ChimeBearer: 'STRING_VALUE', /* required */
  AppInstanceUserArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkmessaging.listChannelsModeratedByAppInstanceUser(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 or bot in the moderated channel.

  • MaxResults — (Integer)

    The maximum number of channels in the request.

  • NextToken — (String)

    The token returned from previous API requests until the number of channels moderated by the user is reached.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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:

    • Channels — (Array<map>)

      The moderated channels in the request.

      • ChannelSummary — (map)

        Summary of the details of a Channel.

        • Name — (String)

          The name of the channel.

        • ChannelArn — (String)

          The ARN of the channel.

        • Mode — (String)

          The mode of the channel.

          Possible values include:
          • "UNRESTRICTED"
          • "RESTRICTED"
        • Privacy — (String)

          The privacy setting of the channel.

          Possible values include:
          • "PUBLIC"
          • "PRIVATE"
        • Metadata — (String)

          The metadata of the channel.

        • LastMessageTimestamp — (Date)

          The time at which the last persistent message visible to the caller in a channel was sent.

    • NextToken — (String)

      The token returned from previous API requests until the number of channels moderated by the user is reached.

Returns:

• (AWS.Request) —

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

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

    The ARN of elastic channel.

  • ChimeBearer — (String)

    The AppInstanceUserArn of the user making the API call.

  • MaxResults — (Integer)

    The maximum number of sub-channels that you want to return.

  • NextToken — (String)

    The token passed by previous API calls until all requested sub-channels 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:

    • ChannelArn — (String)

      The ARN of elastic channel.

    • SubChannels — (Array<map>)

      The information about each sub-channel.

      • SubChannelId — (String)

        The unique ID of a SubChannel.

      • MembershipCount — (Integer)

        The number of members in a SubChannel.

    • NextToken — (String)

      The token passed by previous API calls until all requested sub-channels are returned.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
chimesdkmessaging.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 = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE',
  ExpirationSettings: {
    ExpirationCriterion: CREATED_TIMESTAMP | LAST_MESSAGE_TIMESTAMP, /* required */
    ExpirationDays: 'NUMBER_VALUE' /* required */
  }
};
chimesdkmessaging.putChannelExpirationSettings(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • ExpirationSettings — (map)

    Settings that control the interval after which a channel is deleted.

    • ExpirationDays — required — (Integer)

      The period in days after which the system automatically deletes a channel.

    • ExpirationCriterion — required — (String)

      The conditions that must be met for a channel to expire.

      Possible values include:
      • "CREATED_TIMESTAMP"
      • "LAST_MESSAGE_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:

    • ChannelArn — (String)

      The channel ARN.

    • ExpirationSettings — (map)

      Settings that control the interval after which a channel is deleted.

      • ExpirationDays — required — (Integer)

        The period in days after which the system automatically deletes a channel.

      • ExpirationCriterion — required — (String)

        The conditions that must be met for a channel to expire.

        Possible values include:
        • "CREATED_TIMESTAMP"
        • "LAST_MESSAGE_TIMESTAMP"

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE', /* required */
  Preferences: { /* required */
    PushNotifications: {
      AllowNotifications: ALL | NONE | FILTERED, /* required */
      FilterRule: 'STRING_VALUE'
    }
  }
};
chimesdkmessaging.putChannelMembershipPreferences(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • MemberArn — (String)

    The ARN of the member setting the preferences.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • Preferences — (map)

    The channel membership preferences of an AppInstanceUser .

    • PushNotifications — (map)

      The push notification configuration of a message.

      • AllowNotifications — required — (String)

        Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.

        Possible values include:
        • "ALL"
        • "NONE"
        • "FILTERED"
      • FilterRule — (String)

        The simple JSON object used to send a subset of a push notification to the requested member.

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:

    • ChannelArn — (String)

      The ARN of the channel.

    • Member — (map)

      The details of a user.

      • Arn — (String)

        The ARN in an Identity.

      • Name — (String)

        The name in an Identity.

    • Preferences — (map)

      The ARN and metadata of the member being added.

      • PushNotifications — (map)

        The push notification configuration of a message.

        • AllowNotifications — required — (String)

          Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.

          Possible values include:
          • "ALL"
          • "NONE"
          • "FILTERED"
        • FilterRule — (String)

          The simple JSON object used to send a subset of a push notification to the requested member.

Returns:

• (AWS.Request) —

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

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  StreamingConfigurations: [ /* required */
    {
      DataType: Channel | ChannelMessage, /* required */
      ResourceArn: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkmessaging.putMessagingStreamingConfigurations(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 streaming configuration.

  • StreamingConfigurations — (Array<map>)

    The streaming configurations.

    • DataType — required — (String)

      The data type of the configuration.

      Possible values include:
      • "Channel"
      • "ChannelMessage"
    • ResourceArn — required — (String)

      The ARN of the resource in the configuration.

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:

    • StreamingConfigurations — (Array<map>)

      The requested streaming configurations.

      • DataType — required — (String)

        The data type of the configuration.

        Possible values include:
        • "Channel"
        • "ChannelMessage"
      • ResourceArn — required — (String)

        The ARN of the resource in the configuration.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE', /* required */
  SubChannelId: 'STRING_VALUE'
};
chimesdkmessaging.redactChannelMessage(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel containing the messages that you want to redact.

  • MessageId — (String)

    The ID of the message being redacted.

  • ChimeBearer — (String)

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • SubChannelId — (String)

    The ID of the SubChannel in the request.

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:

    • ChannelArn — (String)

      The ARN of the channel containing the messages that you want to redact.

    • MessageId — (String)

      The ID of the message being redacted.

    • SubChannelId — (String)

      The ID of the SubChannel in the response.

      Note: Only required when redacting messages in a SubChannel that the user belongs to.

Returns:

• (AWS.Request) —

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

var params = {
  Fields: [ /* required */
    {
      Key: MEMBERS, /* required */
      Operator: EQUALS | INCLUDES, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ChimeBearer: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkmessaging.searchChannels(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: {}) —
  • ChimeBearer — (String)

    The AppInstanceUserArn of the user making the API call.

  • Fields — (Array<map>)

    A list of the Field objects in the channel being searched.

    • Key — required — (String)

      An enum value that indicates the key to search the channel on. MEMBERS allows you to search channels based on memberships. You can use it with the EQUALS operator to get channels whose memberships are equal to the specified values, and with the INCLUDES operator to get channels whose memberships include the specified values.

      Possible values include:
      • "MEMBERS"
    • Values — required — (Array<String>)

      The values that you want to search for, a list of strings. The values must be AppInstanceUserArns specified as a list of strings.

      Note: This operation isn't supported for AppInstanceUsers with large number of memberships.
    • Operator — required — (String)

      The operator used to compare field values, currently EQUALS or INCLUDES. Use the EQUALS operator to find channels whose memberships equal the specified values. Use the INCLUDES operator to find channels whose memberships include the specified values.

      Possible values include:
      • "EQUALS"
      • "INCLUDES"
  • MaxResults — (Integer)

    The maximum number of channels that you want returned.

  • NextToken — (String)

    The token returned from previous API requests until the number of channels 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:

    • Channels — (Array<map>)

      A list of the channels in the request.

      • Name — (String)

        The name of the channel.

      • ChannelArn — (String)

        The ARN of the channel.

      • Mode — (String)

        The mode of the channel.

        Possible values include:
        • "UNRESTRICTED"
        • "RESTRICTED"
      • Privacy — (String)

        The privacy setting of the channel.

        Possible values include:
        • "PUBLIC"
        • "PRIVATE"
      • Metadata — (String)

        The metadata of the channel.

      • LastMessageTimestamp — (Date)

        The time at which the last persistent message visible to the caller in a channel was sent.

    • NextToken — (String)

      The token returned from previous API responses until the number of channels is reached.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Content: 'STRING_VALUE', /* required */
  Persistence: PERSISTENT | NON_PERSISTENT, /* required */
  Type: STANDARD | CONTROL, /* required */
  ContentType: 'STRING_VALUE',
  MessageAttributes: {
    '<MessageAttributeName>': {
      StringValues: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<MessageAttributeName>': ... */
  },
  Metadata: 'STRING_VALUE',
  PushNotification: {
    Body: 'STRING_VALUE',
    Title: 'STRING_VALUE',
    Type: DEFAULT | VOIP
  },
  SubChannelId: 'STRING_VALUE',
  Target: [
    {
      MemberArn: 'STRING_VALUE'
    },
    /* more items */
  ]
};
chimesdkmessaging.sendChannelMessage(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: {}) —
  • ChannelArn — (String)

    The ARN of the channel.

  • Content — (String)

    The content of the channel message.

  • Type — (String)

    The type of message, STANDARD or CONTROL.

    STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

    CONTROL messages are limited to 30 bytes and do not contain metadata.

    Possible values include:
    • "STANDARD"
    • "CONTROL"
  • Persistence — (String)

    Boolean that controls whether the message is persisted on the back end. Required.

    Possible values include:
    • "PERSISTENT"
    • "NON_PERSISTENT"
  • Metadata — (String)

    The optional metadata for each message.

  • ClientRequestToken — (String)

    The Idempotency token for each client request.

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

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • PushNotification — (map)

    The push notification configuration of the message.

    • Title — (String)

      The title of the push notification.

    • Body — (String)

      The body of the push notification.

    • Type — (String)

      Enum value that indicates the type of the push notification for a message. DEFAULT: Normal mobile push notification. VOIP: VOIP mobile push notification.

      Possible values include:
      • "DEFAULT"
      • "VOIP"
  • MessageAttributes — (map<map>)

    The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

    • StringValues — (Array<String>)

      The strings in a message attribute value.

  • SubChannelId — (String)

    The ID of the SubChannel in the request.

  • ContentType — (String)

    The content type of the channel message.

  • Target — (Array<map>)

    The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

    • MemberArn — (String)

      The ARN of the target channel member.

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:

    • ChannelArn — (String)

      The ARN of the channel.

    • MessageId — (String)

      The ID string assigned to each message.

    • Status — (map)

      The status of the channel message.

      • Value — (String)

        The message status value.

        Possible values include:
        • "SENT"
        • "PENDING"
        • "FAILED"
        • "DENIED"
      • Detail — (String)

        Contains more details about the message status.

    • SubChannelId — (String)

      The ID of the SubChannel in the response.

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 */
  ]
};
chimesdkmessaging.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.