Class: AWS.Chatbot

var params = {
  ChannelId: 'STRING_VALUE', /* required */
  ConfigurationName: 'STRING_VALUE', /* required */
  IamRoleArn: 'STRING_VALUE', /* required */
  TeamId: 'STRING_VALUE', /* required */
  TenantId: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE',
  GuardrailPolicyArns: [
    'STRING_VALUE',
    /* more items */
  ],
  LoggingLevel: 'STRING_VALUE',
  SnsTopicArns: [
    'STRING_VALUE',
    /* more items */
  ],
  TeamName: 'STRING_VALUE',
  UserAuthorizationRequired: true || false
};
chatbot.createMicrosoftTeamsChannelConfiguration(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: {}) —
  • ChannelId — (String) The ID of the Microsoft Teams channel.
  • ChannelName — (String) The name of the Microsoft Teams channel.
  • TeamId — (String) The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
  • TeamName — (String) The name of the Microsoft Teams Team.
  • TenantId — (String) The ID of the Microsoft Teams tenant.
  • SnsTopicArns — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
  • IamRoleArn — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
  • ConfigurationName — (String) The name of the configuration.
  • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
  • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
  • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat 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:

    • ChannelConfiguration — (map) The configuration for a Microsoft Teams channel configured with AWS Chatbot.
      • ChannelId — required — (String) The ID of the Microsoft Teams channel.
      • ChannelName — (String) The name of the Microsoft Teams channel.
      • TeamId — required — (String) The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
      • TeamName — (String) The name of the Microsoft Teams Team.
      • TenantId — required — (String) The ID of the Microsoft Teams tenant.
      • ChatConfigurationArn — required — (String) The ARN of the MicrosoftTeamsChannelConfiguration.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • SnsTopicArns — required — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
      • ConfigurationName — (String) The name of the configuration.
      • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
      • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
      • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat configuration.

Returns:

• (AWS.Request) —

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

var params = {
  ConfigurationName: 'STRING_VALUE', /* required */
  IamRoleArn: 'STRING_VALUE', /* required */
  SlackChannelId: 'STRING_VALUE', /* required */
  SlackTeamId: 'STRING_VALUE', /* required */
  GuardrailPolicyArns: [
    'STRING_VALUE',
    /* more items */
  ],
  LoggingLevel: 'STRING_VALUE',
  SlackChannelName: 'STRING_VALUE',
  SnsTopicArns: [
    'STRING_VALUE',
    /* more items */
  ],
  UserAuthorizationRequired: true || false
};
chatbot.createSlackChannelConfiguration(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: {}) —
  • SlackTeamId — (String) The ID of the Slack workspace authorized with AWS Chatbot.
  • SlackChannelId — (String) The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
  • SlackChannelName — (String) The name of the Slack Channel.
  • SnsTopicArns — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
  • IamRoleArn — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
  • ConfigurationName — (String) The name of the configuration.
  • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
  • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
  • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat 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:

    • ChannelConfiguration — (map) The configuration for a Slack channel configured with AWS Chatbot.
      • SlackTeamName — required — (String) Name of the Slack Workspace.
      • SlackTeamId — required — (String) The ID of the Slack workspace authorized with AWS Chatbot.
      • SlackChannelId — required — (String) The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
      • SlackChannelName — required — (String) The name of the Slack Channel.
      • ChatConfigurationArn — required — (String) The ARN of the SlackChannelConfiguration.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • SnsTopicArns — required — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
      • ConfigurationName — (String) The name of the configuration.
      • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
      • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
      • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat configuration.

Returns:

• (AWS.Request) —

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

