ChimeSDKIdentity / Client / put_app_instance_user_expiration_settings

put_app_instance_user_expiration_settings#

ChimeSDKIdentity.Client.put_app_instance_user_expiration_settings(**kwargs)#

Sets the number of days before the AppInstanceUser is automatically deleted.

Note

A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary.

Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

See also: AWS API Documentation

Request Syntax

response = client.put_app_instance_user_expiration_settings(
    AppInstanceUserArn='string',
    ExpirationSettings={
        'ExpirationDays': 123,
        'ExpirationCriterion': 'CREATED_TIMESTAMP'
    }
)
Parameters:

  • AppInstanceUserArn (string) –

    [REQUIRED]

    The ARN of the AppInstanceUser.

  • ExpirationSettings (dict) –

    Settings that control the interval after which an AppInstanceUser is automatically deleted.

    • ExpirationDays (integer) – [REQUIRED]

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

    • ExpirationCriterion (string) – [REQUIRED]

      Specifies the conditions under which an AppInstanceUser will expire.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceUserArn': 'string',
    'ExpirationSettings': {
        'ExpirationDays': 123,
        'ExpirationCriterion': 'CREATED_TIMESTAMP'
    }
}

Response Structure

  • (dict) –

    • AppInstanceUserArn (string) –

      The ARN of the AppInstanceUser.

    • ExpirationSettings (dict) –

      Settings that control 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.ConflictException

  • ChimeSDKIdentity.Client.exceptions.ForbiddenException

  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException

  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException

  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException

  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException