ChimeSDKIdentity / Client / describe_app_instance

describe_app_instance#

ChimeSDKIdentity.Client.describe_app_instance(**kwargs)#

Returns the full details of an AppInstance.

See also: AWS API Documentation

Request Syntax

response = client.describe_app_instance(
    AppInstanceArn='string'
)
Parameters:

AppInstanceArn (string) –

[REQUIRED]

The ARN of the AppInstance.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstance': {
        'AppInstanceArn': 'string',
        'Name': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'Metadata': 'string'
    }
}

Response Structure

  • (dict) –

    • AppInstance (dict) –

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

      • AppInstanceArn (string) –

        The ARN of the messaging instance.

      • Name (string) –

        The name of an AppInstance.

      • CreatedTimestamp (datetime) –

        The time at which an AppInstance was created. In epoch milliseconds.

      • LastUpdatedTimestamp (datetime) –

        The time an AppInstance was last updated. In epoch milliseconds.

      • Metadata (string) –

        The metadata of an AppInstance.

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