var params = {
  ChatConfigurationArn: 'STRING_VALUE' /* required */
};
chatbot.deleteChimeWebhookConfiguration(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the ChimeWebhookConfiguration to delete.

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 = {
  ChatConfigurationArn: 'STRING_VALUE' /* required */
};
chatbot.deleteMicrosoftTeamsChannelConfiguration(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the MicrosoftTeamsChannelConfiguration to delete.

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 = {
  TeamId: 'STRING_VALUE' /* required */
};
chatbot.deleteMicrosoftTeamsConfiguredTeam(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: {}) —
  • TeamId — (String) The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator 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.

Returns:

• (AWS.Request) —

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

var params = {
  ChatConfigurationArn: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chatbot.deleteMicrosoftTeamsUserIdentity(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
  • UserId — (String) Id from Microsoft Teams for 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 = {
  ChatConfigurationArn: 'STRING_VALUE' /* required */
};
chatbot.deleteSlackChannelConfiguration(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the SlackChannelConfiguration to delete.

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 = {
  ChatConfigurationArn: 'STRING_VALUE', /* required */
  SlackTeamId: 'STRING_VALUE', /* required */
  SlackUserId: 'STRING_VALUE' /* required */
};
chatbot.deleteSlackUserIdentity(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the SlackChannelConfiguration associated with the user identity to delete.
  • SlackTeamId — (String) The ID of the Slack workspace authorized with AWS Chatbot.
  • SlackUserId — (String) The ID of the user in Slack.

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 = {
  SlackTeamId: 'STRING_VALUE' /* required */
};
chatbot.deleteSlackWorkspaceAuthorization(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: {}) —
  • SlackTeamId — (String) The ID of the Slack workspace authorized with AWS Chatbot.

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 = {
  ChatConfigurationArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chatbot.describeChimeWebhookConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer) The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
  • ChatConfigurationArn — (String) An optional ARN of a ChimeWebhookConfiguration to describe.

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:

    • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
    • WebhookConfigurations — (Array<map>) A list of Chime webhooks associated with the account.
      • WebhookDescription — required — (String) Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
      • ChatConfigurationArn — required — (String) The ARN of the ChimeWebhookConfiguration.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • SnsTopicArns — required — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
      • ConfigurationName — (String) The name of the configuration.
      • LoggingLevel — (String) Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.

Returns:

• (AWS.Request) —

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

var params = {
  ChatConfigurationArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chatbot.describeSlackChannelConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer) The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
  • ChatConfigurationArn — (String) An optional ARN of a SlackChannelConfiguration to describe.

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:

    • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
    • SlackChannelConfigurations — (Array<map>) A list of Slack channel configurations.
      • SlackTeamName — required — (String) Name of the Slack Workspace.
      • SlackTeamId — required — (String) The ID of the Slack workspace authorized with AWS Chatbot.
      • SlackChannelId — required — (String) The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
      • SlackChannelName — required — (String) The name of the Slack Channel.
      • ChatConfigurationArn — required — (String) The ARN of the SlackChannelConfiguration.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • SnsTopicArns — required — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
      • ConfigurationName — (String) The name of the configuration.
      • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
      • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
      • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat configuration.

Returns:

• (AWS.Request) —

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

var params = {
  ChatConfigurationArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chatbot.describeSlackUserIdentities(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the SlackChannelConfiguration associated with the user identities to describe.
  • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
  • MaxResults — (Integer) The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can 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:

    • SlackUserIdentities — (Array<map>) A list of Slack User Identities.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • ChatConfigurationArn — required — (String) The ARN of the SlackChannelConfiguration associated with the user identity.
      • SlackTeamId — required — (String) The ID of the Slack workspace authorized with AWS Chatbot.
      • SlackUserId — required — (String) The ID of the user in Slack.
      • AwsUserIdentity — (String) The AWS user identity ARN used to associate a Slack User Identity with an IAM Role.
    • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chatbot.describeSlackWorkspaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer) The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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:

    • SlackWorkspaces — (Array<map>) A list of Slack Workspaces registered with AWS Chatbot.
      • SlackTeamId — required — (String) The ID of the Slack workspace authorized with AWS Chatbot.
      • SlackTeamName — required — (String) Name of the Slack Workspace.
    • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Returns:

• (AWS.Request) —

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

var params = {
};
chatbot.getAccountPreferences(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:

    • AccountPreferences — (map) Preferences which apply for AWS Chatbot usage in the calling AWS account.
      • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat configuration.
      • TrainingDataCollectionEnabled — (Boolean) Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AWS Chatbot’s AI technologies.

Returns:

• (AWS.Request) —

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

var params = {
  ChatConfigurationArn: 'STRING_VALUE' /* required */
};
chatbot.getMicrosoftTeamsChannelConfiguration(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.

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:

    • ChannelConfiguration — (map) The configuration for a Microsoft Teams channel configured with AWS Chatbot.
      • ChannelId — required — (String) The ID of the Microsoft Teams channel.
      • ChannelName — (String) The name of the Microsoft Teams channel.
      • TeamId — required — (String) The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
      • TeamName — (String) The name of the Microsoft Teams Team.
      • TenantId — required — (String) The ID of the Microsoft Teams tenant.
      • ChatConfigurationArn — required — (String) The ARN of the MicrosoftTeamsChannelConfiguration.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • SnsTopicArns — required — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
      • ConfigurationName — (String) The name of the configuration.
      • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
      • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
      • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat configuration.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  TeamId: 'STRING_VALUE'
};
chatbot.listMicrosoftTeamsChannelConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer) The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
  • TeamId — (String) The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator 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:

    • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
    • TeamChannelConfigurations — (Array<map>) A list of AWS Chatbot channel configurations for Microsoft Teams.
      • ChannelId — required — (String) The ID of the Microsoft Teams channel.
      • ChannelName — (String) The name of the Microsoft Teams channel.
      • TeamId — required — (String) The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
      • TeamName — (String) The name of the Microsoft Teams Team.
      • TenantId — required — (String) The ID of the Microsoft Teams tenant.
      • ChatConfigurationArn — required — (String) The ARN of the MicrosoftTeamsChannelConfiguration.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • SnsTopicArns — required — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
      • ConfigurationName — (String) The name of the configuration.
      • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
      • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
      • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat configuration.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chatbot.listMicrosoftTeamsConfiguredTeams(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer) The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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:

    • ConfiguredTeams — (Array<map>) A list of teams in Microsoft Teams that have been configured with AWS Chatbot.
      • TenantId — required — (String) The ID of the Microsoft Teams tenant.
      • TeamId — required — (String) The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
      • TeamName — (String) The name of the Microsoft Teams Team.
    • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Returns:

• (AWS.Request) —

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

var params = {
  ChatConfigurationArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chatbot.listMicrosoftTeamsUserIdentities(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.
  • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
  • MaxResults — (Integer) The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can 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:

    • TeamsUserIdentities — (Array<map>) User level permissions associated to a channel configuration.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • ChatConfigurationArn — required — (String) The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity.
      • TeamId — required — (String) The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
      • UserId — (String) Id from Microsoft Teams for user.
      • AwsUserIdentity — (String) The AWS user identity ARN used to associate a Microsoft Teams User Identity with an IAM Role.
      • TeamsChannelId — (String) The ID of the Microsoft Teams channel.
      • TeamsTenantId — (String) The ID of the Microsoft Teams tenant.
    • NextToken — (String) An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Returns:

• (AWS.Request) —

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

var params = {
  TrainingDataCollectionEnabled: true || false,
  UserAuthorizationRequired: true || false
};
chatbot.updateAccountPreferences(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: {}) —
  • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat configuration.
  • TrainingDataCollectionEnabled — (Boolean) Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AWS Chatbot’s AI technologies.

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:

    • AccountPreferences — (map) Preferences which apply for AWS Chatbot usage in the calling AWS account.
      • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat configuration.
      • TrainingDataCollectionEnabled — (Boolean) Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AWS Chatbot’s AI technologies.

Returns:

• (AWS.Request) —

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

var params = {
  ChatConfigurationArn: 'STRING_VALUE', /* required */
  IamRoleArn: 'STRING_VALUE',
  LoggingLevel: 'STRING_VALUE',
  SnsTopicArns: [
    'STRING_VALUE',
    /* more items */
  ],
  WebhookDescription: 'STRING_VALUE',
  WebhookUrl: 'STRING_VALUE'
};
chatbot.updateChimeWebhookConfiguration(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the ChimeWebhookConfiguration to update.
  • WebhookDescription — (String) Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
  • WebhookUrl — (String) URL for the Chime webhook.
  • SnsTopicArns — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
  • IamRoleArn — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
  • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • WebhookConfiguration — (map) Chime webhook configuration.
      • WebhookDescription — required — (String) Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
      • ChatConfigurationArn — required — (String) The ARN of the ChimeWebhookConfiguration.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • SnsTopicArns — required — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
      • ConfigurationName — (String) The name of the configuration.
      • LoggingLevel — (String) Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelId: 'STRING_VALUE', /* required */
  ChatConfigurationArn: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE',
  GuardrailPolicyArns: [
    'STRING_VALUE',
    /* more items */
  ],
  IamRoleArn: 'STRING_VALUE',
  LoggingLevel: 'STRING_VALUE',
  SnsTopicArns: [
    'STRING_VALUE',
    /* more items */
  ],
  UserAuthorizationRequired: true || false
};
chatbot.updateMicrosoftTeamsChannelConfiguration(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the MicrosoftTeamsChannelConfiguration to update.
  • ChannelId — (String) The ID of the Microsoft Teams channel.
  • ChannelName — (String) The name of the Microsoft Teams channel.
  • SnsTopicArns — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
  • IamRoleArn — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
  • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
  • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
  • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat 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:

    • ChannelConfiguration — (map) The configuration for a Microsoft Teams channel configured with AWS Chatbot.
      • ChannelId — required — (String) The ID of the Microsoft Teams channel.
      • ChannelName — (String) The name of the Microsoft Teams channel.
      • TeamId — required — (String) The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
      • TeamName — (String) The name of the Microsoft Teams Team.
      • TenantId — required — (String) The ID of the Microsoft Teams tenant.
      • ChatConfigurationArn — required — (String) The ARN of the MicrosoftTeamsChannelConfiguration.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • SnsTopicArns — required — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
      • ConfigurationName — (String) The name of the configuration.
      • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
      • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
      • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat configuration.

Returns:

• (AWS.Request) —

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

var params = {
  ChatConfigurationArn: 'STRING_VALUE', /* required */
  SlackChannelId: 'STRING_VALUE', /* required */
  GuardrailPolicyArns: [
    'STRING_VALUE',
    /* more items */
  ],
  IamRoleArn: 'STRING_VALUE',
  LoggingLevel: 'STRING_VALUE',
  SlackChannelName: 'STRING_VALUE',
  SnsTopicArns: [
    'STRING_VALUE',
    /* more items */
  ],
  UserAuthorizationRequired: true || false
};
chatbot.updateSlackChannelConfiguration(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: {}) —
  • ChatConfigurationArn — (String) The ARN of the SlackChannelConfiguration to update.
  • SlackChannelId — (String) The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
  • SlackChannelName — (String) The name of the Slack Channel.
  • SnsTopicArns — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
  • IamRoleArn — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
  • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
  • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
  • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat 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:

    • ChannelConfiguration — (map) The configuration for a Slack channel configured with AWS Chatbot.
      • SlackTeamName — required — (String) Name of the Slack Workspace.
      • SlackTeamId — required — (String) The ID of the Slack workspace authorized with AWS Chatbot.
      • SlackChannelId — required — (String) The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
      • SlackChannelName — required — (String) The name of the Slack Channel.
      • ChatConfigurationArn — required — (String) The ARN of the SlackChannelConfiguration.
      • IamRoleArn — required — (String) The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
      • SnsTopicArns — required — (Array<String>) The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
      • ConfigurationName — (String) The name of the configuration.
      • LoggingLevel — (String) Logging levels include ERROR, INFO, or NONE.
      • GuardrailPolicyArns — (Array<String>) The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
      • UserAuthorizationRequired — (Boolean) Enables use of a user role requirement in your chat configuration.

Returns:

• (AWS.Request) —

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