create_microsoft_teams_channel_configuration
async
¶
create_microsoft_teams_channel_configuration(
channel_id: TeamsChannelId,
team_id: UUID,
tenant_id: UUID,
iam_role_arn: Arn,
configuration_name: ConfigurationName,
*,
config_overrides: Optional[AsyncchatbotClientConfig] = None,
channel_name: Optional[TeamsChannelName] = None,
team_name: Optional[TeamName] = None,
sns_topic_arns: Optional[SnsTopicArnList] = None,
logging_level: Optional[CustomerCwLogLevel] = None,
guardrail_policy_arns: Optional[GuardrailPolicyArnList] = None,
user_authorization_required: Optional[BooleanAccountPreference] = None,
tags: Optional[Tags] = None,
) -> CreateTeamsChannelConfigurationResult
Creates an AWS Chatbot configuration for Microsoft Teams.
Parameters:
-
channel_id(TeamsChannelId) –The ID of the Microsoft Teams channel.
-
channel_name(Optional[TeamsChannelName], default:None) –The name of the Microsoft Teams channel.
-
team_id(UUID) –The ID of the Microsoft Teams authorized with AWS Chatbot.
To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.
-
team_name(Optional[TeamName], default:None) –The name of the Microsoft Teams Team.
-
tenant_id(UUID) –The ID of the Microsoft Teams tenant.
-
sns_topic_arns(Optional[SnsTopicArnList], default:None) –The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
-
iam_role_arn(Arn) –A user-defined role that AWS Chatbot assumes. This is not the service-linked role.
For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.
-
configuration_name(ConfigurationName) –The name of the configuration.
-
logging_level(Optional[CustomerCwLogLevel], default:None) –Logging levels include
ERROR,INFO, orNONE. -
guardrail_policy_arns(Optional[GuardrailPolicyArnList], default:None) –The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed
AdministratorAccesspolicy is applied by default if this is not set. -
user_authorization_required(Optional[BooleanAccountPreference], default:None) –Enables use of a user role requirement in your chat configuration.
-
tags(Optional[Tags], default:None) –A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
Raises:
-
ConflictException–There was an issue processing your request.
-
CreateTeamsChannelConfigurationException–We can’t process your request right now because of a server issue. Try again later.
-
InvalidParameterException–Your request input doesn't meet the constraints required by AWS Chatbot.
-
InvalidRequestException–Your request input doesn't meet the constraints required by AWS Chatbot.
-
LimitExceededException–You have exceeded a service limit for AWS Chatbot.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_chatbot/_services/async_chatbot.py
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 | |