list_app_instances

ChimeSDKIdentity.Client.list_app_instances(**kwargs)

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

See also: AWS API Documentation

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 AppInstances .

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

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