Chime / Client / list_app_instance_users

list_app_instance_users#

Chime.Client.list_app_instance_users(**kwargs)#

List all AppInstanceUsers created under a single AppInstance.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceUsers, 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.

See also: AWS API Documentation

Request Syntax

response = client.list_app_instance_users(
    AppInstanceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AppInstanceArn (string) –

    [REQUIRED]

    The ARN of the AppInstance.

  • MaxResults (integer) – The maximum number of requests that you want returned.

  • NextToken (string) – The token passed by previous API calls until all requested users are returned.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • AppInstanceArn (string) –

      The ARN of the AppInstance.

    • AppInstanceUsers (list) –

      The information for each requested AppInstanceUser.

      • (dict) –

        Summary of the details of an AppInstanceUser.

        • AppInstanceUserArn (string) –

          The ARN of the AppInstanceUser.

        • Name (string) –

          The name of an AppInstanceUser.

        • Metadata (string) –

          The metadata of the AppInstanceUser.

    • NextToken (string) –

      The token passed by previous API calls until all requested users are returned.

Exceptions