AWS Chatbot 2017-10-11
- Client: Aws\Chatbot\ChatbotClient
- Service ID: chatbot
- Version: 2017-10-11
This page describes the parameters and results for the operations of the AWS Chatbot (2017-10-11), and shows how to use the Aws\Chatbot\ChatbotClient object to call the described operations. This documentation is specific to the 2017-10-11 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateChimeWebhookConfiguration ( array $params = [] )
Creates Chime Webhook Configuration
- CreateMicrosoftTeamsChannelConfiguration ( array $params = [] )
Creates MS Teams Channel Configuration
- CreateSlackChannelConfiguration ( array $params = [] )
Creates Slack Channel Configuration
- DeleteChimeWebhookConfiguration ( array $params = [] )
Deletes a Chime Webhook Configuration
- DeleteMicrosoftTeamsChannelConfiguration ( array $params = [] )
Deletes MS Teams Channel Configuration
- DeleteMicrosoftTeamsConfiguredTeam ( array $params = [] )
Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team.
- DeleteMicrosoftTeamsUserIdentity ( array $params = [] )
Deletes a Teams user identity
- DeleteSlackChannelConfiguration ( array $params = [] )
Deletes Slack Channel Configuration
- DeleteSlackUserIdentity ( array $params = [] )
Deletes a Slack user identity
- DeleteSlackWorkspaceAuthorization ( array $params = [] )
Deletes the Slack workspace authorization that allows channels to be configured in that workspace.
- DescribeChimeWebhookConfigurations ( array $params = [] )
Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn
- DescribeSlackChannelConfigurations ( array $params = [] )
Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn
- DescribeSlackUserIdentities ( array $params = [] )
Lists all Slack user identities with a mapped role.
- DescribeSlackWorkspaces ( array $params = [] )
Lists all authorized Slack Workspaces for AWS Account
- GetAccountPreferences ( array $params = [] )
Get Chatbot account level preferences
- GetMicrosoftTeamsChannelConfiguration ( array $params = [] )
Get a single MS Teams Channel Configurations
- ListMicrosoftTeamsChannelConfigurations ( array $params = [] )
Lists MS Teams Channel Configurations optionally filtered by TeamId
- ListMicrosoftTeamsConfiguredTeams ( array $params = [] )
Lists all authorized MS teams for AWS Account
- ListMicrosoftTeamsUserIdentities ( array $params = [] )
Lists all Microsoft Teams user identities with a mapped role.
- UpdateAccountPreferences ( array $params = [] )
Update Chatbot account level preferences
- UpdateChimeWebhookConfiguration ( array $params = [] )
Updates a Chime Webhook Configuration
- UpdateMicrosoftTeamsChannelConfiguration ( array $params = [] )
Updates MS Teams Channel Configuration
- UpdateSlackChannelConfiguration ( array $params = [] )
Updates Slack Channel Configuration
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateChimeWebhookConfiguration
$result = $client->createChimeWebhookConfiguration
([/* ... */]); $promise = $client->createChimeWebhookConfigurationAsync
([/* ... */]);
Parameter Syntax
$result = $client->createChimeWebhookConfiguration([ 'ConfigurationName' => '<string>', // REQUIRED 'IamRoleArn' => '<string>', // REQUIRED 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], // REQUIRED 'WebhookDescription' => '<string>', // REQUIRED 'WebhookUrl' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ConfigurationName
-
- Required: Yes
- Type: string
The name of the configuration. - IamRoleArn
-
- Required: Yes
- Type: 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. - LoggingLevel
-
- Type: string
Logging levels include ERROR, INFO, or NONE. - SnsTopicArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the SNS topics that deliver notifications to AWS Chatbot. - WebhookDescription
-
- Required: Yes
- Type: string
Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html. - WebhookUrl
-
- Required: Yes
- Type: string
URL for the Chime webhook.
Result Syntax
[ 'WebhookConfiguration' => [ 'ChatConfigurationArn' => '<string>', 'ConfigurationName' => '<string>', 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'WebhookDescription' => '<string>', ], ]
Result Details
Members
- WebhookConfiguration
-
- Type: ChimeWebhookConfiguration structure
Chime webhook configuration.
Errors
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
You have exceeded a service limit for AWS Chatbot.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
CreateChimeWebhookConfigurationException:
We can’t process your request right now because of a server issue. Try again later.
-
There was an issue processing your request.
CreateMicrosoftTeamsChannelConfiguration
$result = $client->createMicrosoftTeamsChannelConfiguration
([/* ... */]); $promise = $client->createMicrosoftTeamsChannelConfigurationAsync
([/* ... */]);
Parameter Syntax
$result = $client->createMicrosoftTeamsChannelConfiguration([ 'ChannelId' => '<string>', // REQUIRED 'ChannelName' => '<string>', 'ConfigurationName' => '<string>', // REQUIRED 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', // REQUIRED 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'TeamId' => '<string>', // REQUIRED 'TeamName' => '<string>', 'TenantId' => '<string>', // REQUIRED 'UserAuthorizationRequired' => true || false, ]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
The ID of the Microsoft Teams channel. - ChannelName
-
- Type: string
The name of the Microsoft Teams channel. - ConfigurationName
-
- Required: Yes
- Type: string
The name of the configuration. - GuardrailPolicyArns
-
- Type: Array of strings
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. - IamRoleArn
-
- Required: Yes
- Type: 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
-
- Type: string
Logging levels include ERROR, INFO, or NONE. - SnsTopicArns
-
- Type: Array of strings
The ARNs of the SNS topics that deliver notifications to AWS Chatbot. - TeamId
-
- Required: Yes
- Type: 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
-
- Type: string
The name of the Microsoft Teams Team. - TenantId
-
- Required: Yes
- Type: string
The ID of the Microsoft Teams tenant. - UserAuthorizationRequired
-
- Type: boolean
Enables use of a user role requirement in your chat configuration.
Result Syntax
[ 'ChannelConfiguration' => [ 'ChannelId' => '<string>', 'ChannelName' => '<string>', 'ChatConfigurationArn' => '<string>', 'ConfigurationName' => '<string>', 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'TeamId' => '<string>', 'TeamName' => '<string>', 'TenantId' => '<string>', 'UserAuthorizationRequired' => true || false, ], ]
Result Details
Members
- ChannelConfiguration
-
- Type: TeamsChannelConfiguration structure
The configuration for a Microsoft Teams channel configured with AWS Chatbot.
Errors
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
You have exceeded a service limit for AWS Chatbot.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
CreateTeamsChannelConfigurationException:
We can’t process your request right now because of a server issue. Try again later.
-
There was an issue processing your request.
CreateSlackChannelConfiguration
$result = $client->createSlackChannelConfiguration
([/* ... */]); $promise = $client->createSlackChannelConfigurationAsync
([/* ... */]);
Parameter Syntax
$result = $client->createSlackChannelConfiguration([ 'ConfigurationName' => '<string>', // REQUIRED 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', // REQUIRED 'LoggingLevel' => '<string>', 'SlackChannelId' => '<string>', // REQUIRED 'SlackChannelName' => '<string>', 'SlackTeamId' => '<string>', // REQUIRED 'SnsTopicArns' => ['<string>', ...], 'UserAuthorizationRequired' => true || false, ]);
Parameter Details
Members
- ConfigurationName
-
- Required: Yes
- Type: string
The name of the configuration. - GuardrailPolicyArns
-
- Type: Array of strings
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. - IamRoleArn
-
- Required: Yes
- Type: 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
-
- Type: string
Logging levels include ERROR, INFO, or NONE. - SlackChannelId
-
- Required: Yes
- Type: 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
-
- Type: string
The name of the Slack Channel. - SlackTeamId
-
- Required: Yes
- Type: string
The ID of the Slack workspace authorized with AWS Chatbot. - SnsTopicArns
-
- Type: Array of strings
The ARNs of the SNS topics that deliver notifications to AWS Chatbot. - UserAuthorizationRequired
-
- Type: boolean
Enables use of a user role requirement in your chat configuration.
Result Syntax
[ 'ChannelConfiguration' => [ 'ChatConfigurationArn' => '<string>', 'ConfigurationName' => '<string>', 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SlackChannelId' => '<string>', 'SlackChannelName' => '<string>', 'SlackTeamId' => '<string>', 'SlackTeamName' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'UserAuthorizationRequired' => true || false, ], ]
Result Details
Members
- ChannelConfiguration
-
- Type: SlackChannelConfiguration structure
The configuration for a Slack channel configured with AWS Chatbot.
Errors
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
You have exceeded a service limit for AWS Chatbot.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
CreateSlackChannelConfigurationException:
We can’t process your request right now because of a server issue. Try again later.
-
There was an issue processing your request.
DeleteChimeWebhookConfiguration
$result = $client->deleteChimeWebhookConfiguration
([/* ... */]); $promise = $client->deleteChimeWebhookConfigurationAsync
([/* ... */]);
Parameter Syntax
$result = $client->deleteChimeWebhookConfiguration([ 'ChatConfigurationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the ChimeWebhookConfiguration to delete.
Result Syntax
[]
Result Details
Errors
-
We were not able to find the resource for your request.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
DeleteChimeWebhookConfigurationException:
We can’t process your request right now because of a server issue. Try again later.
DeleteMicrosoftTeamsChannelConfiguration
$result = $client->deleteMicrosoftTeamsChannelConfiguration
([/* ... */]); $promise = $client->deleteMicrosoftTeamsChannelConfigurationAsync
([/* ... */]);
Parameter Syntax
$result = $client->deleteMicrosoftTeamsChannelConfiguration([ 'ChatConfigurationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the MicrosoftTeamsChannelConfiguration to delete.
Result Syntax
[]
Result Details
Errors
-
We were not able to find the resource for your request.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
DeleteTeamsChannelConfigurationException:
We can’t process your request right now because of a server issue. Try again later.
DeleteMicrosoftTeamsConfiguredTeam
$result = $client->deleteMicrosoftTeamsConfiguredTeam
([/* ... */]); $promise = $client->deleteMicrosoftTeamsConfiguredTeamAsync
([/* ... */]);
Parameter Syntax
$result = $client->deleteMicrosoftTeamsConfiguredTeam([ 'TeamId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- TeamId
-
- Required: Yes
- Type: 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.
Result Syntax
[]
Result Details
Errors
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
DeleteTeamsConfiguredTeamException:
We can’t process your request right now because of a server issue. Try again later.
DeleteMicrosoftTeamsUserIdentity
$result = $client->deleteMicrosoftTeamsUserIdentity
([/* ... */]); $promise = $client->deleteMicrosoftTeamsUserIdentityAsync
([/* ... */]);
Parameter Syntax
$result = $client->deleteMicrosoftTeamsUserIdentity([ 'ChatConfigurationArn' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. - UserId
-
- Required: Yes
- Type: string
Id from Microsoft Teams for user.
Result Syntax
[]
Result Details
Errors
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
We were not able to find the resource for your request.
-
DeleteMicrosoftTeamsUserIdentityException:
We can’t process your request right now because of a server issue. Try again later.
DeleteSlackChannelConfiguration
$result = $client->deleteSlackChannelConfiguration
([/* ... */]); $promise = $client->deleteSlackChannelConfigurationAsync
([/* ... */]);
Parameter Syntax
$result = $client->deleteSlackChannelConfiguration([ 'ChatConfigurationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the SlackChannelConfiguration to delete.
Result Syntax
[]
Result Details
Errors
-
We were not able to find the resource for your request.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
DeleteSlackChannelConfigurationException:
We can’t process your request right now because of a server issue. Try again later.
DeleteSlackUserIdentity
$result = $client->deleteSlackUserIdentity
([/* ... */]); $promise = $client->deleteSlackUserIdentityAsync
([/* ... */]);
Parameter Syntax
$result = $client->deleteSlackUserIdentity([ 'ChatConfigurationArn' => '<string>', // REQUIRED 'SlackTeamId' => '<string>', // REQUIRED 'SlackUserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the SlackChannelConfiguration associated with the user identity to delete. - SlackTeamId
-
- Required: Yes
- Type: string
The ID of the Slack workspace authorized with AWS Chatbot. - SlackUserId
-
- Required: Yes
- Type: string
The ID of the user in Slack.
Result Syntax
[]
Result Details
Errors
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
We were not able to find the resource for your request.
-
DeleteSlackUserIdentityException:
We can’t process your request right now because of a server issue. Try again later.
DeleteSlackWorkspaceAuthorization
$result = $client->deleteSlackWorkspaceAuthorization
([/* ... */]); $promise = $client->deleteSlackWorkspaceAuthorizationAsync
([/* ... */]);
Parameter Syntax
$result = $client->deleteSlackWorkspaceAuthorization([ 'SlackTeamId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SlackTeamId
-
- Required: Yes
- Type: string
The ID of the Slack workspace authorized with AWS Chatbot.
Result Syntax
[]
Result Details
Errors
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
DeleteSlackWorkspaceAuthorizationFault:
There was an issue deleting your Slack workspace.
DescribeChimeWebhookConfigurations
$result = $client->describeChimeWebhookConfigurations
([/* ... */]); $promise = $client->describeChimeWebhookConfigurationsAsync
([/* ... */]);
Parameter Syntax
$result = $client->describeChimeWebhookConfigurations([ 'ChatConfigurationArn' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Type: string
An optional ARN of a ChimeWebhookConfiguration to describe. - MaxResults
-
- Type: int
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
-
- Type: 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.
Result Syntax
[ 'NextToken' => '<string>', 'WebhookConfigurations' => [ [ 'ChatConfigurationArn' => '<string>', 'ConfigurationName' => '<string>', 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'WebhookDescription' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: 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
-
- Type: Array of ChimeWebhookConfiguration structures
A list of Chime webhooks associated with the account.
Errors
-
DescribeChimeWebhookConfigurationsException:
We can’t process your request right now because of a server issue. Try again later.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
DescribeSlackChannelConfigurations
$result = $client->describeSlackChannelConfigurations
([/* ... */]); $promise = $client->describeSlackChannelConfigurationsAsync
([/* ... */]);
Parameter Syntax
$result = $client->describeSlackChannelConfigurations([ 'ChatConfigurationArn' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Type: string
An optional ARN of a SlackChannelConfiguration to describe. - MaxResults
-
- Type: int
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
-
- Type: 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.
Result Syntax
[ 'NextToken' => '<string>', 'SlackChannelConfigurations' => [ [ 'ChatConfigurationArn' => '<string>', 'ConfigurationName' => '<string>', 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SlackChannelId' => '<string>', 'SlackChannelName' => '<string>', 'SlackTeamId' => '<string>', 'SlackTeamName' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'UserAuthorizationRequired' => true || false, ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: 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
-
- Type: Array of SlackChannelConfiguration structures
A list of Slack channel configurations.
Errors
-
DescribeSlackChannelConfigurationsException:
We can’t process your request right now because of a server issue. Try again later.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
DescribeSlackUserIdentities
$result = $client->describeSlackUserIdentities
([/* ... */]); $promise = $client->describeSlackUserIdentitiesAsync
([/* ... */]);
Parameter Syntax
$result = $client->describeSlackUserIdentities([ 'ChatConfigurationArn' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Type: string
The ARN of the SlackChannelConfiguration associated with the user identities to describe. - MaxResults
-
- Type: int
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
-
- Type: 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.
Result Syntax
[ 'NextToken' => '<string>', 'SlackUserIdentities' => [ [ 'AwsUserIdentity' => '<string>', 'ChatConfigurationArn' => '<string>', 'IamRoleArn' => '<string>', 'SlackTeamId' => '<string>', 'SlackUserId' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: 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. - SlackUserIdentities
-
- Type: Array of SlackUserIdentity structures
A list of Slack User Identities.
Errors
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
DescribeSlackUserIdentitiesException:
We can’t process your request right now because of a server issue. Try again later.
DescribeSlackWorkspaces
$result = $client->describeSlackWorkspaces
([/* ... */]); $promise = $client->describeSlackWorkspacesAsync
([/* ... */]);
Parameter Syntax
$result = $client->describeSlackWorkspaces([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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
-
- Type: 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.
Result Syntax
[ 'NextToken' => '<string>', 'SlackWorkspaces' => [ [ 'SlackTeamId' => '<string>', 'SlackTeamName' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: 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. - SlackWorkspaces
-
- Type: Array of SlackWorkspace structures
A list of Slack Workspaces registered with AWS Chatbot.
Errors
-
DescribeSlackWorkspacesException:
We can’t process your request right now because of a server issue. Try again later.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
GetAccountPreferences
$result = $client->getAccountPreferences
([/* ... */]); $promise = $client->getAccountPreferencesAsync
([/* ... */]);
Parameter Syntax
$result = $client->getAccountPreferences([ ]);
Parameter Details
Members
Result Syntax
[ 'AccountPreferences' => [ 'TrainingDataCollectionEnabled' => true || false, 'UserAuthorizationRequired' => true || false, ], ]
Result Details
Members
- AccountPreferences
-
- Type: AccountPreferences structure
Preferences which apply for AWS Chatbot usage in the calling AWS account.
Errors
-
GetAccountPreferencesException:
We can’t process your request right now because of a server issue. Try again later.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
GetMicrosoftTeamsChannelConfiguration
$result = $client->getMicrosoftTeamsChannelConfiguration
([/* ... */]); $promise = $client->getMicrosoftTeamsChannelConfigurationAsync
([/* ... */]);
Parameter Syntax
$result = $client->getMicrosoftTeamsChannelConfiguration([ 'ChatConfigurationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.
Result Syntax
[ 'ChannelConfiguration' => [ 'ChannelId' => '<string>', 'ChannelName' => '<string>', 'ChatConfigurationArn' => '<string>', 'ConfigurationName' => '<string>', 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'TeamId' => '<string>', 'TeamName' => '<string>', 'TenantId' => '<string>', 'UserAuthorizationRequired' => true || false, ], ]
Result Details
Members
- ChannelConfiguration
-
- Type: TeamsChannelConfiguration structure
The configuration for a Microsoft Teams channel configured with AWS Chatbot.
Errors
-
GetTeamsChannelConfigurationException:
We can’t process your request right now because of a server issue. Try again later.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
ListMicrosoftTeamsChannelConfigurations
$result = $client->listMicrosoftTeamsChannelConfigurations
([/* ... */]); $promise = $client->listMicrosoftTeamsChannelConfigurationsAsync
([/* ... */]);
Parameter Syntax
$result = $client->listMicrosoftTeamsChannelConfigurations([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'TeamId' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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
-
- Type: 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
-
- Type: 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.
Result Syntax
[ 'NextToken' => '<string>', 'TeamChannelConfigurations' => [ [ 'ChannelId' => '<string>', 'ChannelName' => '<string>', 'ChatConfigurationArn' => '<string>', 'ConfigurationName' => '<string>', 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'TeamId' => '<string>', 'TeamName' => '<string>', 'TenantId' => '<string>', 'UserAuthorizationRequired' => true || false, ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: 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
-
- Type: Array of TeamsChannelConfiguration structures
A list of AWS Chatbot channel configurations for Microsoft Teams.
Errors
-
ListTeamsChannelConfigurationsException:
We can’t process your request right now because of a server issue. Try again later.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
ListMicrosoftTeamsConfiguredTeams
$result = $client->listMicrosoftTeamsConfiguredTeams
([/* ... */]); $promise = $client->listMicrosoftTeamsConfiguredTeamsAsync
([/* ... */]);
Parameter Syntax
$result = $client->listMicrosoftTeamsConfiguredTeams([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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
-
- Type: 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.
Result Syntax
[ 'ConfiguredTeams' => [ [ 'TeamId' => '<string>', 'TeamName' => '<string>', 'TenantId' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConfiguredTeams
-
- Type: Array of ConfiguredTeam structures
A list of teams in Microsoft Teams that have been configured with AWS Chatbot. - NextToken
-
- Type: 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.
Errors
-
ListMicrosoftTeamsConfiguredTeamsException:
We can’t process your request right now because of a server issue. Try again later.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
ListMicrosoftTeamsUserIdentities
$result = $client->listMicrosoftTeamsUserIdentities
([/* ... */]); $promise = $client->listMicrosoftTeamsUserIdentitiesAsync
([/* ... */]);
Parameter Syntax
$result = $client->listMicrosoftTeamsUserIdentities([ 'ChatConfigurationArn' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Type: string
The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identities to list. - MaxResults
-
- Type: int
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
-
- Type: 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.
Result Syntax
[ 'NextToken' => '<string>', 'TeamsUserIdentities' => [ [ 'AwsUserIdentity' => '<string>', 'ChatConfigurationArn' => '<string>', 'IamRoleArn' => '<string>', 'TeamId' => '<string>', 'TeamsChannelId' => '<string>', 'TeamsTenantId' => '<string>', 'UserId' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: 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. - TeamsUserIdentities
-
- Type: Array of TeamsUserIdentity structures
User level permissions associated to a channel configuration.
Errors
-
ListMicrosoftTeamsUserIdentitiesException:
We can’t process your request right now because of a server issue. Try again later.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
UpdateAccountPreferences
$result = $client->updateAccountPreferences
([/* ... */]); $promise = $client->updateAccountPreferencesAsync
([/* ... */]);
Parameter Syntax
$result = $client->updateAccountPreferences([ 'TrainingDataCollectionEnabled' => true || false, 'UserAuthorizationRequired' => true || false, ]);
Parameter Details
Members
- TrainingDataCollectionEnabled
-
- Type: 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. - UserAuthorizationRequired
-
- Type: boolean
Enables use of a user role requirement in your chat configuration.
Result Syntax
[ 'AccountPreferences' => [ 'TrainingDataCollectionEnabled' => true || false, 'UserAuthorizationRequired' => true || false, ], ]
Result Details
Members
- AccountPreferences
-
- Type: AccountPreferences structure
Preferences which apply for AWS Chatbot usage in the calling AWS account.
Errors
-
UpdateAccountPreferencesException:
We can’t process your request right now because of a server issue. Try again later.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
UpdateChimeWebhookConfiguration
$result = $client->updateChimeWebhookConfiguration
([/* ... */]); $promise = $client->updateChimeWebhookConfigurationAsync
([/* ... */]);
Parameter Syntax
$result = $client->updateChimeWebhookConfiguration([ 'ChatConfigurationArn' => '<string>', // REQUIRED 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'WebhookDescription' => '<string>', 'WebhookUrl' => '<string>', ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the ChimeWebhookConfiguration to update. - IamRoleArn
-
- Type: 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
-
- Type: string
Logging levels include ERROR, INFO, or NONE. - SnsTopicArns
-
- Type: Array of strings
The ARNs of the SNS topics that deliver notifications to AWS Chatbot. - WebhookDescription
-
- Type: string
Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html. - WebhookUrl
-
- Type: string
URL for the Chime webhook.
Result Syntax
[ 'WebhookConfiguration' => [ 'ChatConfigurationArn' => '<string>', 'ConfigurationName' => '<string>', 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'WebhookDescription' => '<string>', ], ]
Result Details
Members
- WebhookConfiguration
-
- Type: ChimeWebhookConfiguration structure
Chime webhook configuration.
Errors
-
We were not able to find the resource for your request.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
UpdateChimeWebhookConfigurationException:
We can’t process your request right now because of a server issue. Try again later.
UpdateMicrosoftTeamsChannelConfiguration
$result = $client->updateMicrosoftTeamsChannelConfiguration
([/* ... */]); $promise = $client->updateMicrosoftTeamsChannelConfigurationAsync
([/* ... */]);
Parameter Syntax
$result = $client->updateMicrosoftTeamsChannelConfiguration([ 'ChannelId' => '<string>', // REQUIRED 'ChannelName' => '<string>', 'ChatConfigurationArn' => '<string>', // REQUIRED 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'UserAuthorizationRequired' => true || false, ]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
The ID of the Microsoft Teams channel. - ChannelName
-
- Type: string
The name of the Microsoft Teams channel. - ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the MicrosoftTeamsChannelConfiguration to update. - GuardrailPolicyArns
-
- Type: Array of strings
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. - IamRoleArn
-
- Type: 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
-
- Type: string
Logging levels include ERROR, INFO, or NONE. - SnsTopicArns
-
- Type: Array of strings
The ARNs of the SNS topics that deliver notifications to AWS Chatbot. - UserAuthorizationRequired
-
- Type: boolean
Enables use of a user role requirement in your chat configuration.
Result Syntax
[ 'ChannelConfiguration' => [ 'ChannelId' => '<string>', 'ChannelName' => '<string>', 'ChatConfigurationArn' => '<string>', 'ConfigurationName' => '<string>', 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'TeamId' => '<string>', 'TeamName' => '<string>', 'TenantId' => '<string>', 'UserAuthorizationRequired' => true || false, ], ]
Result Details
Members
- ChannelConfiguration
-
- Type: TeamsChannelConfiguration structure
The configuration for a Microsoft Teams channel configured with AWS Chatbot.
Errors
-
We were not able to find the resource for your request.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
UpdateTeamsChannelConfigurationException:
We can’t process your request right now because of a server issue. Try again later.
UpdateSlackChannelConfiguration
$result = $client->updateSlackChannelConfiguration
([/* ... */]); $promise = $client->updateSlackChannelConfigurationAsync
([/* ... */]);
Parameter Syntax
$result = $client->updateSlackChannelConfiguration([ 'ChatConfigurationArn' => '<string>', // REQUIRED 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SlackChannelId' => '<string>', // REQUIRED 'SlackChannelName' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'UserAuthorizationRequired' => true || false, ]);
Parameter Details
Members
- ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the SlackChannelConfiguration to update. - GuardrailPolicyArns
-
- Type: Array of strings
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. - IamRoleArn
-
- Type: 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
-
- Type: string
Logging levels include ERROR, INFO, or NONE. - SlackChannelId
-
- Required: Yes
- Type: 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
-
- Type: string
The name of the Slack Channel. - SnsTopicArns
-
- Type: Array of strings
The ARNs of the SNS topics that deliver notifications to AWS Chatbot. - UserAuthorizationRequired
-
- Type: boolean
Enables use of a user role requirement in your chat configuration.
Result Syntax
[ 'ChannelConfiguration' => [ 'ChatConfigurationArn' => '<string>', 'ConfigurationName' => '<string>', 'GuardrailPolicyArns' => ['<string>', ...], 'IamRoleArn' => '<string>', 'LoggingLevel' => '<string>', 'SlackChannelId' => '<string>', 'SlackChannelName' => '<string>', 'SlackTeamId' => '<string>', 'SlackTeamName' => '<string>', 'SnsTopicArns' => ['<string>', ...], 'UserAuthorizationRequired' => true || false, ], ]
Result Details
Members
- ChannelConfiguration
-
- Type: SlackChannelConfiguration structure
The configuration for a Slack channel configured with AWS Chatbot.
Errors
-
We were not able to find the resource for your request.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
Your request input doesn't meet the constraints that AWS Chatbot requires.
-
UpdateSlackChannelConfigurationException:
We can’t process your request right now because of a server issue. Try again later.
Shapes
AccountPreferences
Description
Members
- TrainingDataCollectionEnabled
-
- Type: 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. - UserAuthorizationRequired
-
- Type: boolean
Enables use of a user role requirement in your chat configuration.
ChimeWebhookConfiguration
Description
Members
- ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the ChimeWebhookConfiguration. - ConfigurationName
-
- Type: string
The name of the configuration. - IamRoleArn
-
- Required: Yes
- Type: 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
-
- Type: 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. - SnsTopicArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the SNS topics that deliver notifications to AWS Chatbot. - WebhookDescription
-
- Required: Yes
- Type: string
Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
ConfiguredTeam
Description
Members
- TeamId
-
- Required: Yes
- Type: 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
-
- Type: string
The name of the Microsoft Teams Team. - TenantId
-
- Required: Yes
- Type: string
The ID of the Microsoft Teams tenant.
ConflictException
Description
Members
CreateChimeWebhookConfigurationException
Description
Members
CreateSlackChannelConfigurationException
Description
Members
CreateTeamsChannelConfigurationException
Description
Members
DeleteChimeWebhookConfigurationException
Description
Members
DeleteMicrosoftTeamsUserIdentityException
Description
Members
DeleteSlackChannelConfigurationException
Description
Members
DeleteSlackUserIdentityException
Description
Members
DeleteSlackWorkspaceAuthorizationFault
Description
Members
DeleteTeamsChannelConfigurationException
Description
Members
DeleteTeamsConfiguredTeamException
Description
Members
DescribeChimeWebhookConfigurationsException
Description
Members
DescribeSlackChannelConfigurationsException
Description
Members
DescribeSlackUserIdentitiesException
Description
Members
DescribeSlackWorkspacesException
Description
Members
GetAccountPreferencesException
Description
Members
GetTeamsChannelConfigurationException
Description
Members
InvalidParameterException
Description
Members
InvalidRequestException
Description
Members
LimitExceededException
Description
Members
ListMicrosoftTeamsConfiguredTeamsException
Description
Members
ListMicrosoftTeamsUserIdentitiesException
Description
Members
ListTeamsChannelConfigurationsException
Description
Members
ResourceNotFoundException
Description
Members
SlackChannelConfiguration
Description
Members
- ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the SlackChannelConfiguration. - ConfigurationName
-
- Type: string
The name of the configuration. - GuardrailPolicyArns
-
- Type: Array of strings
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. - IamRoleArn
-
- Required: Yes
- Type: 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
-
- Type: string
Logging levels include ERROR, INFO, or NONE. - SlackChannelId
-
- Required: Yes
- Type: 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: Yes
- Type: string
The name of the Slack Channel. - SlackTeamId
-
- Required: Yes
- Type: string
The ID of the Slack workspace authorized with AWS Chatbot. - SlackTeamName
-
- Required: Yes
- Type: string
Name of the Slack Workspace. - SnsTopicArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the SNS topics that deliver notifications to AWS Chatbot. - UserAuthorizationRequired
-
- Type: boolean
Enables use of a user role requirement in your chat configuration.
SlackUserIdentity
Description
Members
- AwsUserIdentity
-
- Type: string
The AWS user identity ARN used to associate a Slack User Identity with an IAM Role. - ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the SlackChannelConfiguration associated with the user identity. - IamRoleArn
-
- Required: Yes
- Type: 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. - SlackTeamId
-
- Required: Yes
- Type: string
The ID of the Slack workspace authorized with AWS Chatbot. - SlackUserId
-
- Required: Yes
- Type: string
The ID of the user in Slack.
SlackWorkspace
Description
Members
- SlackTeamId
-
- Required: Yes
- Type: string
The ID of the Slack workspace authorized with AWS Chatbot. - SlackTeamName
-
- Required: Yes
- Type: string
Name of the Slack Workspace.
TeamsChannelConfiguration
Description
Members
- ChannelId
-
- Required: Yes
- Type: string
The ID of the Microsoft Teams channel. - ChannelName
-
- Type: string
The name of the Microsoft Teams channel. - ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the MicrosoftTeamsChannelConfiguration. - ConfigurationName
-
- Type: string
The name of the configuration. - GuardrailPolicyArns
-
- Type: Array of strings
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. - IamRoleArn
-
- Required: Yes
- Type: 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
-
- Type: string
Logging levels include ERROR, INFO, or NONE. - SnsTopicArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the SNS topics that deliver notifications to AWS Chatbot. - TeamId
-
- Required: Yes
- Type: 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
-
- Type: string
The name of the Microsoft Teams Team. - TenantId
-
- Required: Yes
- Type: string
The ID of the Microsoft Teams tenant. - UserAuthorizationRequired
-
- Type: boolean
Enables use of a user role requirement in your chat configuration.
TeamsUserIdentity
Description
Members
- AwsUserIdentity
-
- Type: string
The AWS user identity ARN used to associate a Microsoft Teams User Identity with an IAM Role. - ChatConfigurationArn
-
- Required: Yes
- Type: string
The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity. - IamRoleArn
-
- Required: Yes
- Type: 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. - TeamId
-
- Required: Yes
- Type: 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. - TeamsChannelId
-
- Type: string
The ID of the Microsoft Teams channel. - TeamsTenantId
-
- Type: string
The ID of the Microsoft Teams tenant. - UserId
-
- Type: string
Id from Microsoft Teams for user.