putAppInstanceUserExpirationSettings method

Future<PutAppInstanceUserExpirationSettingsResponse> putAppInstanceUserExpirationSettings({
  1. required String appInstanceUserArn,
  2. ExpirationSettings? expirationSettings,
})

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

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

May throw BadRequestException. May throw ConflictException. May throw ForbiddenException. May throw ServiceFailureException. May throw ServiceUnavailableException. May throw ThrottledClientException. May throw UnauthorizedClientException.

Parameter appInstanceUserArn : The ARN of the AppInstanceUser.

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

Implementation

Future<PutAppInstanceUserExpirationSettingsResponse>
    putAppInstanceUserExpirationSettings({
  required String appInstanceUserArn,
  ExpirationSettings? expirationSettings,
}) async {
  final $payload = <String, dynamic>{
    if (expirationSettings != null) 'ExpirationSettings': expirationSettings,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri:
        '/app-instance-users/${Uri.encodeComponent(appInstanceUserArn)}/expiration-settings',
    exceptionFnMap: _exceptionFns,
  );
  return PutAppInstanceUserExpirationSettingsResponse.fromJson(response);
}