list_app_instance_admins

ChimeSDKIdentity.Client.list_app_instance_admins(**kwargs)

Returns a list of the administrators in the AppInstance .

See also: AWS API Documentation

Request Syntax

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

Parameters

• AppInstanceArn (string) --

  [REQUIRED]

  The ARN of the AppInstance .

• MaxResults (integer) -- The maximum number of administrators that you want to return.
• NextToken (string) -- The token returned from previous API requests until the number of administrators is reached.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceArn': 'string',
    'AppInstanceAdmins': [
        {
            'Admin': {
                'Arn': 'string',
                'Name': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • AppInstanceArn (string) --

    The ARN of the AppInstance .

  • AppInstanceAdmins (list) --

    The information for each administrator.

    • (dict) --

      Summary of the details of an AppInstanceAdmin .

      • Admin (dict) --

        The details of the AppInstanceAdmin .

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

  • NextToken (string) --

    The token returned from previous API requests until the number of administrators is reached.

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