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 */
  ],
  Tags: [
    {
      TagKey: 'STRING_VALUE', /* required */
      TagValue: 'STRING_VALUE' /* required */
    },
    /* 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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

  • IamRoleArn — (String)

    A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

    For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

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

  • Tags — (Array<map>)

    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

    • TagKey — required — (String)

      The key of the tag.

    • TagValue — required — (String)

      The value of the tag.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • 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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

      • IamRoleArn — required — (String)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

      • SnsTopicArns — required — (Array<String>)

        The Amazon Resource Names (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.

      • Tags — (Array<map>)

        A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

        • TagKey — required — (String)

          The key of the tag.

        • TagValue — required — (String)

          The value of the tag.

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 */
  ],
  Tags: [
    {
      TagKey: 'STRING_VALUE', /* required */
      TagValue: 'STRING_VALUE' /* required */
    },
    /* 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 this 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 Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

  • IamRoleArn — (String)

    A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

    For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

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

  • Tags — (Array<map>)

    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

    • TagKey — required — (String)

      The key of the tag.

    • TagValue — required — (String)

      The value of the tag.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

      • SlackChannelId — required — (String)

        The ID of the Slack channel.

        To get this 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 Amazon Resource Number (ARN) of the SlackChannelConfiguration.

      • IamRoleArn — required — (String)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

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

      • Tags — (Array<map>)

        A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

        • TagKey — required — (String)

          The key of the tag.

        • TagValue — required — (String)

          The value of the tag.

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 Amazon Resource Name (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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity 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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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)

    The Microsoft Teams user ID.

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 Amazon Resource Name (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 Amazon Resource Number (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 Amazon Chime webhooks associated with the account.

      • WebhookDescription — required — (String)

        A description of the webhook. We recommend using the convention RoomName/WebhookName.

        For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.

      • ChatConfigurationArn — required — (String)

        The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.

      • IamRoleArn — required — (String)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

      • SnsTopicArns — required — (Array<String>)

        The Amazon Resource Names (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.

      • Tags — (Array<map>)

        A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

        • TagKey — required — (String)

          The key of the tag.

        • TagValue — required — (String)

          The value of the tag.

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 Amazon Resource Number (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 Amazon Chime.

      • SlackChannelId — required — (String)

        The ID of the Slack channel.

        To get this 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 Amazon Resource Number (ARN) of the SlackChannelConfiguration.

      • IamRoleArn — required — (String)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

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

      • Tags — (Array<map>)

        A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

        • TagKey — required — (String)

          The key of the tag.

        • TagValue — required — (String)

          The value of the tag.

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 Amazon Resource Number (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)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

      • ChatConfigurationArn — required — (String)

        The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identity to delete.

      • 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 ID 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)

        The 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)

      The preferences related to 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 AI technologies for AWS Chatbot.

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 Amazon Resource Number (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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

      • IamRoleArn — required — (String)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

      • SnsTopicArns — required — (Array<String>)

        The Amazon Resource Names (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.

      • Tags — (Array<map>)

        A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

        • TagKey — required — (String)

          The key of the tag.

        • TagValue — required — (String)

          The value of the tag.

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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

      • IamRoleArn — required — (String)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

      • SnsTopicArns — required — (Array<String>)

        The Amazon Resource Names (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.

      • Tags — (Array<map>)

        A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

        • TagKey — required — (String)

          The key of the tag.

        • TagValue — required — (String)

          The value of the tag.

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 are configured with AWS Chatbot.

      • TenantId — required — (String)

        The ID of the Microsoft Teams tenant.

      • TeamId — required — (String)

        The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Number (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)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

      • ChatConfigurationArn — required — (String)

        The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

      • TeamId — required — (String)

        The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.

      • UserId — (String)

        The Microsoft Teams user ID.

      • 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 = {
  ResourceARN: 'STRING_VALUE' /* required */
};
chatbot.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 you specified to list the tags of.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Tags — (Array<map>)

      Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

      • TagKey — required — (String)

        The key of the tag.

      • TagValue — required — (String)

        The value of the tag.

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', /* required */
      TagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chatbot.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 configuration.

  • Tags — (Array<map>)

    A list of tags to apply to the configuration.

    • TagKey — required — (String)

      The key of the tag.

    • TagValue — required — (String)

      The value of the tag.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chatbot.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 value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.

  • TagKeys — (Array<String>)

    TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

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 = {
  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 AI technologies for 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. The data object has the following properties:

    • AccountPreferences — (map)

      Preferences related to 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 AI technologies for AWS Chatbot.

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 Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to update.

  • WebhookDescription — (String)

    A description of the webhook. We recommend using the convention RoomName/WebhookName.

    For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.

  • WebhookUrl — (String)

    The URL for the Amazon Chime webhook.

  • SnsTopicArns — (Array<String>)

    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • IamRoleArn — (String)

    A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

    For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

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

      A Amazon Chime webhook configuration.

      • WebhookDescription — required — (String)

        A description of the webhook. We recommend using the convention RoomName/WebhookName.

        For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.

      • ChatConfigurationArn — required — (String)

        The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.

      • IamRoleArn — required — (String)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

      • SnsTopicArns — required — (Array<String>)

        The Amazon Resource Names (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.

      • Tags — (Array<map>)

        A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

        • TagKey — required — (String)

          The key of the tag.

        • TagValue — required — (String)

          The value of the tag.

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 Amazon Resource Number (ARN) of the TeamsChannelConfiguration to update.

  • ChannelId — (String)

    The ID of the Microsoft Teams channel.

  • ChannelName — (String)

    The name of the Microsoft Teams channel.

  • SnsTopicArns — (Array<String>)

    The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

  • IamRoleArn — (String)

    A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

    For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

  • 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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

      • IamRoleArn — required — (String)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

      • SnsTopicArns — required — (Array<String>)

        The Amazon Resource Names (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.

      • Tags — (Array<map>)

        A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

        • TagKey — required — (String)

          The key of the tag.

        • TagValue — required — (String)

          The value of the tag.

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 Amazon Resource Number (ARN) of the SlackChannelConfiguration to update.

  • SlackChannelId — (String)

    The ID of the Slack channel.

    To get this 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 Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

  • IamRoleArn — (String)

    A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

    For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

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

      • SlackChannelId — required — (String)

        The ID of the Slack channel.

        To get this 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 Amazon Resource Number (ARN) of the SlackChannelConfiguration.

      • IamRoleArn — required — (String)

        A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

        For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

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

      • Tags — (Array<map>)

        A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

        • TagKey — required — (String)

          The key of the tag.

        • TagValue — required — (String)

          The value of the tag.

Returns:

• (AWS.Request) —

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