ChimeSDKIdentity / Client / list_app_instance_bots

list_app_instance_bots#

ChimeSDKIdentity.Client.list_app_instance_bots(**kwargs)#

Lists all AppInstanceBots created under a single AppInstance.

Request Syntax

response = client.list_app_instance_bots(
    AppInstanceArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

AppInstanceArn (string) –
[REQUIRED]

The ARN of the AppInstance.
MaxResults (integer) – The maximum number of requests to return.
NextToken (string) – The token passed by previous API calls until all requested bots are returned.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceArn': 'string',
    'AppInstanceBots': [
        {
            'AppInstanceBotArn': 'string',
            'Name': 'string',
            'Metadata': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- AppInstanceArn (string) –
  
  The ARN of the AppInstance.
- AppInstanceBots (list) –
  
  The information for each requested AppInstanceBot.
  - (dict) –
    
    High-level information about an AppInstanceBot.
    - AppInstanceBotArn (string) –
      
      The ARN of the AppInstanceBot.
    - Name (string) –
      
      The name of the AppInstanceBox.
    - Metadata (string) –
      
      The metadata of the AppInstanceBot.
- NextToken (string) –
  
  The token passed by previous API calls until all requested bots are returned.

Exceptions

ChimeSDKIdentity.Client.exceptions.BadRequestException
ChimeSDKIdentity.Client.exceptions.ForbiddenException
ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededException
ChimeSDKIdentity.Client.exceptions.ThrottledClientException
ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
ChimeSDKIdentity.Client.exceptions.ServiceFailureException