Chime / Client / describe_app_instance_admin

describe_app_instance_admin#

Chime.Client.describe_app_instance_admin(**kwargs)#

Returns the full details of an AppInstanceAdmin.

Warning

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

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException