Class: AWS.Ivschat

var params = {
  destinationConfiguration: { /* required */
    cloudWatchLogs: {
      logGroupName: 'STRING_VALUE' /* required */
    },
    firehose: {
      deliveryStreamName: 'STRING_VALUE' /* required */
    },
    s3: {
      bucketName: 'STRING_VALUE' /* required */
    }
  },
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivschat.createLoggingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    Logging-configuration name. The value does not need to be unique.

  • destinationConfiguration — (map)

    A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

    • s3 — (map)

      An Amazon S3 destination configuration where chat activity will be logged.

      • bucketName — required — (String)

        Name of the Amazon S3 bucket where chat activity will be logged.

    • cloudWatchLogs — (map)

      An Amazon CloudWatch Logs destination configuration where chat activity will be logged.

      • logGroupName — required — (String)

        Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.

    • firehose — (map)

      An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.

      • deliveryStreamName — required — (String)

        Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.

  • tags — (map<String>)

    Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented there.

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:

    • arn — (String)

      Logging-configuration ARN, assigned by the system.

    • id — (String)

      Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.

    • createTime — (Date)

      Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.

    • updateTime — (Date)

      Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

    • name — (String)

      Logging-configuration name, from the request (if specified).

    • destinationConfiguration — (map)

      A complex type that contains a destination configuration for where chat content will be logged, from the request. There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

      • s3 — (map)

        An Amazon S3 destination configuration where chat activity will be logged.

        • bucketName — required — (String)

          Name of the Amazon S3 bucket where chat activity will be logged.

      • cloudWatchLogs — (map)

        An Amazon CloudWatch Logs destination configuration where chat activity will be logged.

        • logGroupName — required — (String)

          Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.

      • firehose — (map)

        An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.

        • deliveryStreamName — required — (String)

          Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.

    • state — (String)

      The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.

      Possible values include:
      • "ACTIVE"
    • tags — (map<String>)

      Tags attached to the resource, from the request (if specified). Array of maps, each of the form string:string (key:value).

Returns:

• (AWS.Request) —

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

var params = {
  loggingConfigurationIdentifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  maximumMessageLength: 'NUMBER_VALUE',
  maximumMessageRatePerSecond: 'NUMBER_VALUE',
  messageReviewHandler: {
    fallbackResult: ALLOW | DENY,
    uri: 'STRING_VALUE'
  },
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivschat.createRoom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    Room name. The value does not need to be unique.

  • maximumMessageRatePerSecond — (Integer)

    Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

  • maximumMessageLength — (Integer)

    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

  • messageReviewHandler — (map)

    Configuration information for optional review of messages.

    • uri — (String)

      Identifier of the message review handler. Currently this must be an ARN of a lambda function.

    • fallbackResult — (String)

      Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.

      Possible values include:
      • "ALLOW"
      • "DENY"
  • tags — (map<String>)

    Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

  • loggingConfigurationIdentifiers — (Array<String>)

    Array of logging-configuration identifiers attached to the room.

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:

    • arn — (String)

      Room ARN, assigned by the system.

    • id — (String)

      Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

    • name — (String)

      Room name, from the request (if specified).

    • createTime — (Date)

      Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

    • updateTime — (Date)

      Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

    • maximumMessageRatePerSecond — (Integer)

      Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).

    • maximumMessageLength — (Integer)

      Maximum number of characters in a single message, from the request (if specified).

    • messageReviewHandler — (map)

      Configuration information for optional review of messages.

      • uri — (String)

        Identifier of the message review handler. Currently this must be an ARN of a lambda function.

      • fallbackResult — (String)

        Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.

        Possible values include:
        • "ALLOW"
        • "DENY"
    • tags — (map<String>)

      Tags attached to the resource, from the request (if specified).

    • loggingConfigurationIdentifiers — (Array<String>)

      Array of logging configurations attached to the room, from the request (if specified).

Returns:

• (AWS.Request) —

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

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

    Identifier of the logging configuration to be 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 = {
  id: 'STRING_VALUE', /* required */
  roomIdentifier: 'STRING_VALUE', /* required */
  reason: 'STRING_VALUE'
};
ivschat.deleteMessage(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: {}) —
  • roomIdentifier — (String)

    Identifier of the room where the message should be deleted. Currently this must be an ARN.

  • id — (String)

    ID of the message to be deleted. This is the Id field in the received message (see Message (Subscribe) in the Chat Messaging API).

  • reason — (String)

    Reason for deleting the message.

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:

    • id — (String)

      Operation identifier, generated by Amazon IVS Chat.

Returns:

• (AWS.Request) —

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

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

    Identifier of the room to be deleted. Currently this must be an ARN.

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 = {
  roomIdentifier: 'STRING_VALUE', /* required */
  userId: 'STRING_VALUE', /* required */
  reason: 'STRING_VALUE'
};
ivschat.disconnectUser(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: {}) —
  • roomIdentifier — (String)

    Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.

  • userId — (String)

    ID of the user (connection) to disconnect from the room.

  • reason — (String)

    Reason for disconnecting the user.

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

    Identifier of the logging configuration to be retrieved.

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:

    • arn — (String)

      Logging-configuration ARN, from the request (if identifier was an ARN).

    • id — (String)

      Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.

    • createTime — (Date)

      Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.

    • updateTime — (Date)

      Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

    • name — (String)

      Logging-configuration name. This value does not need to be unique.

    • destinationConfiguration — (map)

      A complex type that contains a destination configuration for where chat content will be logged. There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

      • s3 — (map)

        An Amazon S3 destination configuration where chat activity will be logged.

        • bucketName — required — (String)

          Name of the Amazon S3 bucket where chat activity will be logged.

      • cloudWatchLogs — (map)

        An Amazon CloudWatch Logs destination configuration where chat activity will be logged.

        • logGroupName — required — (String)

          Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.

      • firehose — (map)

        An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.

        • deliveryStreamName — required — (String)

          Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.

    • state — (String)

      The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.

      Possible values include:
      • "CREATING"
      • "CREATE_FAILED"
      • "DELETING"
      • "DELETE_FAILED"
      • "UPDATING"
      • "UPDATE_FAILED"
      • "ACTIVE"
    • tags — (map<String>)

      Tags attached to the resource. Array of maps, each of the form string:string (key:value).

Returns:

• (AWS.Request) —

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

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

    Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.

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:

    • arn — (String)

      Room ARN, from the request (if identifier was an ARN).

    • id — (String)

      Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

    • name — (String)

      Room name. The value does not need to be unique.

    • createTime — (Date)

      Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

    • updateTime — (Date)

      Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

    • maximumMessageRatePerSecond — (Integer)

      Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

    • maximumMessageLength — (Integer)

      Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

    • messageReviewHandler — (map)

      Configuration information for optional review of messages.

      • uri — (String)

        Identifier of the message review handler. Currently this must be an ARN of a lambda function.

      • fallbackResult — (String)

        Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.

        Possible values include:
        • "ALLOW"
        • "DENY"
    • tags — (map<String>)

      Tags attached to the resource. Array of maps, each of the form string:string (key:value).

    • loggingConfigurationIdentifiers — (Array<String>)

      Array of logging configurations attached to the room.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivschat.listLoggingConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The first logging configurations to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults — (Integer)

    Maximum number of logging configurations to return. Default: 50.

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:

    • loggingConfigurations — (Array<map>)

      List of the matching logging configurations (summary information only). There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

      • arn — (String)

        Logging-configuration ARN.

      • id — (String)

        Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

      • createTime — (Date)

        Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.

      • updateTime — (Date)

        Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

      • name — (String)

        Logging-configuration name. The value does not need to be unique.

      • destinationConfiguration — (map)

        A complex type that contains a destination configuration for where chat content will be logged.

        • s3 — (map)

          An Amazon S3 destination configuration where chat activity will be logged.

          • bucketName — required — (String)

            Name of the Amazon S3 bucket where chat activity will be logged.

        • cloudWatchLogs — (map)

          An Amazon CloudWatch Logs destination configuration where chat activity will be logged.

          • logGroupName — required — (String)

            Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.

        • firehose — (map)

          An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.

          • deliveryStreamName — required — (String)

            Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.

      • state — (String)

        The state of the logging configuration. When this is ACTIVE, the configuration is ready for logging chat content.

        Possible values include:
        • "CREATING"
        • "CREATE_FAILED"
        • "DELETING"
        • "DELETE_FAILED"
        • "UPDATING"
        • "UPDATE_FAILED"
        • "ACTIVE"
      • tags — (map<String>)

        Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented there.

    • nextToken — (String)

      If there are more logging configurations than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

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

var params = {
  loggingConfigurationIdentifier: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  messageReviewHandlerUri: 'STRING_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
ivschat.listRooms(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    Filters the list to match the specified room name.

  • nextToken — (String)

    The first room to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults — (Integer)

    Maximum number of rooms to return. Default: 50.

  • messageReviewHandlerUri — (String)

    Filters the list to match the specified message review handler URI.

  • loggingConfigurationIdentifier — (String)

    Logging-configuration identifier.

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:

    • rooms — (Array<map>)

      List of the matching rooms (summary information only).

      • arn — (String)

        Room ARN.

      • id — (String)

        Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

      • name — (String)

        Room name. The value does not need to be unique.

      • messageReviewHandler — (map)

        Configuration information for optional review of messages.

        • uri — (String)

          Identifier of the message review handler. Currently this must be an ARN of a lambda function.

        • fallbackResult — (String)

          Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.

          Possible values include:
          • "ALLOW"
          • "DENY"
      • createTime — (Date)

        Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

      • updateTime — (Date)

        Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

      • loggingConfigurationIdentifiers — (Array<String>)

        List of logging-configuration identifiers attached to the room.

    • nextToken — (String)

      If there are more rooms than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
ivschat.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 to be retrieved. The ARN must be URL-encoded.

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 — (map<String>)

      Tags attached to the resource. Array of maps, each of the form string:string (key:value).

Returns:

• (AWS.Request) —

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

var params = {
  eventName: 'STRING_VALUE', /* required */
  roomIdentifier: 'STRING_VALUE', /* required */
  attributes: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
ivschat.sendEvent(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: {}) —
  • roomIdentifier — (String)

    Identifier of the room to which the event will be sent. Currently this must be an ARN.

  • eventName — (String)

    Application-defined name of the event to send to clients.

  • attributes — (map<String>)

    Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.

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:

    • id — (String)

      An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivschat.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 ARN of the resource to be tagged. The ARN must be URL-encoded.

  • tags — (map<String>)

    Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ivschat.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource to be untagged. The ARN must be URL-encoded.

  • tagKeys — (Array<String>)

    Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

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 = {
  identifier: 'STRING_VALUE', /* required */
  destinationConfiguration: {
    cloudWatchLogs: {
      logGroupName: 'STRING_VALUE' /* required */
    },
    firehose: {
      deliveryStreamName: 'STRING_VALUE' /* required */
    },
    s3: {
      bucketName: 'STRING_VALUE' /* required */
    }
  },
  name: 'STRING_VALUE'
};
ivschat.updateLoggingConfiguration(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: {}) —
  • identifier — (String)

    Identifier of the logging configuration to be updated.

  • name — (String)

    Logging-configuration name. The value does not need to be unique.

  • destinationConfiguration — (map)

    A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

    • s3 — (map)

      An Amazon S3 destination configuration where chat activity will be logged.

      • bucketName — required — (String)

        Name of the Amazon S3 bucket where chat activity will be logged.

    • cloudWatchLogs — (map)

      An Amazon CloudWatch Logs destination configuration where chat activity will be logged.

      • logGroupName — required — (String)

        Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.

    • firehose — (map)

      An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.

      • deliveryStreamName — required — (String)

        Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.

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:

    • arn — (String)

      Logging-configuration ARN, from the request (if identifier was an ARN).

    • id — (String)

      Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

    • createTime — (Date)

      Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.

    • updateTime — (Date)

      Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

    • name — (String)

      Logging-configuration name, from the request (if specified).

    • destinationConfiguration — (map)

      A complex type that contains a destination configuration for where chat content will be logged, from the request. There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

      • s3 — (map)

        An Amazon S3 destination configuration where chat activity will be logged.

        • bucketName — required — (String)

          Name of the Amazon S3 bucket where chat activity will be logged.

      • cloudWatchLogs — (map)

        An Amazon CloudWatch Logs destination configuration where chat activity will be logged.

        • logGroupName — required — (String)

          Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.

      • firehose — (map)

        An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.

        • deliveryStreamName — required — (String)

          Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.

    • state — (String)

      The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.

      Possible values include:
      • "ACTIVE"
    • tags — (map<String>)

      Tags attached to the resource. Array of maps, each of the form string:string (key:value).

Returns:

• (AWS.Request) —

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

var params = {
  identifier: 'STRING_VALUE', /* required */
  loggingConfigurationIdentifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  maximumMessageLength: 'NUMBER_VALUE',
  maximumMessageRatePerSecond: 'NUMBER_VALUE',
  messageReviewHandler: {
    fallbackResult: ALLOW | DENY,
    uri: 'STRING_VALUE'
  },
  name: 'STRING_VALUE'
};
ivschat.updateRoom(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: {}) —
  • identifier — (String)

    Identifier of the room to be updated. Currently this must be an ARN.

  • name — (String)

    Room name. The value does not need to be unique.

  • maximumMessageRatePerSecond — (Integer)

    Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

  • maximumMessageLength — (Integer)

    The maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

  • messageReviewHandler — (map)

    Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.

    • uri — (String)

      Identifier of the message review handler. Currently this must be an ARN of a lambda function.

    • fallbackResult — (String)

      Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.

      Possible values include:
      • "ALLOW"
      • "DENY"
  • loggingConfigurationIdentifiers — (Array<String>)

    Array of logging-configuration identifiers attached to the room.

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:

    • arn — (String)

      Room ARN, from the request (if identifier was an ARN).

    • id — (String)

      Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

    • name — (String)

      Room name, from the request (if specified).

    • createTime — (Date)

      Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

    • updateTime — (Date)

      Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

    • maximumMessageRatePerSecond — (Integer)

      Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).

    • maximumMessageLength — (Integer)

      Maximum number of characters in a single message, from the request (if specified).

    • messageReviewHandler — (map)

      Configuration information for optional review of messages.

      • uri — (String)

        Identifier of the message review handler. Currently this must be an ARN of a lambda function.

      • fallbackResult — (String)

        Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.

        Possible values include:
        • "ALLOW"
        • "DENY"
    • tags — (map<String>)

      Tags attached to the resource. Array of maps, each of the form string:string (key:value).

    • loggingConfigurationIdentifiers — (Array<String>)

      Array of logging configurations attached to the room, from the request (if specified).

Returns:

• (AWS.Request) —

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

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

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