Chime / Client / list_app_instance_admins

list_app_instance_admins#

Chime.Client.list_app_instance_admins(**kwargs)#

Returns a list of the administrators in the AppInstance.

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

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