list_app_instance_users

Chime.Client.list_app_instance_users(**kwargs)

List all AppInstanceUsers created under a single AppInstance .

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

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