Chime / Client / describe_app_instance

describe_app_instance#

Chime.Client.describe_app_instance(**kwargs)#

Returns the full details of an AppInstance.

Warning

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

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',
        'Metadata': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1)
    }
}

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.
  - Metadata (string) –
    
    The metadata 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.

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