Chime / Client / list_app_instances

list_app_instances#

Chime.Client.list_app_instances(**kwargs)#

Lists all Amazon Chime ``AppInstance``s created under a single AWS account.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

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

Parameters:

MaxResults (integer) – The maximum number of ``AppInstance``s that you want to return.
NextToken (string) – The token passed by previous API requests until you reach the maximum number of ``AppInstance``s.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- AppInstances (list) –
  
  The information for each AppInstance.
  - (dict) –
    
    Summary of the data for an AppInstance.
    - AppInstanceArn (string) –
      
      The AppInstance ARN.
    - Name (string) –
      
      The name of the AppInstance.
    - Metadata (string) –
      
      The metadata of the AppInstance.
- NextToken (string) –
  
  The token passed by previous API requests until the maximum number of ``AppInstance``s is reached.

Exceptions

Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.ThrottledClientException
Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException