Class: AWS.Chatbot
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Chatbot
- Identifier:
- chatbot
- API Version:
- 2017-10-11
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
AWS Chatbot API
Sending a Request Using Chatbot
var chatbot = new AWS.Chatbot();
chatbot.createChimeWebhookConfiguration(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Chatbot object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var chatbot = new AWS.Chatbot({apiVersion: '2017-10-11'});
You can also set the API version globally in AWS.config.apiVersions
using
the chatbot service identifier:
AWS.config.apiVersions = {
chatbot: '2017-10-11',
// other service API versions
};
var chatbot = new AWS.Chatbot();
Version:
-
2017-10-11
Constructor Summary collapse
-
new AWS.Chatbot(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createChimeWebhookConfiguration(params = {}, callback) ⇒ AWS.Request
Creates Chime Webhook Configuration.
-
createMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Creates MS Teams Channel Configuration.
-
createSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Creates Slack Channel Configuration.
-
deleteChimeWebhookConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes a Chime Webhook Configuration.
-
deleteMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes MS Teams Channel Configuration.
-
deleteMicrosoftTeamsConfiguredTeam(params = {}, callback) ⇒ AWS.Request
Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team.
-
deleteMicrosoftTeamsUserIdentity(params = {}, callback) ⇒ AWS.Request
Deletes a Teams user identity.
-
deleteSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes Slack Channel Configuration.
-
deleteSlackUserIdentity(params = {}, callback) ⇒ AWS.Request
Deletes a Slack user identity.
-
deleteSlackWorkspaceAuthorization(params = {}, callback) ⇒ AWS.Request
Deletes the Slack workspace authorization that allows channels to be configured in that workspace.
-
describeChimeWebhookConfigurations(params = {}, callback) ⇒ AWS.Request
Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn.
-
describeSlackChannelConfigurations(params = {}, callback) ⇒ AWS.Request
Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn.
-
describeSlackUserIdentities(params = {}, callback) ⇒ AWS.Request
Lists all Slack user identities with a mapped role.
-
describeSlackWorkspaces(params = {}, callback) ⇒ AWS.Request
Lists all authorized Slack Workspaces for AWS Account.
-
getAccountPreferences(params = {}, callback) ⇒ AWS.Request
Get Chatbot account level preferences.
-
getMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Get a single MS Teams Channel Configurations.
-
listMicrosoftTeamsChannelConfigurations(params = {}, callback) ⇒ AWS.Request
Lists MS Teams Channel Configurations optionally filtered by TeamId.
-
listMicrosoftTeamsConfiguredTeams(params = {}, callback) ⇒ AWS.Request
Lists all authorized MS teams for AWS Account.
-
listMicrosoftTeamsUserIdentities(params = {}, callback) ⇒ AWS.Request
Lists all Microsoft Teams user identities with a mapped role.
-
updateAccountPreferences(params = {}, callback) ⇒ AWS.Request
Update Chatbot account level preferences.
-
updateChimeWebhookConfiguration(params = {}, callback) ⇒ AWS.Request
Updates a Chime Webhook Configuration.
-
updateMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Updates MS Teams Channel Configuration.
-
updateSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Updates Slack Channel Configuration.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.Chatbot(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a Chatbot object
var chatbot = new AWS.Chatbot({apiVersion: '2017-10-11'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.Chatbot.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.Chatbot.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.Chatbot.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
Method Details
createChimeWebhookConfiguration(params = {}, callback) ⇒ AWS.Request
Creates Chime Webhook Configuration
Service Reference:
Examples:
Calling the createChimeWebhookConfiguration operation
var params = {
ConfigurationName: 'STRING_VALUE', /* required */
IamRoleArn: 'STRING_VALUE', /* required */
SnsTopicArns: [ /* required */
'STRING_VALUE',
/* more items */
],
WebhookDescription: 'STRING_VALUE', /* required */
WebhookUrl: 'STRING_VALUE', /* required */
LoggingLevel: 'STRING_VALUE'
};
chatbot.createChimeWebhookConfiguration(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: {})
—
WebhookDescription
— (String
) Description of the webhook. Recommend using the conventionRoomName/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
) 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.
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. Thedata
object has the following properties:WebhookConfiguration
— (map
) Chime webhook configuration.WebhookDescription
— required — (String
) Description of the webhook. Recommend using the conventionRoomName/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.
-
(AWS.Response)
—
Returns:
createMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Creates MS Teams Channel Configuration
Service Reference:
Examples:
Calling the createMicrosoftTeamsChannelConfiguration operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
createSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Creates Slack Channel Configuration
Service Reference:
Examples:
Calling the createSlackChannelConfiguration operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
deleteChimeWebhookConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes a Chime Webhook Configuration
Service Reference:
Examples:
Calling the deleteChimeWebhookConfiguration operation
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.
-
(AWS.Response)
—
Returns:
deleteMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes MS Teams Channel Configuration
Service Reference:
Examples:
Calling the deleteMicrosoftTeamsChannelConfiguration operation
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.
-
(AWS.Response)
—
Returns:
deleteMicrosoftTeamsConfiguredTeam(params = {}, callback) ⇒ AWS.Request
Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.
Service Reference:
Examples:
Calling the deleteMicrosoftTeamsConfiguredTeam operation
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.
-
(AWS.Response)
—
Returns:
deleteMicrosoftTeamsUserIdentity(params = {}, callback) ⇒ AWS.Request
Deletes a Teams user identity
Service Reference:
Examples:
Calling the deleteMicrosoftTeamsUserIdentity operation
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.
-
(AWS.Response)
—
Returns:
deleteSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes Slack Channel Configuration
Service Reference:
Examples:
Calling the deleteSlackChannelConfiguration operation
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.
-
(AWS.Response)
—
Returns:
deleteSlackUserIdentity(params = {}, callback) ⇒ AWS.Request
Deletes a Slack user identity
Service Reference:
Examples:
Calling the deleteSlackUserIdentity operation
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.
-
(AWS.Response)
—
Returns:
deleteSlackWorkspaceAuthorization(params = {}, callback) ⇒ AWS.Request
Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.
Service Reference:
Examples:
Calling the deleteSlackWorkspaceAuthorization operation
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.
-
(AWS.Response)
—
Returns:
describeChimeWebhookConfigurations(params = {}, callback) ⇒ AWS.Request
Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn
Service Reference:
Examples:
Calling the describeChimeWebhookConfigurations operation
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. Thedata
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 conventionRoomName/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.
-
(AWS.Response)
—
Returns:
describeSlackChannelConfigurations(params = {}, callback) ⇒ AWS.Request
Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn
Service Reference:
Examples:
Calling the describeSlackChannelConfigurations operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
describeSlackUserIdentities(params = {}, callback) ⇒ AWS.Request
Lists all Slack user identities with a mapped role.
Service Reference:
Examples:
Calling the describeSlackUserIdentities operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
describeSlackWorkspaces(params = {}, callback) ⇒ AWS.Request
Lists all authorized Slack Workspaces for AWS Account
Service Reference:
Examples:
Calling the describeSlackWorkspaces operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
getAccountPreferences(params = {}, callback) ⇒ AWS.Request
Get Chatbot account level preferences
Service Reference:
Examples:
Calling the getAccountPreferences operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
getMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Get a single MS Teams Channel Configurations
Service Reference:
Examples:
Calling the getMicrosoftTeamsChannelConfiguration operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
listMicrosoftTeamsChannelConfigurations(params = {}, callback) ⇒ AWS.Request
Lists MS Teams Channel Configurations optionally filtered by TeamId
Service Reference:
Examples:
Calling the listMicrosoftTeamsChannelConfigurations operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
listMicrosoftTeamsConfiguredTeams(params = {}, callback) ⇒ AWS.Request
Lists all authorized MS teams for AWS Account
Service Reference:
Examples:
Calling the listMicrosoftTeamsConfiguredTeams operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
listMicrosoftTeamsUserIdentities(params = {}, callback) ⇒ AWS.Request
Lists all Microsoft Teams user identities with a mapped role.
Service Reference:
Examples:
Calling the listMicrosoftTeamsUserIdentities operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
updateAccountPreferences(params = {}, callback) ⇒ AWS.Request
Update Chatbot account level preferences
Service Reference:
Examples:
Calling the updateAccountPreferences operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
updateChimeWebhookConfiguration(params = {}, callback) ⇒ AWS.Request
Updates a Chime Webhook Configuration
Service Reference:
Examples:
Calling the updateChimeWebhookConfiguration operation
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 conventionRoomName/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. Thedata
object has the following properties:WebhookConfiguration
— (map
) Chime webhook configuration.WebhookDescription
— required — (String
) Description of the webhook. Recommend using the conventionRoomName/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.
-
(AWS.Response)
—
Returns:
updateMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Updates MS Teams Channel Configuration
Service Reference:
Examples:
Calling the updateMicrosoftTeamsChannelConfiguration operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
updateSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request
Updates Slack Channel Configuration
Service Reference:
Examples:
Calling the updateSlackChannelConfiguration operation
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. Thedata
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.
-
(AWS.Response)
—
Returns: