ChimeSDKIdentity / Client / describe_app_instance_user

describe_app_instance_user#

ChimeSDKIdentity.Client.describe_app_instance_user(**kwargs)#

Returns the full details of an AppInstanceUser.

See also: AWS API Documentation

Request Syntax

response = client.describe_app_instance_user(
    AppInstanceUserArn='string'
)
Parameters:

AppInstanceUserArn (string) –

[REQUIRED]

The ARN of the AppInstanceUser.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceUser': {
        'AppInstanceUserArn': 'string',
        'Name': 'string',
        'Metadata': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'ExpirationSettings': {
            'ExpirationDays': 123,
            'ExpirationCriterion': 'CREATED_TIMESTAMP'
        }
    }
}

Response Structure

  • (dict) –

    • AppInstanceUser (dict) –

      The name of the AppInstanceUser.

      • AppInstanceUserArn (string) –

        The ARN of the AppInstanceUser.

      • Name (string) –

        The name of the AppInstanceUser.

      • Metadata (string) –

        The metadata of the AppInstanceUser.

      • CreatedTimestamp (datetime) –

        The time at which the AppInstanceUser was created.

      • LastUpdatedTimestamp (datetime) –

        The time at which the AppInstanceUser was last updated.

      • ExpirationSettings (dict) –

        The interval after which an AppInstanceUser is automatically deleted.

        • ExpirationDays (integer) –

          The period in days after which an AppInstanceUser will be automatically deleted.

        • ExpirationCriterion (string) –

          Specifies the conditions under which an AppInstanceUser will expire.

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