ChimeSDKIdentity / Client / describe_app_instance_admin

describe_app_instance_admin#

ChimeSDKIdentity.Client.describe_app_instance_admin(**kwargs)#

Returns the full details of an AppInstanceAdmin.

See also: AWS API Documentation

Request Syntax

response = client.describe_app_instance_admin(
    AppInstanceAdminArn='string',
    AppInstanceArn='string'
)
Parameters:

  • AppInstanceAdminArn (string) –

    [REQUIRED]

    The ARN of the AppInstanceAdmin.

  • AppInstanceArn (string) –

    [REQUIRED]

    The ARN of the AppInstance.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceAdmin': {
        'Admin': {
            'Arn': 'string',
            'Name': 'string'
        },
        'AppInstanceArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • AppInstanceAdmin (dict) –

      The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

      • Admin (dict) –

        The AppInstanceAdmin data.

        • Arn (string) –

          The ARN in an Identity.

        • Name (string) –

          The name in an Identity.

      • AppInstanceArn (string) –

        The ARN of the AppInstance for which the user is an administrator.

      • CreatedTimestamp (datetime) –

        The time at which an administrator was created.

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