Chime / Client / regenerate_security_token
regenerate_security_token#
- Chime.Client.regenerate_security_token(**kwargs)#
Regenerates the security token for a bot.
See also: AWS API Documentation
Request Syntax
response = client.regenerate_security_token( AccountId='string', BotId='string' )
- Parameters:
AccountId (string) –
[REQUIRED]
The Amazon Chime account ID.
BotId (string) –
[REQUIRED]
The bot ID.
- Return type:
dict
- Returns:
Response Syntax
{ 'Bot': { 'BotId': 'string', 'UserId': 'string', 'DisplayName': 'string', 'BotType': 'ChatBot', 'Disabled': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'BotEmail': 'string', 'SecurityToken': 'string' } }
Response Structure
(dict) –
Bot (dict) –
A resource that allows Enterprise account administrators to configure an interface that receives events from Amazon Chime.
BotId (string) –
The bot ID.
UserId (string) –
The unique ID for the bot user.
DisplayName (string) –
The bot display name.
BotType (string) –
The bot type.
Disabled (boolean) –
When true, the bot is stopped from running in your account.
CreatedTimestamp (datetime) –
The bot creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) –
The updated bot timestamp, in ISO 8601 format.
BotEmail (string) –
The bot email address.
SecurityToken (string) –
The security token used to authenticate Amazon Chime with the outgoing event endpoint.
Exceptions